Workflow Action Event

Topic Name	finesse.containerservices.workflowActionEvent
Topic Type	Gadgets subscribe to this topic.

Gadgets subscribe to the finesse.containerservices.workflowActionEvent topic to receive workflow action events to run as a result of workflow evaluations.

Note	Third-party gadgets subscribing directly to the OpenAjax Hub for the Workflow Action Event topic might cause the Finesse Workflow Engine to lose its subscription and no longer be able to run workflow actions. Third party gadgets should instead implement something like the following:

Code Snippet

Copyvar _containerServices = finesse.containerservices.ContainerServices.init();
    _containerServices.addHandler("finesse.containerservices.workflowActionEvent", function(data) {
         // Perform logic on "data", which is a WorkflowActionEvent object
        });

The published data is a JavaScript object with the following properties:

Code Snippet

Copy
{
  uri: string,
  name: string,
  type: string,
  params: [
    {
      name: string,
      value: string,
      expandedValue: string
    }
  ],
  actionVariables: [
    {
      name: string,
      node: string,
      type: string,
      testValue: string,
      actualValue: string
    }
  ]
}


Field	Description
uri	In the uri, the id maps to the primary key of the WorkflowAction entry.
name	The name of the workflow action.
type	The type of workflow action. Possible value is BROWSER_POP.
params	List of Param subobjects (see below).
actionVariables	List of ActionVariable subobjects (see below). There can be at most 5 Action Variable subobjects assigned to a workflow action.

The Param subobject uses the following fields:


Field	Description
name	The name of the parameter.
value	The value of the parameter.
expandedValue	The value of the parameter with variables substituted with their values.

The ActionVariable subobject uses the following fields:


Field	Description
name	The name of the variable.
node	The XPath to extract from the dialogs XML.
type	Indicates if this is a SYSTEM or CUSTOM variable.
testValue	The value used to test the variable.
actualValue	The actual value of the variable in context of the events used by the workflow evaluation.