Trigger types

For every trigger, find below the required variables and their potential contribution to the instance variables.

Variables that the user must fill in when creating the Contract are in bold.

Time trigger

A Time trigger requires a cron-expression.
The instance starts when the time defined in the cron-expression is matched. No variables are added to the flow instance.

When creating the Contract, you will have these required and optional Variables available:

• cronExpression - required
  Type: plain text [STRING]
  Example: * * * ?

• systemEnableLogDebugToFile - optional
  Type: Enabled/Disabled [BOOLEAN]

• systemErrorHandlingWorkflowTemplateName - optional
  Type: Enabled/Disabled [BOOLEAN]

• jobManagerPriorityQueueName - required
  Type: WUI custom [QUEUE]
  Default: Default Queue

• systemWorkflowInstanceSingletonMode - optional
  Type: Enabled/Disabled [BOOLEAN]

When creating the Contract, Data One will add these Variables:

• contractNameThisInstanceBelongsTo
  Type: plain text [STRING]
  Example: ContractName

• templateNameThisInstanceBelongsTo
  Type: plain text [STRING]
  Example: TemplateName

• centralLogCorrelationId
  Type: plain text [STRING]
  Example: d90fef7b-1517-4ad6-b836-18b6b4645be7:0

New file trigger

A New File trigger requires a VirtualPath.

Incoming Transfer trigger

An Incoming Transfer requires a VirtualPath.

Outgoing Transfer trigger

An Outgoing Transfer requires a VirtualPath.

Incoming Update Metadata trigger

An Incoming Update Metadata requires a VirtualPath.
The instance starts when an UpdateMetadata event is fired by STENG and when any metadata is updated on a FileSet during a transport in the VirtualPath configured in the Contract.
The variable added to the execution is file of type FileDetail. Its attributes must be set according to the event that fires this trigger.

On Demand trigger

An On Demand trigger does not require anything.
It is triggered by a direct API invocation via REST. This API will accept a map of variables that will be passed to the instance as process variables. Any variable explicitly declared on the template to be requested when creating the Contract is added to the set of variables coming from the REST invocation. If a variable name is used when creating the Contract and is used in the map passed via REST as well, this second one wins over the Contract one.

Virtual Box Bind trigger

A Virtual Box Bind requires a VirtualBox.
The instance starts when a VirtualBoxEvent is emitted by FileBox as a consequence of the association of a FileSet to the VirtualBox configured in the Contract.
The variable added to the execution is file of type FileDetail. Its attributes must be set according to the event that fires this trigger.

Virtual Box Unbind trigger

A Virtual Box Unbind requires a VirtualBox.
The instance starts when a VirtualBoxEvent is emitted by FileBox when the FileSet and the Virtual Box defined in the Contract are no longer associated.
The variable added to the execution is file of type FileDetail. Its attributes must be set according to the event that fires this trigger.