Trigger types for mediation and output contracts

Incoming Transfer trigger

The Incoming Transfer trigger requires a VirtualPath. The instance starts when a TransferEvent is triggered on the STENG, indicating that a file has been received in the VirtualPath specified in the Contract.

• Execution Variable:

  • file of type FileDetail

    • File descriptor of the actual file on which the trigger was fired.

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 leaving the VirtualPath specified in the Contract to reach its destination.

• Execution Variable:

  • file of type FileDetail

    • File descriptor of the actual file on which the trigger was fired.

Incoming Update Metadata trigger

The Incoming Update Metadata requires a VirtualPath. The instance starts when an UpdateMetadata event is fired by the 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

    • File descriptor of the actual file on which the trigger was fired.

New file trigger

The New File trigger is activated when the file is stored in the system. The FileSet is generated by the FileBox component in the VirtualPath defined in the Contract.

• Execution Variable:

  • file of type FileDetail

    • File descriptor of the actual file on which the trigger was fired.

On Demand trigger

The On Demand trigger is triggered by a direct API invocation via REST, specifically the Job Manager Submit API. 🚀 See the Job Manager APIs page.

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.

The On Demand trigger is initiated through a direct API call using the Job Manager Submit API. See the Job Manager APIs page for more details.

• 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.

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 Mover:

• 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

Virtual Box Bind trigger

The Virtual Box Bind trigger requires a VirtualBox. The instance starts when a VirtualBoxEvent is generated by FileBox, as a consequence of the association of a FileSet to the configured VirtualBox in the Contract.

• Execution Variable:

  • file of type FileDetail

    • File descriptor of the actual file on which the trigger was fired.

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 associated.

• Execution Variable:

  • file of type FileDetail

    • File descriptor of the actual file on which the trigger was fired.