WorkflowAction API Parameters

uri

String

The URI to get a new copy of the WorkflowAction object.

—

The id in the URI maps to the primary key of the WorkflowAction.

name

String

The name of the workflow action.

—

Must be unique.

Maximum of 64characters.

type

String

The type of workflow action

BROWSER_POP, HTTP_REQUEST

handledBy

String

Indicates what handles the action when it is triggered by a workflow.

FINESSE_DESKTOP, OTHER

For FINESSE_DESKTOP, the Finesse workflow engine runs the action.

For OTHER, the action event is published on the OpenAJAX hub but is not run by the Finesse desktop. This allows a third-party gadget to run the action.

params

Object

A list of Param subobjects.

—

-->Param

Object

Includes a name and value pair.

—

Params are flexible and can contain any value. Validation is based on the type of the WorkflowAction in which they are contained. See the following tables for more information.

--->name

String

The name of the parameter.

—

--->value

String

The value of the parameter.

—

actionVariables

Object

List of ActionVariable subobjects.

—

-->ActionVariable

Object

Set of information about one ActionVariable.

—

You can assign up to five ActionVariable parameters to a workflow.

--->name

String

The name of the variable.

—

Maximum of 32 characters.

--->node

String

The XPath to extract from the dialog XML.

—

Maximum of 500 characters.

SYSTEM variables are name references to the values returned by SystemVariable and do not require a node value. CUSTOM variables are self-defining and require a node and a unique name that does not conflict with any system variable.

--->type

String

Indicates the type of variable

CUSTOM, SYSTEM

--->testValue

String

The value used to test the variable.

—

Maximum of 128 characters.

The URL path is validated only to make sure its length is at least 1 and no longer than the maximum length. It is up to the user to provide a valid URL. Variables can be embedded into the URL by using a dollar sign and curly braces. For example:

Copyhttp://www.example.com?q=${callVariable1}

causes the workflow engine to substitute the value of callVariable1 into the path. If a literal curly brace or dollar sign is needed in the URL, it must be escaped with a backslash (for example, \{ ). A literal backslash must be escaped with another backslash (\\).

The URL path is validated only to make sure its length is at least 1 and no longer than the maximum length. It is up to the user to provide a valid URL. Variables can be embedded into the URL by using a dollar sign and curly braces. For example:

Copyhttp://www.example.com?q=${callVariable1}

will cause the workflow engine to substitute the value of callVariable1 into the path. If a literal curly brace or dollar sign is needed in the URL, they must be escaped with a backslash (e.g. \{ ). A literal backslash must be escaped with another backslash (e.g. \\).

When location is FINESSE, the protocol, host, and port should not be specified. These will be inferred automatically by Finesse when it runs the REST request. For example, to send a dialog request for dialog id 32458, the following URL should be entered:

Copy 
/finesse/api/Dialog/32458

NONE: No authentication is used with the request, no authentication headers or other negotiation is done as part of the request.

NONE: No credentials are included as part of the request.

contentType

The value of the content type header to send with the HTTP_REQUEST

The content type is only validated to ensure it does not exceed the maximum length. You must make sure you provide a valid content type.

If the parameter is empty, no content type header is sent with the HTTP_REQUEST.

500

No

Copy<foo>${callVariable1}</foo>

causes the workflow engine to substitute the value of callVariable1 into the body. If a literal curly brace or dollar sign is needed in the body it must be escaped with a backslash:

Copy\{

A literal backslash must be escaped with another backslash :

Copy\\