Remote API Manual

The DFC3.2 provides a REST style API. The original API manual is available here. Many things have changed since this manual was released including the new JavaScript engine, but the function names are the same as the Cmd names in this manual. A new manual is in the works and we will post it soon.

Workflow Overview

The DFC3 allows you to program your business logic in JavaScript. Using metadata fields (a.k.a tags) for your information, you can perform stateful operations on the assets in your system.

The JavaScript engine triggers off of DFC Events which are logged into the event log. Since almost every operation in the DFC has an associated event, you can trigger off anything that happens in the system. To select an event to trigger on, your write a filter in plain english that describes the event you are waiting for. The filter language is detailed in the next section.

Once your event happens, it triggers your JavaScript workflow. Here is an example of a simple workflow:

SendEmail(Session, "myemail@mymail.com", "User logged in", "The user " + User + " logged into the DFC");

In this simple example the system sends an email to myemail@mymail.com anytime anyone logs into the DFC3.

The list of JavaScript variables available to you when your workflow runs are:

• Session - A session you can use when calling the API functions
• User - The email address of the user associated to this event
• UserId - The internal user id of the user associated to this event
• Asset - The file name of the asset associated to this event
• AssetId - The internal asset id of the asset associated to this event
• Catalog - The full path of the folder associated to this event
• CatalogId - The internal catalog id for the folder associated to this event
• Event - The name of the event
• EventId - The internal event id of the event
• Param1 - Optional paramater. Same as in the event log.
• Param2 - Optional paramater. Same as in the event log.
• Param3 - Optional paramater. Same as in the event log.
• Param4 - Optional paramater. Same as in the event log.
• Param5 - Optional paramater. Same as in the event log.
• Param6 - Optional paramater. Same as in the event log.
• Param7 - Optional paramater. Same as in the event log.
• Param8 - Optional paramater. Same as in the event log.
• Url - The URL of the DFC.
• FilterId - The internal filter id that caught the event.

For a complete example of workflow programming, look at the source code for Track Your Messages application.

Filters For DFC Workflow

The table below shows all words avaialable in the filter grammar.

Context

Only certain combinations of words are meaningful as filters. Here are the terms in context with the DFC3 Event that they translate to when filtering. Note that DFC3 Events are the same events you report on in the event log report.

Qualifier

The qualifer terms are used for further filtering the events. Note that using qualifier terms is many times faster than using Javascript for filtering on metadata values.