...
| Note | ||
|---|---|---|
| ||
Some reports require specific roles; Report Details#Reportable 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 Save button. The Report is added to the database, and all buttons and tabs in the Report Details are enabled. |
...
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.
| Anchor | ||||
|---|---|---|---|---|
|
...
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 Details#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 Report Details#Group 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 Report Details#Type Type is List; Orientation of the scheduled report PDF.
| ||||||
PDF Size | If Report Details#Type Type is List; Size of the scheduled report PDF.
| ||||||
Image Width | If Report Details#Type 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 Report Details#Type 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 Report Details#Type Type field in the Report Details:
...
By default, entries in List reports are not sorted; you must specify a sort method in the Report Details#Sort Sort By field in the Report Details.
...
Chart reports entries are grouped by Type. You can see what percent of report entries are in each type by hovering your cursor over the graphic for that type.
List Report
Pie Chart Report
Bar Charts Reports - Horizontal and Vertical
...
Vertical Bar Chart: Group By with Average Line
Horizontal Bar Chart: Group By with Average Line
Vertical Bar Chart: Group By and Stack By with Average Line
Horizontal Bar Chart: Group By and Stack By with Average Line
Vertical Bar Chart: Sum Field with Average Line
Vertical Bar Chart: Average Line and Threshold Line
| Anchor | ||||
|---|---|---|---|---|
|
The Controller provides a series of built-in reports that are base on various Report Details#Reportable 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 Report Details#visible 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.
...
Step 1 | Display the Reports list. |
|---|---|
Step 2 | Right-click in any column header of the list to display an Action menu. |
Step 3 | Select Import. An Import pop-up displays. |
Step 4 | Enter the directory containing the Report XML file(s) to be imported and click OK. |
Step 5 | Refresh the Reports list to view the imported reports. |
...
You can override some of these system properties in the Report Details#Scheduled Scheduled Options section of the Report Details#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 (Report Details#TitleTitle), 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.
...
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. |