Workflow Action Event

Class finesse.containerservices.WorkflowActionEvent

Contains information about the events of the workflow action. Gadgets subscribe to the finesse.containerservices.workflowActionEvent to receive workflow action events to run as a result of workflow evaluations. For more information, see Workflow Action Event.

The method to subscribe to the workflow event is finesse.containerservices.ContainerServices.containerServices.addHandler() with a topic of finesse.containerservices.ContainerServices.Topics.WORKFLOW_ACTION_EVENT. Gadgets must listen to events with the handleBy value of "OTHER", which is configured through cfadmin. Selecting "OTHER" in cfadmin that implies the action is run by other third-party gadgets and not Finesse desktop. The handleBy value is fetched by using the function getHandledBy().

For more information, see the Manage Workflows chapter in Cisco Finesse Administration Guide at https://www.cisco.com/c/en/us/support/customer-collaboration/finesse/products-maintenance-guides-list.html.

Example

Code Snippet
Copyvar containerServices = finesse.containerservices.ContainerServices.init();
containerServices.addHandler("finesse.containerservices.workflowActionEvent", function(workflowActionEvent) {
    var type, handledby
    params = workflowActionEvent.getParams();
    actionVariabless = workflowActionEvent.getActionVariables();
    handledby = workflowActionEvent.getHandledBy();
    type = workflowActionEvent.getType();
    //
    if (handledby === "OTHER" && type === "BROWSER_POP") {
        // Have the logic
    }
});

Methods

getActionVariables()

Retrieves the WorkflowActionEvent action variables map.

Returns

{Object} The object for the action variables map, where key is the action variable name, and value is the Object such as name, type, node, testValue, and actualValue.

getHandledBy()

Retrieves the WorkflowActionEvent handledBy value. Gadgets search for events with a handleBy value of OTHER.

Returns

{String} The handledBy value of the WorkflowAction which is finesse.containerservices.WorkflowActionEvent.HandledBy.

getName()

Retrieves the WorkflowActionEvent name.

Returns

{String} The name of the WorkflowAction.

getParams()

Retrieves the WorkflowActionEvent parameters map.

Returns

{Object} The object for the parameters map, where key is the param name, and value is the Object such as name, value, and expandedValue ().

The type of the WorkflowAction are BROWSER_POP and HTTP_REQUEST.

BROWSER_POP

  • windowName—Name of the window as seen on the browser tab header.

  • path—URL to open.

HTTP_REQUEST

  • method—PUT or POST.

  • location—FINESSE or OTHER.

  • contentType—If applicable, then MIME type of request body. For example, text or plain.

  • path—Request URL.

  • body—Request content for POST requests.

getType()

Retrieves the WorkflowActionEvent type.

Returns

{String} The type of the WorkflowAction (BROWSER_POP or HTTP_REQUEST).