29 July 2022

What are parameters?

Parameters are used by the conditions of transitions and the actions of activities. Parameters are usually defined for actions and conditions with values from the corresponding reference data. For example, the parameter for the action MoveToDesk has values from the reference data Desks. However, some actions require custom parameters to be created on the workflow. Custom parameters are used to store values, such as a person ID or an application ID. The value in the custom parameter can then be passed between activities on the workflow.

For example, the image Passing parameters shows how the following activities of a workflow to create a document placeholder use parameters:

Get ID
The activity has actions that retrieve the external keys for the Person, Application, and Clearance check and stores the keys in custom parameters personID, applicationID, and checkID.
Create entities
The activity has actions that create internal keys for the entities, which are GUIDs. The activity associates the internal keys personGUID, applicationGUID, and checkGUID to the entities by retrieving the external keys and prefixing the parameters with an @ symbol. For example, @personID, @applicationID, and @checkID.
Create placeholder
The activity creates a document placeholder and associates it to the entities by retrieving the internal keys @personGUID, @applicationGUID, and @checkGUID. The activity then stores the placeholder identifier in the parameter placeholderID.
Passing parameters
parameters being passed in workflow
Workflow has global parameters, which are ignored if used in transitions and activities.

The global parameters are as follows:

  • WorkServiceCode

  • BusinessEntityCode

  • BusinessEntityKey

  • BusinessEntity

  • EntityKey

  • Entity