6.1 About Workflow Services

Note: The most commonly used services have more extensive descriptions.

A typical service entry is similar to the following:

GET_WORKFLOW
WorkflowService 40 null null null!csWfRetrieveInfoError(dWfName)
5:QworkflowDocuments:WfDocuments:0:!csWfRetrieveInfoError(dWfName)
3:getWorkflowStepAliasesInfo::0:null
3:getWorkflowDesignInfo::0:null
3:getWorkflowDocumentInfo:WfDocuments:0:null

In this example:

• The first line indicates the service name: GET_WORKFLOW

• The second line lists the service's attributes:

• Service class: WorkflowService

• Access level: 40

• Template: null

• Service type: null

• Subjects Notified: null

• Error message and parameter used for error message: Retrieve Info Error

• The remainder of the entry lists the service's actions, each line designating one action:

• action type: for example, 5, indicating a Select Cache Query, which specifies a query to retrieve information from the database and store it for later use.

• action name: for example, QworkflowDocuments

• action parameters: for example, WfDocuments. If no parameters are specified, double colons (::) are included.

• action control mask: for example, 0, indicating 'Ignore error'. If no control mask is specified, double colons (::) or 0 is included.

• action error message, or null if no message is available.

Each element of the service's action is separated by a colon (:).

Important: All services have at least one required parameter. The IdcService parameter takes the name of the service as its argument. If other parameters are required, they are noted in the description of the service.

See "Customizing Services" for details about a service's attributes and actions.