Workflow completed event

When the workflow is completed it triggers an event. You can configure the event conditions to trigger an event whenever the monitored workflow changes its status or only when it changes to a specific status.

Overview

You can customize both mandatory and optional attribute filters to define specific conditions to trigger an event.

The mandatory attribute filters that you must provide to configure the event are:
  • Workstation
    Specify the workstation of the workflow instance. This detail must be preceded by the workstation folder details. The supported value type is string and for available operators see Event driven orchestration configuration attributes. Wildcard characters are permitted.
    The multipleFilters property is enabled and if required, you can provide multiple filters or values separated by a semicolon (;) for a single instance of the workstation attribute.
    The singlePredicate property is disabled, so you can also add multiple instances of the workstation attribute.
    Note: To add a workstation that is not saved in the folder specified by the current_folder property in the config.yaml file, provide the complete path to the workstation folder.
    Example: If the RS_AGT_1 workstation is saved in the FOLDER1 folder under the root folder and the folder specified by the current_folder property in config.yaml differs, then specify the workstation as follows in the event definition:
    /FOLDER1/RS_AGT_1
  • Workflow
    Specify the workflow name. This detail must be preceded by the workflow folder details. The supported value type is string and for available operators see Event driven orchestration configuration attributes. Wildcard characters are permitted.
    The multipleFilters property is enabled and if required, you can provide multiple filters or values separated by a semicolon (;) for a single instance of the workflow attribute.
    The singlePredicate property is disabled, so you can also add multiple instances of the workflow attribute.
    Note: To add a workflow that is not saved in the folder specified by the current_folder property in the config.yaml file, provide the complete path to the workflow folder.
    Example: If the WORKFLOW AGT workflow is saved in the FOLDER1 folder under the root folder and the folder specified by the current_folder property in config.yaml differs, then specify the workflow as follows in event definition:
    /FOLDER1/WORKFLOW AGT
You can also use the following optional attributes to further configure the event conditions:
  • Priority
    Specify the priority of the workflow. You can specify any value between 0-101. If you add a value, the change in status of the monitored task only with that priority triggers an event. The supported value type is nonnegativeinteger and for available operators see Event driven orchestration configuration attributes. Wildcard characters are not permitted.
    The multipleFilters property is enabled and you can specify single or multiple values or a specific range separated by a semicolon (;) for a single instance of the priority attribute. The singlePredicate property is disabled, so you can also add multiple instances of the priority attribute.
  • External status
    Specify an external status for the monitored workflow to set as an event condition. The supported value type is string and for available operators see Event driven orchestration configuration attributes. Wildcard characters are not permitted.
    You can add single or multiple statuses as an array. For example, if you want to add multiple statuses, specify as External status={ERROR,CANCELLED}. When any one of the specified status is reached, it satisfies the condition. If you do not specify any value, whenever there is a change in workflow status, the filter is considered satisfied. The available external statuses that you can give are:
    • CANCELLED
    • ERROR
    • SUCCESSFUL
    • SUPPRESS
  • Internal status
    Specify an internal status for the monitored workflow to set as an event condition. The supported value type is string and for available operators see Event driven orchestration configuration attributes. Wildcard characters are not permitted.
    You can add single or multiple statuses as an array. For example, if you want to add multiple statuses, specify as External status={ABEND,CANCL}. When any one of the specified status is reached, it satisfies the condition. If you do not specify any value, whenever there is a change in task status, the filter is considered satisfied. The available internal statuses that you can give are:
    • ABEND
    • CANCL
    • SUCC
    • SUPPR