The following Event shapes are included in the IWS Toolbox.
Begin
Begin (with a clock on its icon)
End
Begin
This shape defines the starting point of a workflow.
The following table describes the shape's properties.
On this page
Property | Description |
|---|---|
Name | The default value is Begin. It cannot be changed |
Bundle-based | Turn on this checkbox if this workflow will be launched by NDFA stream (eagle_ml-2-0_default_cm_ndfa). NDFA stream allows you to launch appropriate workflow by the incoming file name. When data file arrives to NDFA stream, it compares its name with the list of file masks provided in workflows' data artifacts, finds appropriate workflow and launches it. |
Send notifications | This dropdown field allows you to turn on email notifications for the workflow. Options are: always, never, or on failure. |
Email for Notifications | Email address to which email notifications are to be sent |
Create Consolidated TSR | Turn on this checkbox to create a consolidated TSR. It is only applicable for bundle-based workflows. To enable consolidated TSR regardless of workflow type, set CreateConsolidatedTSR task parameter to "Y" in your control message. |
TSR Transform Stream | (advanced) This field allows you to use custom stream, which transforms the content and format of Task Status Response (TSR) message before sending it out. |
TSR Name Prefix | String literal which will be added to the beginning of the TSR file. |
ACK Name Prefix | String literal which will be added to the beginning of the ACK file. |
Custom TSR Location | Folder where TSR messages for current workflow should be delivered |
Custom ACK Location | Folder where ACK messages for current workflow should be delivered |
Comment | Text displayed above the shape in the workflow diagram |
MEMO | Arbitrary custom text. It can be used for any descriptive purposes. It is not displayed anywhere on the diagram. |
Begin (with a clock on its icon)
This shape defines the starting point of a workflow which is executed on schedule, for example, once a week on Mondays.
This shape indicates that a workflow executes on a schedule, but does not actually schedule the workflow to run. To schedule the workflow to run, access Eagle's Automation Center.
The following table describes the shape's properties.
Property | Description |
|---|---|
Name | The default value is Begin. It cannot be changed |
Description | Text displayed below the shape in the workflow diagram |
Auto_Restart On End | This feature can be used as alternative to continuously scheduled workflow. Turning this checkbox on will automatically start new instance of the workflow at the end of the processing. |
Corrid Prefix | Prefix to be used in front of the correlation Id. |
Send notifications | This dropdown field allows you to turn on email notifications for the workflow. Options are: always, never, or on failure. |
Email for Notifications | Email address to which email notifications are to be sent |
TSR Transform Stream | (advanced) This field allows you to use custom stream, which transforms the content and format of Task Status Response (TSR) message before sending it out. |
Generate non-waiting restart stream | On publish action, IWS would generate workflowname_restart stream, which can be used to launch this workflow from consolidated scheduler in Automation Center. By default, the stream will wait until the workflow completes, before allowing the schedule rot move to the next step in the job. Turning this checkbox on enables "fire-and-forget" legacy functionality. This is useful for very long running wokflows, when it is not neceesary to report the status back to the scheduler. |
Skip Cancel Step | By default the wokflow will try to cancel any pending/hanging instances of itself. Turning this flag on allows to skip this cancel/stop step. For this feature to work, provide tag 1176 in the schedule definition with value of your workflow name followed by "_schd" suffix (e.g. myworkflowname_schd) |
TSR Name Prefix | String literal which will be added to the beginning of the TSR file. |
ACK Name Prefix | String literal which will be added to the beginning of the ACK file. |
Custom TSR Location | Folder where TSR messages for current workflow should be delivered |
Custom ACK Location | Folder where ACK messages for current workflow should be delivered |
Cancel pending Jobs on Start | Use this flag to clear file events queue for this workflow on start. |
Allow extra files per load sub-processes | Deprecated. It is recommended to use bundle-based approach instead. Originally this feature would start new process when additional files arrived while the workflow was still in progress. |
Comment | Text displayed above the shape in the workflow diagram |
MEMO | Arbitrary custom text. It can be used for any descriptive purposes. It is not displayed anywhere on the diagram. |
End
This shape defines the ending point of a workflow.
The following table describes the shape's properties.
Property | Description |
|---|---|
Name | The default value is End. It can be changed, but will not affect anything. |
Description | Text displayed below the shape in the workflow diagram |
Comment | Text displayed above the shape in the workflow diagram |
MEMO | Arbitrary custom text. It can be used for any descriptive purposes. It is not displayed anywhere on the diagram. |
Add Comment