WorkflowAction

The WorkflowAction object represents a workflow action that can be assigned to a workflow. Finesse supports a system-wide maximum of 100 workflow actions.

The WorkflowAction object is structured as follows:

Code Snippet

Copy<WorkflowAction>
    <uri>/finesse/api/WorkflowAction/{id}</uri>
    <name></name>
    <type></type>
    <handledBy></handledBy>
    <params>
        <Param>
            <name><name>
            <value></value>
        </Param>
        <Param>
            <name></name>
            <value></value>
        </Param>
    </params>
    <actionVariables>
        <ActionVariable>
            <name></name>
            <type></type>
        </ActionVariable>
    </actionVariables>
</WorkflowAction>

There are two types of workflow actions: BROWSER_POP and HTTP_REQUEST.

The BROWSER_POP type is structured as follows:

Code Snippet

Copy<WorkflowAction>
    <uri>/finesse/api/WorkflowAction/{id}</uri>
    <name>DuckDuckGo</name>
    <type>BROWSER_POP</type>
    <handledBy>FINESSE_DESKTOP</handledBy>
    <params>
        <Param>
	    <name>path<name>
           <value>http://www.example.com?q=${callVariable1}</value>
	    </Param>
	    <Param>
	    <name>windowName</name>
           <value>theWindow</value>
 	    </Param>
    </params>
    <actionVariables>
	    <ActionVariable>
	    <name>callVariable1</name>
           <type>SYSTEM</type>
	    </ActionVariable>
    </actionVariables>
</WorkflowAction>

The HTTP_REQUEST type is structured as follows:

Code Snippet

Copy<WorkflowAction>
    <name>Test with Content Type</name>
    <type>HTTP_REQUEST</type>
    <handledBy>FINESSE_DESKTOP</handledBy>
        <Param>
        <name>path</name>
           <value>http://www.example.com?q=${callVariable1}</value>
        </Param>
        <Param>
            <name>method</name>
            <value>PUT</value>
        </Param>
        <Param>
            <name>authenticationType</name>
            <value>BASIC</value>
        </Param>
        <Param>
            <name>location</name>
            <value>OTHER</value>
        </Param>
        <Param>
            <name>contentType</name>
            <value>application/xml</value>
        </Param>
        <Param>
            <name>body</name>
            <value>${callVariable1},${callVariable2}</value>
        </Param>
    </params>
    <actionVariables>
        <ActionVariable>
            name>callVariable1</name>
            <type>SYSTEM</type>
        </ActionVariable>
        <ActionVariable>
            <name>callVariable2</name>
            <type>SYSTEM</type>
        </ActionVariable>
    </actionVariables>
</WorkflowAction>