Add Widget Dialog Box for Key Performance Indicator (KPI) Widgets
When you add a new widget by using this dialog box, you perform two steps. In the first step, you select the type of the widget that you want to add to the dashboard; the system brings up the version of the Add Widget dialog box that is specific to the widget type. In the second step, you specify the properties that are specific to the selected widget type. When you modify an existing widget, you perform only the second step. (In this case, the system immediately brings up the appropriate version of the dialog box.)
Add Widget Dialog Box: Step 1
Element | Description |
---|---|
Widget Type | The type of widget to be added to the dashboard, which can be one of the following:
|
The dialog box has the following buttons. | |
Cancel | Cancels the changes and closes the dialog box. |
Next | Goes to the next step of the Add Widget dialog box for the selected widget type. |
Add Widget Dialog Box: Step 2
After you select the Key Performance Indicator (KPI) widget type in the Add Widget dialog box, or when you click Edit () on the widget toolbar, the Widget Properties dialog box opens. In this dialog box, you need to specify the properties that are specific to the KPI widget. For more information about KPI widgets, see Specific Widgets: KPI Widgets.
Element | Description |
---|---|
Inquiry Screen | Required. The name of the inquiry form that provides data for the widget. |
Inquiry Parameters | A button that you click to open the Inquiry Parameters dialog box so you can specify the parameters for the inquiry selected in the Inquiry Screen box (for the description of this dialog box, see Other Dialog Boxes). |
Shared Filter to Apply | The shared filter that is applied to the data in the widget. You can apply a shared filter or leave the box blank to display all the data from the inquiry. |
Filter Settings | A button that you click to open the Filter Settings dialog box. (For the description of this dialog box, see Other Dialog Boxes.) You use this dialog box to configure a filter for data displayed on the widget. |
Refresh Data | The interval at which the system refreshes data. The possible values in this
box are the following:
|
Field to Aggregate | Required. The field from the selected inquiry that is displayed on the widget. |
Aggregate Function | The function that is used to aggregate the values of the selected inquiry
field. Possible values in this box are the following:
|
Normal Level Type | The type of the value for the normal level. Possible values in this box are the
following:
|
Normal Level |
The normal threshold of an aggregated field value. If the aggregated field value is less than or equal to this threshold, the color that is selected in the Normal Color box is used as the widget background color. The default value of this box is 0.00. |
Normal Level Field |
The inquiry field whose data is represented numerically, as with amounts or totals. The system will sum the values of the selected field (that is, the field values shown in the corresponding inquiry column) and display the result in the widget. This box is available only if Inquiry Field is selected in the Normal Level Type box. |
Alarm Level Type | The type of the value for the alarm level. Possible values in this box are the
following:
|
Alarm Level |
The alarm threshold of an aggregated field value. If the aggregated field value is between the normal and the alarm level, the color that is selected in the Warning Color box is used as the widget background color. If the aggregated field value is equal to or greater than the alarm level, the color that is selected in the Alarm Color box is used as the widget background color. The default value of this box is 0.00. |
Alarm Level Field |
The inquiry field whose data is represented numerically, as with amounts or totals. The system will sum the values of the selected field (that is, the field values shown in the corresponding inquiry column) and display the result in the widget. This box is available only if Inquiry Field is selected in the Alarm Level Type box. |
Normal Color |
The color of the widget background that is used when the aggregate value of the field selected in the Field to Aggregate box is less than or equal to the value specified in the Normal Level box. The default value of this box is Teal. |
Warning Color |
The color of the widget background that is used when the aggregate value of the field selected in the Field to Aggregate box is between the values specified in the Normal Level and Alarm Level boxes. The default value of this box is Yellow. |
Alarm Color |
The color of the widget background that is used when the aggregate value of the field selected in the Field to Aggregate box is equal to or greater than the value specified in the Alarm Level box. The default value of this box is Pink. |
Visualization Type | The display mode of the KPI widget. Possible values in this box are the
following:
|
Icon | The icon that is displayed in the top left corner of the widget. An icon illustrates a category of the widget parameter. You can select an icon from the predefined list or leave the box empty. |
Caption | The name of the widget on the dashboard. |
The dialog box has the following buttons. | |
Finish | Saves your changes and closes the dialog box. |
Previous |
Returns to the previous step of the dialog box without saving your changes. The button appears only when you are adding a widget. |
Cancel | Cancels your changes and closes the dialog box. |
Other Dialog Boxes
This section describes dialog boxes that you can open from the Widget Properties dialog box.
Element | Description |
---|---|
Parameter | The name of the parameter of the inquiry selected in the Inquiry Screen box. |
Value | The value of the inquiry parameter. |
Use Default Value | A check box that indicates (if selected) that a default value should be used for the inquiry parameter. You can specify the default value on the Generic Inquiry (SM208000) form. |
The dialog box has the following buttons. | |
Cancel | Cancels your changes and closes the dialog box. |
OK | Saves your changes and closes the dialog box. |
Element | Description |
---|---|
Active | A check box that indicates (if selected) that the row is an active filter. |
Brackets | The opening bracket or brackets for composing a logical expression with multiple filtering conditions. |
Data Field | The field whose value the filter should be applied to. |
Condition | One of the following logical conditions, which will be applied to the
value of the field specified as the Data Field
and the values in the Value 1 and
Value 2 fields if applicable:
Note: If you try to filter the inquiry results by using a string
that contains an underscore, the result will also contain the values
with the same string with any symbol instead of the underscore. For
example, if you try to filter the inquiry by a customer name that
contains the Customer_Name string, the system will return all
the customers whose name contains any of the following strings:
Customer_Name, Customer-Name, and Customer
Name. The reason that all of these strings will be returned
is that the underscore is used as a wildcard
character. |
Use Parameter | A check box that indicates (if selected) that a dashboard parameter is used in the filtering condition. When this check box is selected, only active dashboard parameters are displayed in the Value 1 and Value 2 columns. |
Value 1 | The value you enter for the logical condition used to filter the
data, if the selected condition requires a value. The value you enter
must conform with the data type of the selected property. You can enter
or select a fixed value, one of the predefined parameters, or one of the
dashboard parameters. The predefined parameters are listed in Managing Advanced Filters. |
Value 2 | The second value for the logical condition, if the selected logical
condition requires a second value. (For example, the Is Between
logical condition requires a second value.) The value you enter must
conform with the data type of the selected property. You can enter or
select a fixed value, one of the predefined parameters, or one of the
dashboard parameters. The predefined parameters are listed in Managing Advanced Filters. |
Brackets | A group of closing brackets to group logical conditions. |
Operator | The logical operator to be used between groups of logical conditions. |