Add widget dialog box for scorecard KPI widgets
You use the Add widget dialog box to add a widget to a dashboard and to modify an existing widget. The settings that you need to specify depend on the widget type.
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 for 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
When you want to add a new widget to a dashboard, you first need to select the type of the widget in the Add widget dialog box. The elements of the dialog box are described in the table below.
| Element | Description |
|---|---|
| Widget type | The widget type to be added to the dashboard, which can be one of the following:
|
| Cancel (button) | Cancels the changes and closes the dialog box. |
| Next (button) | 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 Scorecard KPI widget type in the Add widget dialog box, or when you click Edit in the widget toolbar, the Widget properties dialog box opens.
In this dialog box, you need to specify the properties that are specific to the scorecard KPI widget. For more information about scorecard KPI widgets, see:.
For the detailed procedure that describes adding a scorecard KPI widget to a dashboard, see: Add a scorecard KPI widget.
Widget properties dialog box. You can use this dialog box to specify the widget properties that are specific to scorecard KPI widgets.
| Element | Description |
|---|---|
| Inquiry screen | Required. The name of the inquiry window that provides data for the widget. |
| Inquiry parameters | A button that you click to open the Inquiry parameters dialog box where you can specify the parameters for the inquiry selected in the Inquiry screen field. |
| 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 field blank to display all the data from the inquiry. |
| Scorecard title | The name of the scorecard parameter that is displayed in the scorecard area. |
| 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 field 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 colour that is selected in the Normal colour field is used as the widget background colour. The default value of this field is 0.00. |
| Alarm level | The alarm threshold of an aggregated field value. If the aggregated field value is between the normal and the alarm level, the colour that is selected in the Warning colour field is used as the widget background colour. If the aggregated field value is equal to or greater than the alarm level, the colour that is selected in the Alarm colour field is used as the widget background colour. The default value of this field is 0.00. |
| Normal colour | The colour of the widget background that is used when the aggregate value of the field selected in the Field to aggregate field is less than or equal to the value specified in the Normal level field. The default value of this field is Visma green. |
| Warning colour | The colour of the widget background that is used when the aggregate value of the field selected in the Field to Aggregate field is between the values specified in the Normal level and Alarm level fields. The default value of this field is Visma yellow. |
| Alarm colour | The colour of the widget background that is used when the aggregate value of the field selected in the Field to aggregate field is equal to or greater than the value specified in the Alarm level field. The default value of this field is Visma red. |
| Automatically adjust font size | A check box that indicates (if selected) that the size of the font used in the widget is adjusted automatically, depending on the widget size. By default, this check box is selected. |
| Font size | The size of the font that is used in the widget. You can select the font size from the list. This field is available only if the Automatically adjust font size check box is cleared. |
| Caption | The name of the widget on the dashboard. |
| Finish (button) | Saves your changes and closes the dialog box. |
| Previous (button) | Returns to the previous step of the dialog box without saving your changes. The button appears only when you are adding a widget. |
| Cancel (button) | 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.
Inquiry parameters. You can use this dialog box to specify the parameters of the inquiry selected in the Inquiry screen field.
| Element | Description |
|---|---|
| Parameter | The name of the parameter of the inquiry selected in the Inquiry screen field. |
| 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 in the Generic inquiry (SM208000) window. |
| Cancel (button) | Cancels your changes and closes the dialog box. |
| OK (button) | Saves your changes and closes the dialog box. |