Workflow attributes

This page lists the workflow attributes that can be accessed within the SemQL editor when creating or editing workflow definitions.

WorkflowInstance

WorkflowInstance corresponds to the current instance of a workflow and includes the attributes listed below.

WorkflowInstance
Attribute name Description Type

ID

ID of the workflow instance.

Number

InitiatorName

Initiator of the workflow.

String

StartComment

Comment added by the initiator on startup.

Long Text

StartAttachments

Attachments added by the initiator on startup.

Set of WorkflowAttachment attributes.

Description

Description added by the initiator on startup.

LongText

Priority

Priority given to the workflow. Possible values are:

  • LOW

  • NORMAL

  • HIGH

  • CRITICAL

String (list of values)

DueDate

DueDate (current value).

Timestamp

WorkflowDefinitionName

Name of the workflow definition object.

String

StartDate

Date when the current workflow instance started.

Timestamp

EndDate

Date when the current workflow instance ended.

Timestamp

Status

Status of the workflow. Possible values are:

  • IN_PROGRESS

  • COMPLETED

  • KILLED

String (list of values)

StartApplicationName

Application from which the current workflow is started.

String

Steps

List of root steps of the workflow

Set of StepInstance attributes.

AllSteps

Flattened list of all the steps of the workflow including the sub-branches of the parallel steps.

Set of StepInstance attributes.

WorkflowAttachment

WorkflowAttachment represents an attachment added to the current workflow and includes the attributes listed below.

WorkflowAttachment
Attribute name Description Type

FileName

Name of the attachment file.

String

Content

Attachment file in binary format.

Binary

WorkflowInstanceID

ID of the workflow instance in which the attachment is included.

Number

StepInstance

StepInstance corresponds to the instance of a step in the current workflow and includes the attributes listed below.

StepInstance
Attribute name Description Type

ID

ID of the current step instance.

Number

WorkflowInstance

Workflow to which the current step belongs.

WorkflowInstance

WorkflowInstanceID

ID of the workflow instance.

Number

ParentStepID

ID of the optional parent parallel step to which the current step belongs. Null for root steps.

Number

ParentBranchName

Name of the optional branch to which the current step belongs. Null for root steps.

String

ParentBranch

Optional branch to which the current step belongs. Null for root steps.

BranchInstance

StepDefinitionName

Name of the step definition.

String

PreviousDataSetID

Number

PreviousDataSet

Data set at the beginning of the step.

DataSet

CurrentDataSetID

Number

CurrentDataSet

The current dataset for the step.

DataSet (or null)

StepIndex

Position of the step in its containing branch or workflow.

Integer

StepType

Type of step. Possible values are:

  • WF_START_EVT: StartEvent

  • WF_END_EVT: EndEvent

  • USER_TASK: UserTask

String (list of values)

UserTaskInstance

User task instance information. Null when not a UserTask.

UserTaskInstance (or null)

ParallelBlockInstance

Parallel Block instance information. Null when the step is not a parallel block step.

ParallelBlockInstance

SelectedTransitionName

Name of the transition selected at the end of the step.

String

PreviousStep

Previous step, if any.

StepInstance

NextStep

Next step, if any.

StepInstance

UserTaskInstance

UserTaskInstance corresponds to the instance of a user task in the current workflow and includes the attributes listed below.

UserTaskInstance
Attribute name Description Type

ID

ID of the user task instance.

Number

StepInstance

Links back to the instance of the step containing the current user task instance.

StepInstance

CandidateAssignees

List of candidate assignees who can claim the current user task.

Set of UserTaskAssigneeCandidate attributes.

AssigneeName

Name of the user task assignee.

String

PreviousDataSetID

Alias for StepInstance.PreviousDataSet.

Number

PreviousDataSet

ID of the previous data set.

DataSet

CurrentDataSetID

ID of the current data set.

Number

CurrentDataSet

Alias for StepInstance.CurrentDataSet.

DataSet (or null)

CreationDate

Date when the task was created?

Timestamp

StartDate

Date when the task started. The task is started by the user.

Timestamp

EndDate

Date when the task was completed.

Timestamp

SelectedTransitionName

Name of the transition used at the end of the task.

This is the same as StepInstance.SelectedTransitionName.

String

Comment

Comment added in the current user task instance.

String

Attachments

List of attachments added in the current user task instance.

Set of UserTaskInstanceAttachment attributes.

UserTaskInstanceAttachment

UserTaskInstanceAttachment corresponds to an attachment added in the instance of a user task in the current workflow. It includes the attributes listed below.

UserTaskInstanceAttachment
Attribute name Description Type

FileName

Name of the attachment file added in the current user task instance.

String

Content

Content of the attachment file in binary format.

Binary

UserTaskInstanceID

ID of the user task instance. This is the same as UserTaskInstance.Id.

Number

UserTaskAssigneeCandidate

UserTaskAssigneeCandidate includes the attributes listed below.

UserTaskAssigneeCandidate
Attribute name Description Type

UserTaskInstanceID

ID of the user task instance that can be claimed by the current assignee candidate.

Number

Username

Username of the user task assignee candidate.

String

DataSet

DataSet corresponds to the data authored by the current workflow instance and includes the attributes listed below.

DataSet
Attribute name Description Type

ID

Load ID used to store data.

Long Integer

<DataScopeRootEntitySemQLAlias>

SemQL alias of the entity as defined in the workflow definition.

  • If the cardinality is one: <Entity>StepData (or null)

  • If the cardinality is many: list of <Entity>StepData

Step<Entity>Data depends on the entity.

ParallelBlockInstance

ParallelBlockInstance corresponds to the instance of a parallel block in the current workflow and includes the attributes listed below.

ParallelBlockInstance
Attribute name Description Type

ID

ID of the current parallel block instance.

Number

StepInstance

Links back to the instance of the step containing the current parallel block instance.

StepInstance

Branches

List of branches in the current parallel block instance.

Set of BranchInstance attributes.

BranchInstance

BranchInstance corresponds to the instance of a branch in a parallel block and includes the attributes listed below.

BranchInstance
Attribute name Description Type

ParallelBlockInstanceID

ID of the parallel block instance containing the current branch instance. This is the same as ParallelBlockInstance.ID.

Number

ParallelBlockInstance

Links back to the instance of the parallel block containing the current branch instance.

ParallelBlockInstance

BranchName

Name of the branch.

String

Steps

List of steps in the current branch instance.

Set of StepInstance attributes.

AssigneeCandidateResolverView

AssigneeCandidateResolverView includes the attributes listed below.

AssigneeCandidateResolverView
Attribute name Description Type

UserTaskInstance

Instance of the current user task.

UserTaskInstance

UserTaskInstanceID

ID of the current task instance.

Number

Username

Name of the user that maps the username considered as a candidate.

String

To ensure that SemQL expressions align with the expected execution behavior of user task steps, the UserTaskInstance and UserTaskInstanceID attributes are deprecated when used as the root context of an assignment condition on a user task. In such cases, workflow designers should replace these attributes with StepInstance and StepInstanceID, respectively.

However, these attributes remain valid when used as subordinate objects in an assignment condition.

Example
  • UserTaskInstance.AssigneeName: invalid.

  • StepInstance.PreviousStep.UserTaskInstance.AssigneeName: valid.

Using the deprecated attributes mentioned above prompts a non-blocking warning during workflow validation.

SemQL examples in workflow definitions

Workflow initiator

The following SemQL condition is used as an assignment condition in a user task. The condition assigns the user task to the initiator of the workflow.

StepInstance.AssigneeName = WorkflowInstance.InitiatorName
asciidoc

Route conditions using record data

The following SemQL condition is used in a route to evaluate whether the country of origin of a product is the USA.

If the condition is true, the workflow progresses in this route, and the product is sent for review to the respective reviewers. If the condition is false, the workflow switches to another route.

CurrentDataSet.Product.Origin = 'USA'
asciidoc