Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Field Name

Description

General

This section contains general information about the Report.

Anchor
Title
Title
Title

Title (name) of the Report.
 
Report titles must be unique per visibility (see Visible To field, below):

  • Any Report that you make visible to Me (the logged in user) must have a unique Title among all Reports visible to Me.
  • Any Report that you make visible to Everyone (all users) must have a unique Title among all Reports visible to Everyone.
  • Any Report that you make visible to a Group must have a unique Title among all Reports visible to that Group.

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

Include Page
UC71xIL:SummaryUC71x
IL:Summary

Anchor
Type
Type
Type

Type of Report (see Report Output).
 
Options:

  • List
  • Bar Chart/Horizontal
  • Bar Chart/Vertical
  • Pie Chart

Anchor
Table
Table
Table

Universal Controller Reportable table in the Controller database on which the Report is based.

Anchor
Visible To
Visible To
Visible To

Users that will be able to view this report.
 
Options:

  • Me
    User creating this Report.
  • Everyone
    Any logged in user.
  • <group name>
    Any user in the specified group, selected from a list of groups that the user creating this Report is a member of.

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.

Anchor
Sort By
Sort By
Sort By:

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.
 
Options:

  • Small
  • Medium
  • Large
  • 100% (full screen)

Anchor
Group By
Group By
Group By

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.
 
Options:

  • Label
    Ascending alphanumeric order by Label (for example, Name)
  • Label/Descending
    Descending alphanumeric order by Label (for example, Name)
  • Count
    Ascending alphanumeric order by number of records in the group
  • Count/Descending
    Ascending alphanumeric order by number of records in the group

Group Date/Time Format

Formatting of the Group By field value when grouping by a Date/Time field (such as Created or Updated).
 
Options:

  • - - None - -
  • yyyy
  • yyyy-mm
  • yyyy-mm-dd
  • yyyy-mm-dd hh
  • yyyy-mm-dd hh:mm

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 AverageIndication of whether or not to display the average line on the bar chart.
Average ColorIf 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 ThresholdIndication of whether or not to display the threshold line on the bar chart.
Threshold ColorIf 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 ValueIf Show Threshold is checked; Integer value for the threshold line.
Threshold LabelIf Show Threshold is checked; Label for the threshold line. If a threshold label is not specified, the label will be Threshold.

Anchor
Scheduled Options
Scheduled Options
Scheduled Options

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.
 
Options:

PDF Size

If Type is List; Size of the scheduled report PDF.
 
Options:

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).
 

Note
TitleNote

If you are filtering on date-related fields using the between (inclusive) comparison operator (SQL BETWEEN condition), the database query can produce unexpected results when the later date is specified before the earlier date.


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.

Anchor
Save As
Save As
Save As...

Saves the Report under a different Title and/or as being visible to different users.

Update

Include Page
UC69IL:Update buttonUC69
IL:Update button

Run

Generates the report and displays it on a new tab. (Clicking Run does not save any new data entered for the report.)

Delete

Include Page
UC69IL:Delete buttonUC69
IL:Delete button

Refresh

Refreshes any dynamic data displayed in the Details.

...

All scheduled Reports run under the security context of the task instance Execution User.

An Email Task Instance that attempts to run a report that the Execution User does not have permission to view will terminate with a Start Failure status and the following status description:

Panel
Report with name <report-name> and id <report-id> not visible to execution user <execution-user>.


An Email Notification task instance that attempts to run a report that the Execution User does not have permission to view will include the following statement in the body of the email:

...

Panel
Report with name <report-name> and id <report-id> not visible to execution user <execution-user>.

Bundling and Promotion

Universal Controller does not support the bundling and promotion of reports. Any report required by a promoted task must already be available on the target system.

...

Field Name

Description

Agent

Include Page
UC69IL:Agent - ActivityUC69
IL:Agent - Activity

Agent Acquired

System-supplied; For internal processing only.

Agent Cluster Acquired

System-supplied; For internal processing only.

All Dependencies Cleared


Attempt

Include Page
UC69IL:AttemptUC69
IL:Attempt

Average Estimated End Time

System-supplied.

Calendar

Include Page
UC69IL:CalendarUC69
IL:Calendar

Class

Include Page
UC69IL:ClassUC69
IL:Class

CP Duration

Include Page
UC69IL:CP DurationUC69
IL:CP Duration

CP Duration Unit

Include Page
UC69IL:CP Duration UnitUC69
IL:CP Duration Unit

CPU Time

System-supplied; Amount of CPU time the task took to run.

Created

Include Page
UC69IL:CreatedUC69
IL:Created

Created by

Include Page
UC69IL:Created byUC69
IL:Created by

Credentials(credentials)

Include Page
UC69IL:Credentials fieldUC69
IL:Credentials field

Credentials(credentials_var)

Include Page
UC69IL:Credentials(credentials_var)UC69
IL:Credentials(credentials_var)

Credentials Variable

Include Page
UC69IL:Credentials VariableUC69
IL:Credentials Variable

Critical

Include Page
UC69IL:Calculate Critical PathUC69
IL:Calculate Critical Path

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

Include Page
UC69IL:Duration in SecondsUC69
IL:Duration in Seconds

Early Finish

Include Page
UC69IL:Early FinishUC69
IL:Early Finish

Early Finish Duration

Include Page
UC69IL:Early Finish DurationUC69
IL:Early Finish Duration

Early Finish Time

Include Page
UC69IL:Early Finish TimeUC69
IL:Early Finish Time

Early Finish Type

Include Page
UC69IL:Early Finish TypeUC69
IL: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

Include Page
UC69IL:Exclusive StateUC69
IL:Exclusive State

Anchor
Execution User
Execution User
Execution User

System-supplied; If the task was launched manually, the ID of the user who launched it.

Exit Code

Include Page
UC69IL:Exit CodeUC69
IL: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

Include Page
UC69IL:Forced FinishedUC69
IL:Forced Finished

Hold Reason

Include Page
UC69IL:Hold ReasonUC69
IL:Hold Reason

Hold on Start

Include Page
UC69IL:Hold on StartUC69
IL: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

Include Page
UC69IL:IO OtherUC69
IL:IO Other

IO Reads

Include Page
UC69IL:IO ReadsUC69
IL:IO Reads

IO Writes

Include Page
UC69IL:IO WritesUC69
IL:IO Writes

Anchor
Instance Name
Instance Name
Instance Name

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:

  • Trigger: (Trigger Name)
    Instance was launched by the named trigger.
  • Workflow: (Workflow Name)
    Instance was launched by the named workflow.
  • Manually Launched
    Instance was launched by a user. To determine the name of the user:
    • From the Activity Monitor or Task Instances list, click the task instance name to open the record.
    • The Execution User field identifies the user who launched the task instance.

Anchor
Late Finish
Late Finish
Late Finish

Include Page
UC69IL:Late FinishUC69
IL:Late Finish

Anchor
Late Finish Duration
Late Finish Duration
Late Finish Duration

Include Page
UC69IL:Late Finish DurationUC69
IL:Late Finish Duration

Anchor
Late Finish Time
Late Finish Time
Late Finish Time

Include Page
UC69IL:Late Finish TimeUC69
IL:Late Finish Time

Anchor
Late Finish Type
Late Finish Type
Late Finish Type

Include Page
UC69IL:Late Finish TypeUC69
IL:Late Finish Type

Anchor
Late Start
Late Start
Late Start

Include Page
UC69IL:Late StartUC69
IL:Late Start

Anchor
Late Start Duration
Late Start Duration
Late Start Duration

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.

Anchor
Late Start Time
Late Start Time
Late Start Time

Include Page
UC69IL:Late Start TimeUC69
IL:Late Start Time

Anchor
Late Start Type
Late Start Type
Late Start Type

Include Page
UC69IL:Late Start TypeUC69
IL:Late Start Type

Longest Estimated End Time

System-supplied.

Maximum Retries

Include Page
UC69IL:Maximum RetriesUC69
IL:Maximum Retries

Member of Business Services

Include Page
UC70IL:Member of Business ServicesUC70
IL:Member of Business Services

Memory Peak

Include Page
UC6IL:Memory PeakUC6
IL:Memory Peak

Memory Used

Include Page
UC69IL:Memory UsedUC69
IL: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

Include Page
UC69IL:Resource StateUC69
IL: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

Include Page
UC69IL:Retry IndefinitelyUC69
IL:Retry Indefinitely

Retry Interval (Seconds)

Include Page
UC69IL:Retry IntervalUC69
IL:Retry Interval

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.

Sys id

Unique system identifier associated with a task instance.

Task

Include Page
UC69IL:Task NameUC69
IL:Task Name

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

Include Page
UC69IL:Time Wait StateUC69
IL:Time Wait State

Trigger

Include Page
UC69IL:Trigger NameUC69
IL:Trigger Name

Trigger Time

Date and time (current or user-selected) when the trigger launches its tasks.

Anchor
Type - ops-exec
Type - ops-exec
Type

Include Page
UC69IL:Task TypeUC69
IL:Task Type

Universal Template

If Type = Universal; Name of the Universal Template on which the Universal Task Type is based.

Updated

Include Page
UC69IL:UpdatedUC69
IL:Updated

Updated by

Include Page
UC69IL:Updated byUC69
IL:Updated by

Updates

Include Page
UC69IL:UpdatesUC69
IL: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

Include Page
UC69IL:Vertex IdUC69
IL: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.

...