Automate
Interfaces H
Use this page to:
Field |
Description |
GROUP |
Displays the name of the interface group. Interface groups are used to categorize interfaces. |
ORDER |
Displays a number to order the interfaces within a group. |
INTERFACE ID |
Displays a system-generated ID to uniquely identify the interface. |
INTERFACE |
Displays the name of the interface. |
DATA SOURCE ID |
Displays the name of the data source registered to Automate that stores the stored procedures, validation views, and workflow views used by the interfaces. |
QUEUE ID |
Displays the service queue used when the interface runs. Queue ID is used to serialize certain operations or for load balance. Options are:
|
SCHEDULE TYPE |
Displays the scheduling options for running an interface. Options are:
|
SCHEDULE |
Displays how often the interface runs based on the Frequency and UOM fields. NOTE: This field is auto-populated by Automate and only displays if the Schedule Type is Frequency. |
RUN TIME |
Displays the time the schedule runs. NOTE: This field is only populated if the Schedule Type is RunTime. |
DAYS |
Displays when the interface runs based on the days selected on the Schedule Info tab on the Vertical View. |
COMMENT |
Displays a comment about the interface’s functionality that is entered in the General tab on the Vertical View. |
THREAD SAFE |
This field is not used. |
ACTIVE |
If checked, the interface has been tested and is ready to be run. If unchecked, the interface has not been tested and is not ready to be run. It is checked by default. NOTE: When checked, the Execute and Submit icons are enabled on the Vertical View. |
Events |
Click to open the Interface Events page. Use this page to register interface events. The count on the icon is the total number of events registered to the selected interface. |
Validations |
Click to open the Interface Validations page. Use this page to register interface event validations. The count on the icon is the total number of validations registered to the selected interface. |
History |
Click to open the Interface Historypage to view historical details of the interface: when it ran, how long it took to run, tasks associated with the interface, etc. |
Interfaces V
This page contains the following tabs:
- General tab
- Contact Info tab
- Schedule Info tab
- Logging tab
General tab
Use this tab to Create an Interface.
Field |
Description |
Interface ID |
Displays a system-generated ID to uniquely identify the interface. |
Interface |
Displays the name of the interface. |
Comment |
Displays a comment about the interface’s functionality. |
Actions |
|
Debug |
Click to test the interface in Debug mode with full logging information. The interface immediately runs in the foreground and writes to every log severity. NOTE: This icon is active when the ACTIVE check box is checked on the Horizontal View. |
Execute |
Click to test the interface. The interface is immediately run in the foreground. NOTE: This icon is active when the ACTIVE check box is checked on the Horizontal View. |
Submit |
Click to submit the interface to the job queue (i.e., to run in the background). NOTE: This icon is active when the ACTIVE check box is checked on the Horizontal View. |
Monitor |
Click to open the Monitor page to view and interact with interfaces that are currently running or that have failed. |
Reset |
Click to reset the last run information and status of the current interface. The Status of the interface is set to Validation Passed and all jobs reference fields are NULLed out. The interfaces looks like it has never been run, but all history is maintained. |
History Info |
|
History |
Click to open the Interface History page to view historical data of the interface: when it ran, how long it took to run, tasks associated with the interface, etc. |
Last Run Date |
Displays the date and time at which the interface last ran. |
Last Run Completed |
Displays the date and time at which the interface last completed. |
Contact Info tab
Use this tab to:
Field |
Description |
Message Success |
Displays the message to be displayed upon a successful completion of running an interface. |
Message Failure |
Displays the message to be displayed upon an unsuccessful completion of running an interface. |
Business Role |
Displays the role that receives the notification workflow email, depending on how workflow notification options are set. A user is assigned to a role. Refer to Assign Users to Roles for more information. |
Business Notification Option |
Displays when a notification workflow is sent to the Business Role. Options are:
|
Development Role |
Displays the recipient of an automated interface email. |
Development Notification Option |
Determines when to send an automated interface email to the specified Development Role. Options are:
|
Schedule Info tab
Use this tab to Schedule Interfaces.
Field |
Description |
Frequency |
Displays the frequency at which the interface runs. NOTE: This field only displays if the Schedule Type is Frequency. |
UOM |
Displays the UOM (Units of Measure) that dictate the frequency of the interface runs. Options are:
NOTE: This field only displays if the Schedule Type is Frequency. |
Schedule |
Displays how often the interface runs based on the Frequency and UOM fields. NOTE: This field is auto-populated by Automate and only displays if the Schedule Type is Frequency. |
Run Time |
Displays the specific time when the interface runs. NOTE: This field only displays if the Schedule Type is RunTime. |
Days |
Displays when the interface runs based on the days selected. |
Days Info |
|
Monday |
If checked, the interface runs on Mondays. If unchecked, the interface does not run on Mondays. It is checked by default. |
Tuesday |
If checked, the interface runs on Tuesdays. If unchecked, the interface does not run on Tuesdays. It is checked by default. |
Wednesday |
If checked, the interface runs on Wednesdays. If unchecked, the interface does not run on Wednesdays. It is checked by default. |
Thursday |
If checked, the interface runs on Thursdays. If unchecked, the interface does not run on Thursdays. It is checked by default. |
Friday |
If checked, the interface runs on Fridays. If unchecked, the interface does not run on Fridays. It is checked by default. |
Saturday |
If checked, the interface runs on Saturdays. If unchecked, the interface does not run on Saturdays. It is checked by default. |
Sunday |
If checked, the interface runs on Sundays. If unchecked, the interface does not run on Sundays. It is checked by default. |
Logging tab
Use this tab to:
Field |
Description |
Debug Mode |
If checked, Storage Level is ignored and all logging with severities of Debug and higher are written to the Log page. If unchecked, all log records are written according to the Storage Level defined on the Parameters page. It is unchecked by default. |