Overview

Widgets are graphic and/or alphanumeric displays of of real-time, dynamic information about Universal Controller, the jobs it is running, and the environment in which it is operating.

Some Widgets are provided by the Controller, and you can create as many other Widgets as desired. You can add any Widget to any dashboard except the Home Dashboard.

Types of Widgets

There are three type of Widgets:

System Widgets
Activity Widgets
Report Widgets

Creating a Widget

Note

You can create Widgets (Activity Widgets and Report Widgets only; System Widgets cannot be created) only if you have been assigned the ops_admin, ops_report_admin, or ops_widget_admin role; otherwise, the New button does not display at the top of the Widgets list.

Step 1	From the Reporting navigation pane, select Widgets. The Widgets list displays.
Step 2	From the drop-down list at the top of the list, select the type of Widget you want to create: Activity Widget Report Widget The Widget Details for that Widget type displays. Note The General section of Widget Details is the same for System, Activity, and Report Widgets, but the Details section is different for all three types of Widgets.
Step 3	Enter / select Details for a new Widget, using the field descriptions as a guide. Required fields display an asterisk ( * ) after the field name. Default values for fields, if available, display automatically. To display more of the Details fields on the screen, you can either: Use the scroll bar. Temporarily hide the list above the Details. Click the New button above the list to display a pop-up version of the Details.
Step 4	Click a Save button. The Widget record is added to the database, and all buttons in the Widget Details are enabled.
Step 5	To see how the Widget will display, click the Preview button. Graphic Widgets identify the entries that comprise the graphic with color, and an alphanumeric key identifies the number of each entry type represented by the color. You also can see what percent of Widget entries are in each type by hovering your cursor over that portion of the graphic.

System Widgets

System Widgets contain information about:

Controller system details
Agent, Cluster Node, and OMS Server status
Task instance status and type

All System Widgets are provided by the Controller. You cannot modify or delete a System Widget, but you can add or remove it from any Dashboard.

System Widget Details

The following System Widget Details is for the System Details Widget. See the field descriptions below for a description of all fields that display in the System Widget Details for the System Details Widget.

System Widget Details Field Descriptions

The following table describes the fields, buttons, and tabs that display in the System Details Widget Details, above.

Field Name	Description
General	This section contains general information about the Widget.
Name	Name of the Widget
Widget Type	Type of this Widget: System.
Description	Description of this record. Maximum length is 255 characters.
Refresh Rate (Seconds)	Time interval (in seconds) when the dynamic data in this Widget is refreshed.
Details	This section contains detailed information about the Widget.
System Widget Type	Type of this System Widget.
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 Widget Details that let you perform various actions.
Preview	Provides a preview of how this Widget will display on a Dashboard.
Close	For pop-up view only; closes the pop-up view of this Widget.

System Details Widget Preview

The following preview shows how the System Details Widget above will display on a Dashboard.

Note

By default, the only System Details categories that display expanded categories are those specified in the System Details Expanded Categories Universal Controller system property.

Activity Widgets

Activity Widgets contain information about Controller activity; that is, task instance statuses.

The Controller provides a set of Activity Widgets, which you can modify and delete, and you can create your own Activity Widgets.

You also can create an Activity Widget that is a composite of other Activity Widgets

All Activity Widgets display as horizontal bar charts.

Composite Widgets

Composite Widgets are Activity Widgets composed of other Activity Widgets. Composite Widgets can contain any Activity Widgets except other composite Widgets.

To create a Composite Widget, you select task instance statuses for the Widget in the Composite Status(es) field in the Activity Widget Details.

Activity Widget Details

The following Activity Widget Details is for a Success/Finished Activity Widget: a widget based on Success and Finished task instance statuses. See the field descriptions below for a description of all fields that display in the Activity Widget Details.

Activity Widget Details Field Descriptions

The following table describes the fields, buttons, and tabs that display in the Success/Finished Activity Widget Details, above.

Field Name	Description
General	This section contains general information about the Widget.
Name	Name of the Widget. Note The name of an Activity Widget should reference - either directly or indirectly - the task instance Status(es) for which it is created. For Example, if you create a Widget for a specific status and simply name it Widget A, and Widget A then is included in a Composite Widget, that Composite Widget will display on a Dashboard with an entry for Widget A, which provides no indication of the status for which it was created.
Widget Type	Type of this Widget: Activity.
Description	Description of this record. Maximum length is 255 characters.
Refresh Rate (Seconds)	Time interval (in seconds) when the dynamic data in this Widget is refreshed.
Details	This section contains detailed information about the Widget.
Status(es)	Task instance status(es) to include in this Widget.
Time Constraint	Time frame for which you want task instances in the selected status(es) to be included in this Widget. The Time Constraint defined for a Composite Widget overrides the Time Constraints defined in each of its individual Activity Widgets.
Composite Status(es)	Activity Widget(s) to include in this Widget. Each Activity Widget represents one or more task instance statuses. Selecting one or more Activity Widgets in this field, rather than selecting status(es) in the Status(es) field, makes this Widget a composite Activity Widget.
Composite Color	Color used on a Dashboard for this Widget if it is part of a composite Activity Widget.
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 Widget Details that let you perform various actions.
Save	Saves a new Widget 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.
Update	Saves updates to the record.
Preview	Provides a preview of how this Widget will display on a Dashboard.
Delete	Deletes the current record.
Close	For pop-up view only; closes the pop-up view of this Widget.

Activity Widget Preview

The following preview shows how the Success/Finished Activity Widget above - provided by Universal Controller - will display on a Dashboard.

Report Widgets

Report Widgets are based on any Report.

A Report Widget displays in the format selected for the report:

List
Bar Chart/Horizontal
Bar Chart/Vertical
Pie Chart

Report Widget Details

The following Report Widget Details is for an All Widgets Report Widget: it is based on a report using the Widgets (ops_widget) Universal Controller Reportable table. See the field descriptions below for a description of all fields that display in the Report Widget Details.

Report Widget Details Field Descriptions

The following table describes the fields, buttons, and tabs that display in the All Widgets Report Widget Details.

Field Name	Description
General	This section contains general information about the Widget.
Name	Name of the Widget
Widget Type	Type of this Widget: Report.
Description	Description of this record. Maximum length is 255 characters.
Refresh Rate (Seconds)	Time interval (in seconds) when the dynamic data in this Widget is refreshed.
Details	This section contains detailed information about the Widget.
Report	Report on which this Widget is based.
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 Widget Details that let you perform various actions.
Save	Saves a new Widget 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.
Update	Saves updates to the record.
Preview	Provides a preview of how this Widget will display on a Dashboard.
Delete	Deletes the current record.
Close	For pop-up view only; closes the pop-up view of this Widget.

Report Widget Preview

The following preview shows how the All Widgets Report Widget above will display on a Dashboard.

Additional Details

For information on how to access additional details - such as Metadata and complete database Details - for a Widget (or any type of record), see Records.

Browser not supported