...
| Anchor | ||||
|---|---|---|---|---|
|
Reports are based on the Reportable tables in the Universal Controller database.
...
- Manually
- Automatically, as a Widget on any Dashboard. (If you delete a report from which a Widget was created, the Widget will no longer function.)
- On schedule, by attaching the report to an Email Task or Email Notification action for any task type, and then defining a trigger for that task. When the task is triggered, the report is run.
| Note | ||
|---|---|---|
| ||
Some reports require specific roles; Reportable Tables identifies these tables. |
| Anchor | ||||
|---|---|---|---|---|
|
Step 1 | From the Reporting navigation pane, select Reports. The Reports list displays a list of all existing reports. | |||||
|---|---|---|---|---|---|---|
Step 2 | Enter/select Details for a new Report, using the field descriptions below as a guide.
To display more of the Details fields on the screen, you can temporarily hide the list.
| |||||
Step 3 | Click a |
...
Depending on the values that you enter / select for these fields, more (or less) fields may display. See the field descriptions, below, for a description of all fields that may display in the Report Details.
...
Field Name | Description | ||||||
|---|---|---|---|---|---|---|---|
General | This section contains general information about the Report. | ||||||
| Title (name) of the Report.
Reports visible to Me, Everyone, and any Group can have the same title. For example, there can be multiple Reports titled Report #1 as long as only one is visible to Me, one is visible to Everyone, and one is visible to any specific Group. | ||||||
Description |
| ||||||
| Type of Report (see Report Output).
| ||||||
| Universal Controller Reportable table in the Controller database on which the Report is based. | ||||||
| Users that will be able to view this report.
| ||||||
List Fields and Ordering | For List reports; this section allows you to select and arrange fields for the report based on the selected Universal Controller table. | ||||||
Field(s) | Fields in the selected Universal Controller table that you want displayed on the report. | ||||||
| Specifications for how you want fields in the Report to be sorted (see Sorting). | ||||||
Chart Options | For Chart reports; this section allows you design the chart for the report based on the selected Universal Controller table. | ||||||
Chart Size | Size of the displayed report.
| ||||||
| Field in the selected Universal Controller table by which you want to group the fields in the report. | ||||||
Group Threshold | Maximum number of groups to display on the chart, specified by the Report Group Threshold Universal Controller system property. All groups above the threshold will be displayed in one group named Other. | ||||||
Group Order | Sequence of the groups shown in the key below the chart graphic.
| ||||||
Group Date/Time Format | Formatting of the Group By field value when grouping by a Date/Time field (such as Created or Updated).
Group Date/Time Format is applicable (and visible) only when selecting a Date/Time field as the Group By field. | ||||||
Stack By | Field in the selected Universal Controller table by which you want to sort records within each Group. | ||||||
Sum Field | Sum of the integers in the field in the selected Universal Controller table by which you want to group the fields in the report. | ||||||
Bar Thickness | Thickness of the bars on the chart. | ||||||
| Show Average | Indication of whether or not to display the average line on the bar chart. | ||||||
| Average Color | If Show Average is checked; Hexadecimal color of the average line. If an average color is not specified, the color is determined by the Report Average Color Universal Controller system property. | ||||||
| Show Threshold | Indication of whether or not to display the threshold line on the bar chart. | ||||||
| Threshold Color | If Show Threshold is checked; Hexadecimal color of the threshold line. If a threshold color is not specified, the color is determined by the Report Threshold Color Universal Controller system property. | ||||||
| Threshold Value | If Show Threshold is checked; Integer value for the threshold line. | ||||||
| Threshold Label | If Show Threshold is checked; Label for the threshold line. If a threshold label is not specified, the label will be Threshold. | ||||||
| This section allows you to override the values of Universal Controller System Properties for scheduled reports. | ||||||
PDF Orientation | If Type is List; Orientation of the scheduled report PDF.
| ||||||
PDF Size | If Type is List; Size of the scheduled report PDF.
| ||||||
Image Width | If Type is Bar Chart/Horizontal, Bar Chart/Vertical, Pie Chart; Width (in pixels) of the scheduled chart report (overrides Scheduled Report Image Width system property). | ||||||
Image Height | If Type is Bar Chart/Horizontal, Bar Chart/Vertical, Pie Chart; Height (in pixels) of the scheduled chart report (overrides Scheduled Report Image Height system property). | ||||||
Filter | This section allows you filter entries displayed in the Report (see Filters).
| ||||||
Metadata | This section contains Metadata information about this record. | ||||||
UUID | Universally Unique Identifier of this record. | ||||||
Updated By | Name of the user that last updated this record. | ||||||
Updated | Date and time that this record was last updated. | ||||||
Created By | Name of the user that created this record. | ||||||
Created | Date and time that this record was created. | ||||||
Buttons | This section identifies the buttons displayed above and below the Report Details that let you perform various actions. | ||||||
Save | Saves a new Report record in the Controller database. | ||||||
Save & New | Saves a new record in the Controller database and redisplays empty Details so that you can create another new record. | ||||||
Save & View | Saves a new record in the Controller database and continues to display that record. | ||||||
New | Displays empty (except for default values) Details for creating a new record. | ||||||
| Saves the Report under a different Title and/or as being visible to different users. | ||||||
Update |
| ||||||
Run | Generates the report and displays it on a new tab. (Clicking Run does not save any new data entered for the report.) | ||||||
Delete |
| ||||||
Refresh | Refreshes any dynamic data displayed in the Details. |
...
Report output can be created in either of four types, as specified by the Type field in the Report Details:
...
The following sample report outputs for each type were created from the same Universal Controller Reportable Database table: All tasks (ops_task).
List Report Output
...
By default, entries in List reports are not sorted; you must specify a sort method in the Sort By field in the Report Details.
...
The Controller provides a series of built-in reports that are base on various Reportable Tables.
The title of each built-in report is preceded by UAC -.
...
If you want to maintain the same reports across several environments (for example: Development, Staging, and Production), you can export Reports from any Controller cluster node and import those same Reports into any Controller cluster node.
Since every Report is visible to a specific user, a specific group, or Everyone (all users and groups), make sure that for every Report being exported which is visible to a specific user or group, that same user or group also exists on the cluster node(s) to which the Report will be imported.
...
From the Reports list, you can export one Report, multiple Reports, or all Reports. To select specific Reports to be exported, apply a filter prior to exporting.
Each report is exported as an individual XML file to the cluster node location specified in the Export Path Universal Controller system property.
...
Step 1 | Display the Reports list. |
|---|---|
Step 2 | If you do not want to export all Reports, apply a filter. |
Step 3 | Right-click in any column header of the list to display an Action menu. |
Step 4 | Select Export > XML. |
Step 5 | When the export is complete, an Exported message displays above the list, indicating that the export is complete. |
...
You can import Reports, using the XML files created via a Reports list export, by using the Import action that is available from the Reports list (and from any list where the record type can be imported).
...
You can override some of these system properties in the Scheduled Options section of the Report Details.
Methods
To run a task that generates an email with an attached report, you can:
...
When records are being imported by a List Import, the import queries the database for a record with the same (unique) display name to allow for performing UUID mapping where necessary. However, Reports are not unique by display name (Title), so the import must use both the Title and visibility information to perform such a query to facilitate UUID mapping when necessary. If a report with the same UUID already exists in the database, or a report by the same Title/visibility does not exist in the database, then no such UUID mapping will be performed.
...
Table | Table Name | Category | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
Abort Actions | ops_abort_action | Actions | Contains details about Abort actions. | ||||||
Advanced Criteria | ops_task_email_criteria | Tasks | Contains details about Email Monitor task Advanced Criteria. | ||||||
Advanced Criteria | ops_exec_email_criteria | Task Instances | Contains details about Email Monitor task instances Advanced Criteria. | ||||||
Agent File Monitor Components | ops_trigger_component_fm | Triggers | Contains details about Agent File Monitor components of Composite Triggers. | ||||||
Agent File Monitor Task Instances | ops_exec_file_monitor | All Task Instances | Contains details about Agent File Monitor task instances. | ||||||
Agent File Monitor Tasks | ops_task_file_monitor | Tasks | Contains details about Agent File Monitor tasks. | ||||||
Agent File Monitor Triggers | ops_trigger_fm | All Triggers | Contains details about Agent File Monitor triggers. | ||||||
All Actions | ops_notification | Actions | Contains details about all task actions: Abort Action, Email Notifications, Set Variable, SNMP Notification, and System Operation. | ||||||
All Agent Clusters | ops_agent_cluster | Agent Clusters | Contains details about Agent Clusters. | ||||||
| ops_agent | Agents | Displays a list of Agents Overview. | ||||||
All Components | ops_trigger_component | Triggers | Contains details about all Composite trigger components. | ||||||
All Step Actions | ops_zos_step_action | Step Actions | Contains details about z/OS step actions. | ||||||
ops_exec | All Task Instances | Task instance activity (running tasks). | |||||||
All Tasks | ops_task | Tasks | Contains details about tasks of every type, along with associated Task Instance information. | ||||||
All Triggers | ops_trigger | All Triggers | Contains details about triggers of every type. | ||||||
Application Control Tasks | ops_task_application_control | Tasks | Contains details about Application Control tasks. | ||||||
Application Control Task Instances | ops_exec_application_control | All Task Instances | Contains details about Application Control task instances. | ||||||
Application Monitor Triggers | ops_trigger_appl_monitor | All Triggers | Contains details about Application Monitor triggers. | ||||||
| ops_application | Shows a list of Application resources. | |||||||
Audits | ops_audit | Security | Contains details of events being written to the Audit history. (Requires ops_audit_view role to run this report.) | ||||||
Business Services | ops_generic_group | Security | Contains details about Business Services. | ||||||
Calendar Custom Days | ops_cal_cust_join | Calendars | Contains details about which Custom Days are associated with which Calendar records. | ||||||
Calendars | ops_calendar | Calendars | Contains details about Calendar records. | ||||||
Cluster Nodes | ops_cluster_node | Provides details about cluster nodes. | |||||||
Composite Triggers | ops_trigger_composite | Triggers | Contains details about Composite trigger records. | ||||||
Credentials | ops_credentials | Login credentials used by the Controller to access remote machines. | |||||||
Cron Triggers | ops_trigger_cron | All Triggers | Contains details about Cron trigger records. | ||||||
| ops_resource_usage | Virtual Resources | Contains details about Virtual resource usage, as displayed in the Currently In Use By tab. | ||||||
Custom Days | ops_custom_day | Calendars | Contains details about defined Custom Days. | ||||||
Database Connections | ops_database_connection | Connections | Contains details about Database Connections defined in the Controller database. | ||||||
Email Connections | ops_email_connection | Connections | Contains details about Email Connections resources. | ||||||
Email Monitor Components | ops_trigger_component_em | Triggers | Contains details about Email Monitor components of Composite Triggers. | ||||||
Email Monitor Task Instances | ops_exec_email_monitor | All Task Instances | Contains details about Email Monitor task instances. | ||||||
Email Monitor Tasks | ops_task_email_monitor | Tasks | Contains details about Email Monitor tasks. | ||||||
Email Monitor Triggers | ops_trigger_em | All Triggers | Contains details about Email Monitor triggers. | ||||||
Email Notifications | ops_email_notification | Actions | Contains details about Email Notifications associated with tasks. | ||||||
Email Task Instances | ops_exec_email | All Task Instances | Contains details about Email task instances. | ||||||
Email Tasks | ops_task_email | Tasks | Contains details about Email tasks. | ||||||
Email Templates | ops_email_template | Contains details about Email templates. | |||||||
| ops_exclusive_order | Mutually Exclusive | Contains any requests to run exclusively by a task instance. | ||||||
File Transfer Task Instances | ops_exec_ftp | All Task Instances | Contains details about File Transfer task instances. | ||||||
File Transfer Tasks | ops_task_ftp | Tasks | Contains details about File Transfer tasks. | ||||||
| ops_trigger_forecast | Contains details about trigger forecasts. | |||||||
| ops_user_grmember | Security | Contains relationship information between Universal Controller User Groups and Universal Controller Users; that is, which Users belong to which Groups. (Requires ops_admin or ops_user_admin role to run this report.) | ||||||
Group Roles | ops_group_has_role | Security | Contains relationship information between Universal Controller User Groups and Roles; that is, which Groups have been assigned which Roles. (Requires ops_admin or ops_user_admin role to run this report.) | ||||||
Groups | ops_user_group | Security | Contains details about Universal Controller User Groups. (Requires ops_admin or ops_user_admin role to run this report.) | ||||||
| ops_history | Contains a history of task activity. | |||||||
| License Instance History | ops_license_exec_history | Contains statistics relating to the number of task instance executions. | |||||||
Linux/Unix Agent Clusters | ops_unix_agent_cluster | Agent Clusters | Contains details about Linux/Unix agent clusters. | ||||||
Linux/Unix Agents | ops_unix_agent | Agents | Contains details about Linux/Unix agent resources. | ||||||
Linux/Unix Agents In Cluster | ops_unix_agent_cluster_join | Agent Clusters | Shows relationship information between Unix agents and Unix agent clusters; that is, which agents belong to which clusters. | ||||||
Linux/Unix Task Instances | ops_exec_unix | All Task Instances | Contains details about Linux/Unix task instances. | ||||||
Linux/Unix Tasks | ops_task_unix | Tasks | Contains details about Linux/Unix tasks. | ||||||
Local Custom Days | ops_local_custom_day | Calendars | Contains details about defined Local Custom Days. | ||||||
Local Variables | ops_local_variable | Variables | Contains details about task and trigger variables (also called local variables), entered into the Variables tab on a task or trigger record. | ||||||
Manual Task Instances | ops_exec_manual | All Task Instances | Contains details about Manual task instances. | ||||||
Manual Tasks | ops_task_manual | Tasks | Contains details about Manual tasks. | ||||||
Manual Triggers | ops_trigger_manual | All Triggers | Contains Manual trigger records. | ||||||
Mutually Exclusive | ops_task_to_exclusive | Mutually Exclusive | Contains relationship information between tasks and mutually exclusive tasks; that is, which tasks are mutually exclusive with each other. | ||||||
| ops_note | Contains details about Notes attached to Controller records. | |||||||
OMS Servers | ops_oms_server | Connections | Provides details about OMS Servers. | ||||||
Output | ops_exec_output | Task Instances > Other | Contains any output (such as STDOUT) attached to task instances. | ||||||
| ops_resource_order | Virtual Resources | Contains any outstanding requests for a resource by a task instance. | ||||||
PeopleSoft Connections | ops_peoplesoft_connection | Connections | Contains PeopleSoft Connections records. | ||||||
PeopleSoft Parameters | ops_exec_peoplesoft_rt_param | Task Instances > Other | Contains Parameter records associated with PeopleSoft task instances. | ||||||
PeopleSoft Parameters | ops_task_peoplesoft_rt_param | Tasks > Other | Contains Parameter records associated with PeopleSoft tasks. | ||||||
PeopleSoft Task Instances | ops_exec_peoplesoft | All Task Instances | Contains details about PeopleSoft task instances. | ||||||
PeopleSoft Tasks | ops_task_peoplesoft | Tasks | Contains details about PeopleSoft tasks. | ||||||
Permissions | ops_permission | Security | Contains details about Universal Controller Permissions assigned to Universal Controller Users and Groups. (Requires ops_admin or ops_user_admin role to run this report.) | ||||||
Recurring Task Instances | ops_exec_recurring | All Task Instances | Contains details about Recurring task instances. | ||||||
Recurring Tasks | ops_task_recurring | Tasks | Contains details about Recurring tasks. | ||||||
Remote File Monitor Task Instances | ops_exec_ftp_file_monitor | All Task Instances | Contains details about Remote File Monitor task instances. | ||||||
Remote File Monitor Tasks | ops_task_ftp_file_monitor | Tasks | Contains details about Remote File Monitor tasks. | ||||||
Restartable Job Steps | ops_exec_zos_jobstepsui | Task Instances > Other | Contains details about restartable job steps in a z/OS task. | ||||||
Restart Criteria | ops_exec_zos_rstrt_criteria | Task Instances > Other | Contain information about z/OS task restart criteria. | ||||||
Restart Criteria | ops_task_zos_rstrt_criteria | Tasks > Other | Contain information about z/OS task restart criteria. | ||||||
SAP Connections | ops_sap_connection | Connections | Contains SAP Connections records. | ||||||
SAP Task Instances | ops_exec_sap | All Task Instances | Contains details about SAP task instances. | ||||||
SAP Tasks | ops_task_sap | Tasks | Contains details about SAP tasks. | ||||||
Scripts | ops_script | Contains Script records. | |||||||
Set Variables | ops_variable_action | Actions | Contains details about Set Variable actions. | ||||||
SNMP Managers | ops_snmp_connection | Connections | Contains SNMP Managers records. | ||||||
SNMP Notifications | ops_snmp_notification | Actions | Contains SNMP notifications defined for Tasks. | ||||||
SQL Task Instances | ops_exec_sql | All Task Instances | Contains details about SQL task instances. | ||||||
SQL Tasks | ops_task_sql | Tasks | Contains details about SQL tasks. | ||||||
Step Conditions | ops_exec_zos_stepcond | Task Instances > Other | Contains details about z/OS task instance step conditions. | ||||||
Step Conditions | ops_task_zos_stepcond | Tasks > Other | Contains details about z/OS task step conditions | ||||||
Stored Procedure Parameters | ops_exec_stored_proc_param | Task Instances > Other | Contains Parameter records associated with Stored Procedure task instances. | ||||||
Stored Procedure Parameters | ops_stored_proc_param | Tasks > Other | Contains Parameter records associated with Stored Procedure tasks. | ||||||
Stored Procedure Task Instances | ops_exec_stored_proc | All Task Instances | Contains details about Stored Procedure task instances. | ||||||
Stored Procedure Tasks | ops_task_stored_proc | Tasks | Contains details about Stored Procedure tasks. | ||||||
System Monitor Task Instances | ops_exec_system_monitor | All Task Instances | Contains details about System Monitor task instances. | ||||||
System Monitors | ops_task_system_monitor | Tasks | Contains details about System Monitor tasks. | ||||||
System Operations | ops_zos_step_action_sysop | Step Actions | Contains details about z/OS System Operation step actions. | ||||||
System Operations | ops_system_operation | Actions | Contains details about System Operation actions. | ||||||
Task Instance Run Criteria | ops_exec_run_criteria | Task Instances > Other | Contains run criteria information for task instances within Workflows. | ||||||
Task Instance Virtual Resources | ops_exec_to_resource | Virtual Resources | Contains relationship information between Virtual resources and task instances; that is, which task instances are assigned to which Virtual Resources. | ||||||
Task Monitor Components | ops_trigger_component_tm | Triggers | Contains details about Task Monitor components of Composite Triggers. | ||||||
Task Monitor Task Instances | ops_exec_monitor | All Task Instances | Contains details about Task Monitor task instances. | ||||||
Task Monitor Tasks | ops_task_monitor | Tasks | Contains details about Task Monitor tasks. | ||||||
Task Monitor Triggers | ops_trigger_tm | All Triggers | Contains details about Task Monitor triggers. | ||||||
Task Run Criteria | ops_task_run_criteria | Tasks > Other | Contains run criteria information for tasks within Workflows. | ||||||
Task Virtual Resources | ops_task_to_resource | Virtual Resources | Contains relationship information between Virtual resources and tasks; that is, which tasks are assigned to which Virtual Resources. | ||||||
Temporary Triggers | ops_trigger_temp | All Triggers | Contains details about Temporary triggers. | ||||||
Time Components | ops_trigger_component_time | Triggers | Contains details about Time components of Composite Triggers. | ||||||
Time Triggers | ops_trigger_time | All Triggers | Contains details about Time triggers. | ||||||
Timer Task Instances | ops_exec_sleep | All Task Instances | Contains details about Timer task instances. | ||||||
Timer Tasks | ops_task_sleep | Tasks | Contains details about Timer tasks. | ||||||
Universal Command Task Instances | ops_exec_indesca | All Task Instances | Contains details about Universal Command task instances. | ||||||
Universal Command Tasks | ops_task_indesca | Tasks | Contains details about Universal Command tasks. | ||||||
Universal Task Instances | ops_exec_universal | All Task Instances | Contains details about Universal task instances. | ||||||
Universal Tasks | ops_task_universal | Tasks | Contains details about Universal tasks. | ||||||
Universal Template Field Choices | ops_unv_tmplt_field_choice | Universal Templates | Contains details about Universal Template Field Choices. (Requires ops_admin, ops_universal_template_admin, or ops_universal_template_view role to run this report.) | ||||||
Universal Template Fields | ops_unv_tmplt_field | Universal Templates | Contains details about Universal Template Fields. (Requires ops_admin, ops_universal_template_admin, or ops_universal_template_view role to run this report.) | ||||||
Universal Templates | ops_unv_tmplt | Universal Templates | Contains details about Universal Templates. (Requires ops_admin, ops_universal_template_admin, or ops_universal_template_view role to run this report.) | ||||||
| ops_user_has_role | Security | Contains details about Users and Roles, including which Users have which Roles. (Requires ops_admin or ops_user_admin role to run this report.) | ||||||
| ops_user | Security | Contains details about User records. (Requires ops_admin or ops_user_admin role to run this report.) | ||||||
Variable Monitor Components | ops_trigger_component_vm | Triggers | Contains details about Variable Monitor components of Composite Triggers. | ||||||
Variable Monitor Task Instances | ops_exec_variable_monitor | All Task Instances | Contains details about Variable Monitor task instances. | ||||||
Variable Monitor Tasks | ops_task_variable_monitor | Tasks | Contains details about Variable Monitor tasks. | ||||||
Variable Monitor Triggers | ops_trigger_vm | All Triggers | Contains details about Variable Monitor triggers. | ||||||
Variables | ops_variable | Variables | Contains details about Global variables, entered by selecting Variables from the Navigator. | ||||||
Virtual Resources | ops_virtual_resource | Virtual Resources | Contains details about Virtual resource records. | ||||||
Web Service Task Instances | ops_exec_web_service | All Task Instances | Contains details about Web Service task instances. | ||||||
Web Service Tasks | ops_task_web_service | Tasks | Contains details about Web Service tasks. | ||||||
Widgets | ops_widget | Contains details about Widgets. | |||||||
Windows Agent Clusters | ops_windows_agent_cluster | Agent Clusters | Contains details about Windows agent clusters. | ||||||
Windows Agents | ops_windows_agent | Agents | Contains details about Windows agents. | ||||||
Windows Agents In Cluster | ops_win_agent_cluster_join | Agent Clusters | Shows relationship information between Windows agents and Windows agent clusters; that is, which agents belong to which clusters. | ||||||
Windows Task Instances | ops_exec_windows | All Task Instances | Contains details about Windows task instances. | ||||||
Windows Tasks | ops_task_windows | Tasks | Contains details about Windows tasks. | ||||||
Workflow Task Dependencies | ops_task_workflow_edge | Tasks > Other | Contains information about the conditions specified between tasks within workflows. | ||||||
Workflow Task Instance Dependencies | ops_exec_workflow_edge | Task Instances > Other | Contains information about the conditions specified between task instances within workflows. | ||||||
Workflow Task Instances | ops_exec_workflow | All Task Instances | Contains details about Workflow task instances. | ||||||
| ops_exec_workflow_vertex | Task Instances > Other | Contains relationship information between workflows instances and task instances; that is, which tasks are running in which workflows. | ||||||
| ops_task_workflow_vertex | Tasks > Other | Contains relationship information between tasks and workflows; that is, which tasks are in which workflows. | ||||||
Workflow Tasks | ops_task_workflow | Tasks | Contains details about Workflow tasks. | ||||||
z/OS Agents | ops_zos_agent | Agents | Contains details about z/OS agents. | ||||||
z/OS Task Instances | ops_exec_zos | All Task Instances | Contains details about z/OS task instances. | ||||||
z/OS Tasks | ops_task_zos | Tasks | Contains details about z/OS tasks. |
...
Field Name | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Agent |
| ||||||||||||
Agent Acquired | System-supplied; For internal processing only. | ||||||||||||
Agent Cluster Acquired | System-supplied; For internal processing only. | ||||||||||||
All Dependencies Cleared | |||||||||||||
Attempt |
| ||||||||||||
Average Estimated End Time | System-supplied. | ||||||||||||
Calendar |
| ||||||||||||
Class |
| ||||||||||||
CP Duration |
| ||||||||||||
CP Duration Unit |
| ||||||||||||
CPU Time | System-supplied; Amount of CPU time the task took to run. | ||||||||||||
Created |
| ||||||||||||
Created by |
| ||||||||||||
Credentials(credentials) |
| ||||||||||||
Credentials(credentials_var) |
| ||||||||||||
Credentials Variable |
| ||||||||||||
Critical |
| ||||||||||||
Current Retry Count | System-supplied; Displays, only for a running task instance, the current number of times that the Controller has retried the task after it first went to failure status. | ||||||||||||
Delay Duration | Number of days, hours, minutes, and seconds to delay after starting the task. | ||||||||||||
Delay Duration In Seconds | Number of seconds to delay after starting the task. | ||||||||||||
Delay On Start | Amount of time to delay the start of a task, after it has been launched, from the time that it is eligible to start; that is, all dependencies have been met. | ||||||||||||
Duration | System-supplied; Amount of time the task took to run. | ||||||||||||
Duration in Seconds |
| ||||||||||||
Early Finish |
| ||||||||||||
Early Finish Duration |
| ||||||||||||
Early Finish Time |
| ||||||||||||
Early Finish Type |
| ||||||||||||
End Time | System-supplied; Date and time the task instance completed | ||||||||||||
Exclude Backup | Specification for whether the task instance can be excluded from a backup when being purged by retention duration. | ||||||||||||
Exclusive State |
| ||||||||||||
| System-supplied; If the task was launched manually, the ID of the user who launched it. | ||||||||||||
Exit Code |
| ||||||||||||
Finished Early | System-supplied; This field is flagged if the task finished earlier than the time specified in the Early Finish fields. | ||||||||||||
Finished Late | System-supplied; This field is flagged if the task finished later than the time or duration specified in the Late Finish fields. | ||||||||||||
Forced Finished |
| ||||||||||||
Hold Reason |
| ||||||||||||
Hold on Start |
| ||||||||||||
Hold Resources On Failure | If enabled, the task instance will continue to hold Renewable resources if the task instance fails. | ||||||||||||
IO Other |
| ||||||||||||
IO Reads |
| ||||||||||||
IO Writes |
| ||||||||||||
| Name of the task instance. | ||||||||||||
Instance Reference Id | System-supplied; the Controller increments this number each time the task is run. | ||||||||||||
Invoked by | System-supplied; How the task instance was launched. One of the following:
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
| If Late Start Type is Duration, use this to specify the longest amount of time this task instance can wait before starting. You can specify any combination of hours, minutes, and seconds. | ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
Longest Estimated End Time | System-supplied. | ||||||||||||
Maximum Retries |
| ||||||||||||
Member of Business Services |
| ||||||||||||
Memory Peak |
| ||||||||||||
Memory Used |
| ||||||||||||
Operational Memo | User-defined operational memo. | ||||||||||||
Predecessors Satisfied Time | he time in which all predecessor dependencies have been satisfied for the task instance. | ||||||||||||
Progress | Indicates the workflow progress in terms of completed tasks: success, finished, or skipped. (A sub-workflow within a workflow counts as one task.} For example, 5/10 indicates that 5 of 10 tasks within the workflow have completed. | ||||||||||||
Projected End Time | System-supplied; projected end time of the task instance. | ||||||||||||
Queued Time | System-supplied; the time that the task was queued for processing. | ||||||||||||
Resolve Name Immediately | Instance Name of the task instance that will be resolved immediately at trigger/launch time. | ||||||||||||
Resources Consumed | System-supplied; For internal processing only. | ||||||||||||
Resource State |
| ||||||||||||
Retention Time | Specification that the task instance launched by a trigger is eligible to be purged from the database as soon as the retention duration time specified in the trigger has been met. | ||||||||||||
Retry Indefinitely |
| ||||||||||||
Retry Interval (Seconds) |
| ||||||||||||
Run Called | (Internal property.) | ||||||||||||
Run Criteria Run Time | Indicates that run-time run criteria was specified for the task. | ||||||||||||
Run Criteria Trigger Time | Indicates that trigger-time run criteria was specified for the task. | ||||||||||||
Security Name | The task name. | ||||||||||||
Shortest Estimated End Time | System-supplied. | ||||||||||||
Start Time | System-supplied; the date and time that the task started. | ||||||||||||
Started Late | System-supplied; This field is flagged if the task started later than the time specified in the Late Start fields. | ||||||||||||
State Changed Time | The last time the task instance changed status. | ||||||||||||
Status | System-supplied; Provides additional information, if any, about the status of the task. | ||||||||||||
Status Description | System-supplied; Provides additional information, if any, about the status of the task. | ||||||||||||
Status History | History of all statuses that the task instance has gone through. | ||||||||||||
Unique system identifier associated with a task instance. | |||||||||||||
Task |
| ||||||||||||
Task Description | User-supplied description of this record. | ||||||||||||
Task Priority | Priority of this task instance, as set by the user via the Set Priority command. Options are: High, Medium, Low. | ||||||||||||
Time Wait State |
| ||||||||||||
Trigger |
| ||||||||||||
Trigger Time | Date and time (current or user-selected) when the trigger launches its tasks. | ||||||||||||
|
| ||||||||||||
Universal Template | If Type = Universal; Name of the Universal Template on which the Universal Task Type is based. | ||||||||||||
Updated |
| ||||||||||||
Updated by |
| ||||||||||||
Updates |
| ||||||||||||
User Defined Field 1 | First of two possible user-defined fields that displays in the General Information section of the task instance Details. | ||||||||||||
User Defined Field 2 | Second of two possible user-defined fields that displays in the General Information section of the task instance Details. | ||||||||||||
User Estimated End Time | System-supplied; If the user entered information into the User Estimated Duration field in the task definition, the Controller uses this information to calculate an end time for the task instance, based on the date/time the task instance started. | ||||||||||||
UUID | Universally Unique Identifier of this task instance. | ||||||||||||
Vertex Id |
| ||||||||||||
Virtual Resource Priority | Priority for acquiring a resource for this task instance. | ||||||||||||
Wait Day Constraint | Specification for whether or not to advance the wait time to another day. | ||||||||||||
Wait Duration | Number of days, hours, minutes, and seconds to wait before starting the task. | ||||||||||||
Wait Duration In Seconds | Number of seconds to wait before starting the task. | ||||||||||||
Waited for Exclusive | Indicates that the task instance could not run exclusively immediately and went into an Exclusive Wait state. | ||||||||||||
Waited for Resources | Indicates that the task instance could not get resources immediately and went into a resource wait state. | ||||||||||||
Wait Time (HH:MM) | Number of hours and minutes to wait before starting the task. | ||||||||||||
Wait To Start | Amount of time to wait before starting a task from the time that it was launched. | ||||||||||||
Wait Until Time | Amount of time calculated to wait before the task was started. | ||||||||||||
Workflow | Name of the workflow, if appropriate. | ||||||||||||
Workflow Definition | Name of the parent workflow task definition. | ||||||||||||
Workflow Only | Specification for whether or not to apply the Wait To Start and Delay On Start specifications only if the task is in a Workflow. | ||||||||||||
Workflow Start Time | Start time of the parent workflow task instance. |
...