Automate
Interface Events H
Use this page to:
- Select Interfaces in the Navigation pane.
- Click the Events icon for the desired interface.
Field |
Description |
EVENT ID |
Displays a system-generated ID to uniquely identify the event. |
PRIORITY |
Displays a value that determines the order in which the event runs. |
EVENT TYPE |
Displays the type of event. Options are:
NOTE: The Event Type selected on the Horizontal View of the Interface Events page determines the configuration options available on the Vertical View. |
PAGE ID |
Displays the page for which the event runs. NOTE: This field only applies to WebApp events. |
EVENT |
Displays the event that executes, which is selected on the Vertical View. The events that are available are those registered to the page selected in the Page ID field. NOTE: This field only applies to WebApp events. |
LOOP |
If checked, the event is intended to be processed multiple times based on input, (e.g. an Automate IO process that downloads multiple files, each of which must be processed individually). If unchecked, the event is not processed multiple times. Refer to Set Up a Looping Process for more information. It is unchecked by default. |
OBJECT |
Displays the name of the workflow view (with the naming convention wf:[WorkflowView])or thestored procedure (with the naming convention sp:[StoredProcedureName]) NOTE: This field is only populated for Workflow and Stored Procedure events. |
COMMENT |
Displays a description of the event. |
ACTIVE |
If checked, the event has been tested and is ready to be run. If unchecked, the event does not run when the interface is either manually run or set to run on a schedule. It is checked by default. |
Parameters |
Click to open a parameters page unique to the Event Type:
Use these pages to set parameters for the event. The parameters in the code are automatically registered to the parameters page for the event. |
Validations |
Click to open the Interface Event (Validations) page. Use this page to add validations at the event level, versus at the interface level. The count on the icon is the total number of validations registered to the selected event. |
Interface Events V
Field |
Description |
Event ID |
Displays a system-generated ID to uniquely identify the event. |
Stored Procedure |
Displays the stored procedure assigned to the event. NOTE: This field only displays for Stored Procedure events. |
Stored Procedure Parameters |
Click to open the Stored Procedure page to view parameters passed to the event. The parameters in the stored procedure event code are automatically registered to the Stored Procedure page for the event. NOTE: This field only displays for Stored Procedure events. |
Event Type |
Displays the type of event. Options are:
The Event Type selected on the Horizontal View of the Interface Events page determines the configuration options available on the Vertical View. |
Page ID |
Displays the page for which the event runs. NOTE: This field only displays for WebApp events. |
Event |
Displays the event that executes, which is selected on the Vertical View. The events that are available are those registered to the page selected in the Page ID field. NOTE: This field only displays for WebApp events. |
WebApp Parameters |
Click to open the WebApp Event page to view parameters (i.e., fields and values) passed to the event. The parameters in the WebApp event code are automatically registered to the WebApp Event page for the event. NOTE: This field only displays for WebApp events. |
View |
Displays the workflow view used by the workflow event. The view is created in the Data Source assigned when the interface was created on the Interfaces page. NOTE: This field only displays for Workflow events. |
Fields |
Click to open the Workflow (Email) page to configure the email settings for the workflow notification, such as subject line and body text. These fields must be added to the view and aliased correctly to be utilized by the workflow. Refer to Configure Workflow Fields in the System Administration help for more information. NOTE: This field only displays for Workflow events. |
Links |
Click to open the Workflow Links page to add links that navigates a user to a specific page to then perform a function. Refer to Configure Workflow Links in the System Administration help for more information. NOTE: This field only displays for Workflow events. |
Workflow Properties |
|
Workflow Method |
Displays the protocol for sending and receiving emails. NOTE: This field only displays for Workflow events. |
Workflow User ID |
If populated, anonymous workflow is used and Workflow User ID displays the user ID who receives the workflow email. If blank, standard workflow is used. Refer to Workflow Overview in System Administration help for more information. NOTE: This field only displays for Workflow events. |
Workflow Expire Days |
Displays the number of days in which a Workflow expires. After the defined number of days, the workflow link no longer works for the user. NOTE: This field only displays for Workflow events. |
Workflow Reuse |
If checked, the workflow is reusable for other interface events. If unchecked, the workflow is not reusable for other interface events. It is unchecked by default. NOTE: This field only displays for Workflow events. |
Link To Page ID |
Displays the page that opens when the user clicks the workflow link in the workflow email. NOTE: This field only displays for Workflow events. |
Link To Page Restricted |
If checked, page access between two pages bound by key fields is restricted. If unchecked, page access between two pages bound by key fields is not restricted, i.e., pages can be linked without restriction. It is unchecked by default. This field is used in conjunction with the Binding Fieldnames field. Normally when two pages contain shared key fields (such as Orders and Order Details), restrict the link to page by binding key. NOTE: This field only displays for Workflow events. |
Binding Fieldnames |
Displays the fields to bind the workflow event. Binding fields are required when the primary keys are not available or if the primary keys have different names. They are needed when the linking relationship cannot be inferred because keys are either not defined or have different names from parent to child. Specify the field names here as one or more parent=child pairs, separated by commas. For example: CustomerID=CustID; or EmployeeID=EmployeeID, Department=DepartNo. (=child portion may be omitted if names are not different.) NOTE: This field only displays for Workflow events. |
Retry Parameters |
|
Retry Interval |
Displays the interval at which to retry running the event. If the Retry Interval field is set 5, and the UOM is set to Hours, when the event fails, the Stewardship Tier tries to run it again in 5 hours. |
Maximum Retry Interval |
Displays the interval at which to stop attempting retries. If the Maximum Retry Interval is 10, and the Retry Interval UOM is set to Hours, when the event fails, it will retry repeatedly according to the Retry Interval. If all of the retries fail for 10 hours, then no further retries are attempted and the Interface instance has failed. |
Retry Interval UOM |
Displays the unit of measure used with the Retry Interval. Options are:
|