Metrics

Introduction

Metrics are used to define a calculation once and reuse it in the entire app. For example, you can make a metric to calculate the number of invoices , or a metric to calculate the average amount. You can further reuse these metrics in different charts.

Note:

You cannot preview or publish the app when adding or editing metrics.

Editing Metrics

Follow these steps to edit a metric.

1. Locate the metric you want to edit and click on .
2. Edit the Metric name as desired.
3. Click on Save.

See the illustration below for an example.

Below is a description of the elements of the Edit metric dialog.

Element	Description
Metric name	The display name of the metric.
Field used for aggregation	The field that is used to calculate the metric.
Aggregation type	The type of the function that is used to calculate the metric. For example, SUM is used to calculate a Total value, AVERAGE is used to calculate an Average value.

Adding Metrics

If the metric you want to use is not available by default, you can create new metrics that can be used in your dashboards.

Follow these steps to add a new metric.

1. In the Data Manager panel, click on +New metric.

   The Add metric dialog is displayed.

2. Enter a descriptive name for the new metric in the Metric name field.

   It is a good practice to refer to the type of function you use to calculate the metric.

3. Select the field that you want to use to calculate the metric from the Field drop-down list box.
4. Select the function that you want to use to calculate the metric from the Aggregation drop-down list box.

The Aggregation drop-down list only contains functions that are applicable for the selected field type.

See the illustration below for an example.

Rules

Elements of a rule

Below is a description of the elements a rule.

Element	Description
Aggregation type	The type of the function that is used to calculate the metric. For example, SUM is used to calculate a Total value, AVERAGE is used to calculate an Average value.
Field used for aggregation	The field that is used to calculate the metric.

Aggregation type

Below is an overview of the aggregation types available for configuring a rule.

Aggregation type	Returns	Field types allowed
Input value	a constant	number, currency, percentage
Distinct count	the number of unique values for the selected field	all
Count	the number of values for the selected field	all
Case average	the sum of all values for selected field divided by the number of cases	number, duration , currency
Average	the sum of all values for selected field divided by the number of records in the table of the selected field	number, duration
Min	the smallest value for the selected field	number, duration , currency
Max	the largest value for the selected field	number, duration , currency
Percentage	the percentage of TRUE values for the selected field	boolean
Sum	the sum of all values for the selected field	number, duration , currency

Using static values

In stead of an aggregation type, you can select to use a constant value to calculate the metric. If you select the Input value option from the list of aggregations, you can enter a value and select the field type.

Configuring rules

Follow these steps to configure a rule.

1. Select the function that you want to use to calculate the metric from the Aggregation types list.

   Tip:

   You can start typing the aggregation type and select Enter.

   
2. Select the field that you want to use to calculate the metric from the Field used for aggregation drop-down list.
   Note:

   The Field used for aggregation drop-down list only contains fields that are applicable for the selected aggregation type.

3. If desired, apply filters to the values that should be considered for the evaluation of the aggregation used for the metric.

4. Select Save in the Create KPI panel.

Repeat these steps if you want to add another aggregation for the rule.

Note:

You can add up to two aggregations to define the rule. If you define two aggregations for the rule these will be evaluated as a division. In this case, you can select to display the results as a percentage value.

Applying filters to an aggreagation

Follow these steps to appy filters to an aggregation.

1. Select the aggregation for which to you want to apply filters.

2. Select +Add filter in the Create KPI panel.

3. Define the filters as desired.

The icon is displayed next to the aggregation indicating that filters are applied for the aggregation.

Tip:

You can select the icon to see a preview of the applied filters.

Removing an aggregation

Follow this step to remove an aggregation from a rule.

1. Locate the aggregation you want to remove and select the icon.

Note:

The aggration is removed whithout any notification.

Deleting metrics

To keep your process app clean, you can delete metrics that are not used anymore. Follow these steps to delete a metric.

1. In the Data Manager panel, locate the metric you want to delete.

2. Hover over the metric name and click on the Delete metric icon.

   A confirmation message is displayed.

3. Click on Delete.

   See the illustration below.

   
   

   

   
   
   Note: You can only delete user-created metrics. Metrics that are used in charts can not be deleted.