Defining Process Analytics Based on a Table or Business View
To define the process analytics using a table or business view as the data provider:
-
Access the Parent Process tab of your newly created user-defined process and click the Process Analytics tab on the right.
-
Click the Add Metrics or Analytic (+) icon.
The Shown at Runtime option is enabled by default, allowing users to view and analyze process analytics at runtime. Disable this option to hide process analytics during runtime.
-
From the Data Provider Type drop-down list, select the required data provider type as Table - Analytic or View - Analytic for your process. The available data provider types for process analytics are Table - Analytic, View - Analytic, Logic Extension - Analytic, and Orchestration - Analytic.
-
In the Object Name field, enter the data provider ID (Table ID or a Business View ID), and press Enter. The Label field is auto populated with the same value as the Object Name field. You can override this value. The system displays the value in the Label field as the name of the Process Analytics tab.
The system also displays the Filter Criteria, Return Fields, and Context Chart sections on the new Process Analytics tab.
-
(Optional) In the Filter Criteria section, click the Add Filter (+) icon, and complete these fields:
-
Column: This drop-down list displays the columns from the selected table or business view. Select the required column to filter the fields.
-
Operator:
This drop-down list displays the available operators based on the data type of the selected column. Select an operator, or select refer to to allow users to specify values at design time or runtime.
Note: If you select in list as the operator, the system displays the Add More Value (+) icon to add more values to the list. -
Value:
Enter a value.
If you selected refer to in the Operator field, the system displays (new) under Design Options and Runtime Options in this field. Select the required value to allow users to enter values at design time or runtime.
When you select (new) under Design Options, the system displays the Open Design Option icon
next to the Value field. Click the icon to open the Design
Option tab, and enter a value in the Default Value field.When you select (new) under Runtime Options, the system displays the Open Data Filtering and Grouping Options icon
next to the Value field. Click the icon to open the Open
Data Filtering and Grouping Options tab, and then enter a value in
the Default Value field.Note:The value (new) appears in the Value field the first time you define a filter value (runtime or design-time). If a value has already been defined for either option, the system displays the existing value in the Value field under Design Options and Runtime Options along with the (new) value.
You can click the Add Filter (+) icon and define more filter criteria for your analytics chart.
Important:When defining filters for metrics and analytics, use a consistent set of filters across all metrics and analytics, and reference the appropriate runtime or design time options as needed.
-
-
Click the Parent Process icon
to return to the Parent Process tab if you defined runtime or
design-time values for your filters. - From the Series Type drop-down list, select a value to define how you want the data
to be grouped and plotted in the process analytic chart. The available series types
are:
-
Based on Returns: It is mandatory to define at least one return field if you select this option. See point 8.
-
Based on Formula of Variables: When you select this option, the system enables you to define the values in the Variables Definition and Series Definition sections. You can specify the values as Design Time or Runtime by selecting refer to from the Operator drop-down list.
It is mandatory to define exactly one return field if you select this option. See Step 8.
In the Variable Definition section, enter the Variable ID, and then complete the Column, Operator, and Value fields. To allow values to be specified at design time or runtime, select refer to from the Operator drop-down list.
Note: If you select in list as the operator, the system displays the Add More Value (+) icon to add more values to the list.In the Series Definition section, click the Add Series Return (+) icon and complete these fields:- Label: Enter a value in the Label field.
- Formula: Enter a math expression using the defined variables. For example, {1}*100/({0} + {1})
- Decimal Places: Enter the value to specify decimal place.
- Data Label Format: Enter a data label format using the {0} placeholder. For example, USD{0}, {0}%,{0}days and so on.
- Series Chart Type: Select a chart type from the drop-down list.
- Color Theme: Select a color theme from the drop-down list.
- Dual Y: This option is disabled by default. Enable this option if you want to plot one or more data series on a secondary vertical (Y) axis.
-
Based on Complex Condition: Click the Add Variable (+) icon to define the complex condition for the series. The system displays the Extra Filter Criteria for the Variable and Series Definition sections.
In the Extra Filter Criteria for the Variable section, click Add Conditions (+) icon and then complete the Column, Operator, and Value fields. To allow values to be specified at design time or runtime, select refer to from the Operator drop-down list.
In the Series Definition section, complete these fields:- Label: Enter a value in the Label field.
- Formula: Enter a math expression using the defined variables. For example, {1}*100/({0} + {1})
- Decimal Places: Enter the value to specify decimal place.
- Data Label Format: Enter a data label format using the {0} placeholder. For example, USD{0}, {0}%,{0}days and so on.
- Series Chart Type: Select a chart type from the drop-down list.
- Color Theme: Select a color theme from the drop-down list.
- Dual Y: This option is disabled by default. Enable this
option if you want to plot one or more data series on a
secondary vertical (Y) axis. Note:
You can click the Add Variable (+), Add Series Return (+) icons to define additional variable and series conditions.
-
-
In the Return field section, the Include Count option is enabled by default. You can disable the Include Count option. When Include Count option is enabled, complete these fields:
Note: This section is displayed only if you have selected the Series Type as Based on Returns or Based on Formula of Variables.-
Label: Enter a label text.
-
Series Chart Type: Select the required chart type from the drop-down list.
-
Color Theme Override: Select the color from the drop-down list to override the current color theme.
Click the Add Return (+) icon and complete these fields:
-
Column: This drop-down list displays the columns from the selected table or business view. Select the required column.
-
Label: Enter the label.
-
Operator: Select the required operator from the drop-down list. The operator values are displayed based on the data type of the selected column.
-
Decimal Places: Enter the value to specify decimal place.
-
Data Label Format: Enter a data label format using the {0} placeholder. For example, USD{0}, {0}%,{0}days and so on.
-
Series Chart Type: Select a chart type from the drop-down list.
-
Color Theme: Select the required color theme.
-
Dual Y: Enable this option to display two different Y-axes so you can plot two measures with different scales or units on the same chart.
-
-
To define the Context Chart, click the Add Context Chart icon (+) and complete these fields:
-
Groups: Select the required column to group from the drop-down list.
-
Chart Name: The selected value in the Group field (column name) is displayed by default as the chart name. You can override this value and enter a new name.
-
Orientation: Select the orientation as Horizontal or Vertical.
-
Data Label Display: Select an option from the drop-down list. The available options are: Never, Always, and Max Mode only.
-
Data Label Position: This value sets the position of the data label on the chart. Select a value from the drop-down list.
-
Stack Series: This option is disabled by default. Enable this option if you want to stack the series on the chart.
-
Y Axis Title and Dual Y Axis Title: Enter the titles for the axis in these fields.
-
Sort By: Select the value from the drop-down list.
-
Show Top: This field limits the chart to the specified number of results (for example, the top 10 customers). Enter a value as required, and then click the Ascending or Descending icon to display the top records in the selected order.
- Reference Line Name: Enter a name. This is the display text shown on
the reference line. After you enter a name in this field, the system
displays the following fields:
- Display Format: Enter a reference line format using the {0} placeholder (For example, Min = {0}, Max = {0}).
- Default Value: (optional) Enter a default value.
- Color Theme: Select the required color theme from the drop-down list.
- Show Zero Groups: This option is enabled by default. Disable it if you do not want to display groups with zero values.
-
-
Click Save.