Trigger types
Copiato da Create your first workflow template
On Demand: the instance is started by a direct API invocation via REST, specifically the Job Manager Submit API.
Time: the instance starts when the time defined in a cron-expression is matched.
New File: the instance starts when the file is stored in the system.
Incoming Transfer: the instance starts when a remote server requires a new file transfer to Data One.
Incoming Update Metadata: the instance starts with an UpdateMetadata event and when any metadata is updated on a FileSet during a transport in the VirtualPath.
Outgoing Transfer: the instance starts when a file leaves the VirtualPath to reach its destination.
Virtual Box Bind: 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.
Virtual Box Unbind: 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.
Trigger Details and Associated Variables
Below are the required variables for each trigger type and their potential contribution to the instance variables. Variables that need to be specified during Contract creation are highlighted in bold.
Time Trigger
Time-based actions are executed at specific times, like daily at 6 a.m. When the designated time is reached, the workflow rule reassesses the record to verify that it still meets the rule criteria. If it does, the workflow rule performs the specified actions.
Trigger Requirements: A cron expression is needed. The workflow instance starts when the time specified in the cron expression matches the current time. No additional variables are introduced to the workflow instance.
Contract Variables:
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]
Additional Variables Provided by Data One:
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
The New File trigger is activated by the presence of a VirtualPath. The FileSet is generated by the FileBox component at the configured VirtualPath defined in the Contract.
Execution Variable:
file of type FileDetail
Attributes must be populated based on the initiating event.
Incoming Transfer trigger
The Incoming Transfer trigger requires a VirtualPath. The instance starts when a TransferEvent is triggered on STENG, indicating that a file has been received at the specified VirtualPath in the Contract.
Execution Variable:
file of type FileDetail
Attributes must be set according to the event that initiates this trigger.
Outgoing Transfer trigger
The Outgoing Transfer trigger requires a VirtualPath. The instance is triggered when a TransferEvent is fired on STENG, indicating that a file is departing the VirtualPath in the Contract towards its destination.
Execution Variable:
file of type FileDetail
Attributes must be populated based on the initiating event.
Incoming Update Metadata trigger
The 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.
The Incoming Update Metadata trigger requires a VirtualPath. It activates when an UpdateMetadata event is triggered by STENG, following any metadata update on a FileSet during a transport in the specified VirtualPath.
Execution Variable:
file of type FileDetail
Attributes must be set according to the event that triggers the instance.
On Demand trigger
This API accepts a map of variables that will be passed to the instance as process variables. Any variables explicitly declared in the template to be requested during the creation of the Contract are added to the set of variables from the REST invocation. If a variable name is used both during Contract creation and in the map passed via REST, the latter wins over the Contract's variable name.
Trigger Behavior: The API accepts a map of variables to be sent to the instance as process variables. Any variables explicitly requested during Contract creation are merged with the variables sent via the REST API. If a variable name is used in both contexts, the API’s variable overrides the Contract's definition.
Virtual Box Bind trigger
The Virtual Box Bind trigger requires a VirtualBox. The instance is initiated when a VirtualBoxEvent is generated by FileBox, signaling the association of a FileSet to the configured VirtualBox in the Contract.
Execution Variable:
file of type FileDetail
Attributes must be set according to the event that initiates the trigger.
Virtual Box Unbind trigger
The Virtual Box Unbind requires a VirtualBox. It starts when a VirtualBoxEvent is triggered by FileBox, indicating that the FileSet and the configured VirtualBox in the Contract are no longer linked.
Execution Variable:
file of type FileDetail
Attributes must be populated based on the event that initiates the trigger.
Last updated