Configuring widgets
You can configure the Analytics widgets to filter and display the information that requires.
To configure a widget, click Edit on the Analytics dashboard and select the Settings icon on the widget header.
The widget configuration window appears. You can set the required values on the configuration fields to customize the widget. For an example of the widget configuration window, see the following image. Note that the configuration window might be slightly different for each widget because every widget has its own requirements.
If you are editing an elastic widget, see the Configuring elastic widget section for more style configuration steps.
The following settings are commonly available in widget configuration:
Title
The text to be displayed on the widget header.
Dimensions
The process fields on which you want to “group by” the analysis. Depending on the widget, these fields can be case-id, activity, resource, role, pathtime, or any custom field. In addition, the analysis can be grouped by the end-time or start-time of the cases (on either an hourly, daily, monthly, or yearly timeframe).
More than one dimension might be required depending on the widget.
From an SQL perspective, the dimensions are the values of the columns you SELECT from the eventlog and on which you GROUP BY your selection.
Set Case fill to On to auto-fill custom fields that have empty values, by using previous value in the same case.
Measures (Query)
The data to be shown on the widget (grouped by the selected dimensions). Each measure needs to specify:
- A label (it is the Alias of the measure)
- A query: each query can contain Operators, Functions, and Dimensions (go to the Queries page for further clarifications)
- The formatter, which expresses what kind of value is expressed by the measure:
- Auto (the measure unit is fixed automatically)
- Date
- Duration (note that when you select Duration as formatter, if applying business hours and calendar every time measure is expressed in hours)
- Lead time (note that when you select Lead time as formatter, even if you apply business hours and calendar, the time measure is still expressed in days)
- Heatmap
- Number
- Percentage
- Text
From an SQL perspective, the measures are columns you SELECT from the eventlog. To learn more about queries and how to create them, see the Creating queries topic.
Filters
Set specific filters for the widget to analyze the dimensions and measures only for the filtered events.
From an SQL point of view, filters express WHERE conditions.
To apply filters with boolean values, such as parameters or custom metrics, use 1
to state true
and 0
to state false
.
Apply dashboard filters
Decide whether the query must take dashboard filters into account. If you decide not to take dashboard filters into account, only IBM Process Mining filters are applied. This decision can be useful when comparing measures with and without specific filters.
Activity interval
Restrict the measure computation to the only activities in the defined interval.
You must activate and select the activity interval to compute Pathtime based measure.
You can choose, for both the start and the end activity of the path, whether to consider the following:
- first instance: if reworks occurred on the activity, the path considers the first execution
- last instance: if reworks occurred on the activity, the path considers the last execution
For example, look at the differences on the computation of the average pathtime from the start of “Warehouse Loading” to the end of “Invoice Check”
We can immediately detect that reworks occurred on both the activities.
- By computing the pathtime “from last instance to first instance”, we are excluding all the reworks from the computation
- By computing the pathtime “from first instance to first instance”, we are including in the computation all the reworks on the start activity
- By computing the pathtime “from last instance to last instance”, we are including in the computation all the reworks on the end activity. Therefore, the path also includes the activities “Goods check” and “Wait”
- By computing the pathtime “from first instance to last instance”, we are including all the reworks in the computation
You can choose, for both the start and the end activity of the path, whether to consider:
- The start time of the activity
- The start activity execution time is included in the path
- The end activity execution time is excluded from the path
- The end time of the activity (if available)
- The start activity execution time is excluded from the path
- The end activity execution time is included in the path
For example, look at the differences on the computation of the average pathtime from the last instance of “Warehouse Loading” to the first instance of “Invoice Check” (no reworks are thus considered).
- By computing the pathtime “from end time to start time”, we are not considering the execution time of both the start and the end activity.Therefore the path includes only what is between the two activities.
- By computing the pathtime “from start time to start time”, we are considering the execution time of the start activity and excluding the execution time of the end activity; as the execution time of the start activity is 0, the average pathtime is the same as before
- By computing the pathtime “from start time to end time”, we are considering the execution time of both the start and the end activity, therefore the path will also include the two activities
- By computing the pathtime “from end time to end time”, we are considering the execution time of the end activity and excluding the execution time of the start activity; actually, as the execution time of the start activity is 0, the average pathtime is the same as before
Normalize axis
If selected, the measures are normalized.
Render axis labels
It forces the widget to render axis tick labels.
Activities conformance
If an activity is selected as a dimension and you uploaded a reference model into IBM Process Mining, you can focus on:
- All activities
- Only conformant activities
- Only not conformant activities
Hide search box
If selected, the search box on the upper right corner of the widget is not displayed.
Hide empty dimension
If selected, empty dimensions are hidden on the widget.
Add constant line
You can add a constant line on the chart and set its measure unit (number, days, hours, minutes).
Keep last
If selected, only the last value before the specified date is considered for the selected measures.
Rowset threshold
Set the number of rowset to be displayed by the widget, up to 10000.
Show help
It shows you all the possible combination of Operators, Functions, Dimensions, and Custom metrics (if defined) that you can insert in a measure query.
Show SQL-like query
It displays the SQL query that you are inserting in the widget, as a combination of dimensions, measures and filters (go to the Queries paragraph for further clarifications).
Configuring elastic widget style
After you configure the elastic widget, you can customize the style of representation of your data in the elastic widget. To alter the style of the widget, select the Style tab from the widget settings.
To change the appearance of the widget to a chart, select Display as chart. This opens a new set of configurations, as shown in the following image:
See the following table to understand the functions of each available option in the style settings:
Setting | Description | Additional information | |
---|---|---|---|
1 | Rowset threshold | Specifies the limit of table rows to display. | |
2 | Hide empty dimensions | Specifies whether empty dimensions are hidden in the table or chart. | |
3 | Display as chart | Specifies whether the data must be displayed as a table or chart. | |
4 | Chart type | Specifies the type of chart to visualize data. | Available only when Display as chart is selected. |
5 | Basic edit mode | Specifies the chart editing mode. | You can choose to use buttons and toggles or code to configure the chart. |
6 | Color palette | Specifies the colors used in the charts. | Click the colors to customize the palette. |
7 | Show axis 1 | Specifies whether the Axis 1 is displayed in the chart. | |
8 | Show axis 2 | Specifies whether the Axis 1 is displayed in the chart. | |
9 | Inverse axis direction | Specifies whether the direction of the axis must be inversed. | |
10 | Axis name | Specifies the name of the axis. | |
11 | Display axis label inside | Specifies whether the name of the axis is displayed in the chart. | |
12 | Display axis as type | Specifies the type of the data denoted in the axis. | |
13 | Min/Max axis interval | Specifies the minimum and maximum interval values for the axis. | |
14 | Use dimension as data series | Specifies whether to use a dimension as axis in the chart. | Select the dimension to use as axis and select the sorting order as ascending or descending. |
15 | Enable visual map | Specifes whether to enable visual map for the chart. | Visual mapping enhances the visualization of the chart by using colors to define data ranges. You can filter the required data in chart by clicking on the required legend. |
16 | Show toggle chart type | Specifies whether chart type buttons are displayed. | You can use the chart type buttons to switch the chart type. |
17 | Show save chart as image | Specifies whether the Save as image button is displayed. | You can use the Save as image button to download the chart as image. |
18 | Show chart source data | Specifies whether the Data view button is displayed. | You can use the Data view button to view the source data that is used to create the chart. |
19 | Show restore default chart | Specifies whether the Restore button is displayed. | You can use the Restore button to reset the chart settings. |
20 | Show legend | Specifies whether the chart legend is displayed. | |
21 | Zoom inside chart | Specifies whether zoom by scroll wheel is enabled in the chart. | |
22 | Show bottom zoom slider | Specifies whether the chart zoom slider is displayed. | You can use the zoom slider to zoom into the required chart data range. |
23 | Show grid borders | Specifies whether the chart grid borders are displayed. | |
24 | Avoid label overflow | Specifies whether the chart label overflow is allowed. |