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.
| Background Color | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
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 | This is a free-form text, which will be displayed above the shape in the 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.
| Info | ||
|---|---|---|
| ||
| 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 | Default is begin. | DescriptionThe default value is Begin. It cannot be changed |
Description | The description you provide here will be displayed below the shape in the workflow diagram | |
Auto_Restart On End | This is a checkbox field. Check to restart automatically at the endfeature 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 is a 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. | |
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 | This is a checkbox field. Check to have any pending jobs canceled upon Use this flag to clear file events queue for this workflow on start. | |
Allow extra files per load sub-processes | This is a checkbox field. Check to allow extra files. | |
Comment | This is a free-form text, which will be 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 |
|---|---|
NameDefault is | endThe default value is End. It can be changed, but will not affect anything. |
Description | The description you provide here will be displayed below the shape in the workflow diagram |
Comment | This is a free-form text, which will be 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. |