Create an automated indicator

Create an automated indicator to automatically collect scores on a regular basis.

Before you begin

Role required: pa_admin, pa_power_user, and pa_data_collector

About this task

An automated indicator is based on an indicator source. You can set indicator values such as, frequency, direction, and a default time series to influence the way the data is processed.

Note: You must have Performance Analytics Premium to create new indicators.

Procedure

Navigate to Performance Analytics > Indicators > Automated Indicators and create a new record (see table for field descriptions).
Table 1. Automated indicator
Field Description
Name Descriptive name of the indicator.
Description A more detailed description of what the indicator does and its purpose.
Frequency The frequency of data points for the indicator, such as Daily, Weekly, or Monthly. This value is set automatically based on the Valid for frequency value from the selected Indicator source. You can select an indicator Frequency before selecting an indicator source to filter the list of indicator sources to display only those indicator sources with the specified frequency. After selecting an indicator source, the Frequency field is hidden on the Indicator form.
Direction When an improvement of the indicator value is taking place. Possible values are Minimize (the lower the value the better) or Maximize (the higher the value, the better).
Unit The unit of measurement for the indicator.
Precision Number of digits behind the decimal separator (0 = none).
Key Check box to indicate if the indicator is a key metric for the process being monitored. Can be used to filter key indicators when selecting scorecards to be displayed at Performance Analytics > Scorecards.
Source fields
Indicator source The basic source for calculating the indicator. You can select only indicator sources for which the Valid for Frequency value for the indicator source is the same as the Frequency for the indicator.
Collect records Check box to indicate if the individual records (sys_ids) are stored when the indicator is collected. Selecting this check box enables you to drill down to those details in the scorecard and widgets.
Aggregate The aggregate function to apply when calculating the indicator on the indicator source. Count counts the number of records. Count distinct counts the number of unique values rather than the total number of records. For example, if the name of a user appears more than once in a list, the user is only counted once. Other choices perform the specified aggregate operation, such as summing or averaging the values in a field across records.
Scripted A check box to indicate if the value should be aggregated based on a script. This option is available only if Aggregate is not set to Count. Clear the Scripted check box to aggregate the values in a field.
Field The field to perform the aggregate operation on. This field appears only if Aggregate is not Count, and Scripted is not selected. You can select only numerical fields, including duration, time, and currency fields, when the Aggregate is any value other than Count or Count distinct.
Script

Select a script or create a new script for the aggregation. This option is available only if the Scripted check box is selected.

A script is used to add information to a record set that is not stored in the table. This additional, virtual attribute can be used in an indicator to base an aggregation on, or as an attribute to classify scores per bucket. The elements of the breakdown source are not stored in a column in the facts table. The script will add a virtual column and adds an element value to each record.

Several sample scripts are available, for example Incident.Age.Days. This is a script that determines the age of open incidents by comparing the creation date with the current date. You can adjust the sample script to your needs or define your own script.

Value when nil The value that is inserted as the score when no value is collected.
Note: This value applies only to the indicator score. It does not impact scores for breakdown elements.
View table The view to use to filter fields included in the data. If you do not select a view, the default view is used. This field appears only if Collect records is selected.
Additional conditions fields
Facts table Table for the indicator. This field automatically displays the table associated with the selected Indicator source.
Conditions

[Optional] Additional conditions can be added to the conditions in the selected Indicator source. Having conditions available at both the indicator source level and the automated indicator level enables you to create extra selections for the indicator data collected. Conditions on text fields are case-sensitive.

For example, to view the number of open incidents not reassigned, based on the reassignment count, you could use the indicator source Incident.Open. However, to get the number of open incidents not reassigned, you must add these conditions in the Indicator form:
  • [Reassignment count] [is] [0][or]
  • [Reassignment count] [is] [empty]
Note: The operators keywords, is same, is different, greater than field, less than field, greater than or is field, less than or is field, is one of, and is not one of are not supported for indicators. Additionally, you cannot define conditions based on service catalog item variables. You can use these options on the indicator source conditions instead.
Access control tab fields
Publish on Scorecards Check box to indicate if the indicator can be used for display. Clear this check box to use the indicator only for formula indicators, for example. When this check box is cleared, the indicator is not shown on the scorecard, but is shown in the widget configurations and on the dashboards.
Visible to Select if the indicator should be visible to all users, or only to specific users and groups. If you select Everyone you can select specific roles required to view the indicator.
Groups Select which groups can view this indicator. This field appears only when the Visible to value is Groups and Users
Users Select which users can view this indicator. This field appears only when the Visible to value is Groups and Users
Visible by all roles Check box to indicate if the indicator is visible to all roles. If this check box is cleared, you can select the roles for which the indicator is visible. This check box appears only when the Visible to value is Everyone.
Note: You must also have at least the pa_viewer role to view any indicators.
Roles The roles that are required to view this indicator. This field appears only when Visible by all roles is not selected.
Other fields
Default time series A predefined analytical function, like a 7-days running average, to display the indicator instead of showing the actual values of the indicator.
Live group profile Live group profile that indicates the live group to which indicator's scores are published.
Order Number indicating the order in which scorecards are displayed. Indicators with the lowest value are displayed at the top of the scorecard list. If no values are provided in the Order field, scorecards are displayed from a to z using the Name field. To use the order field, you must enter order numbers for all indicators. If you put in numbers for only a few indicators, the order in which scorecards are displayed reverts to a to z.
Default chart type Set a default chart type (line, column, spline, or area) for this indicator. When opening the detailed scorecard for the first time, the default chart type is used. If the chart type is changed in the detailed scorecard, that preference is remembered.
Render continous lines When selected, scorecards displaying this indicator show unbroken data lines, even when there is no data for a specific date. This behavior may be useful when displaying data sets with varied starting dates or data that is not regularly updated, such as stock information.
Show real-time score When selected, scorecards displaying this indicator show the score in real time, as well as the current state of associated records. Clear this check box when indicator data is not available in real time, such as in an integration that uses data from a 3rd-party source.
Show delta When selected, enables reporting of historic records when viewing this indicator on a detailed scorecard. You can filter the data to display only the currently data, only the historical data, or the data shared between both sets.
Collect breakdown matrix fields
Collect breakdown matrix
Enable second-level breakdowns for this indicator, such as Open Incidents by Assignment group by Priority.
Warning: Selecting this option exponentially increases the amount of data that Performance Analytics collects. Having a very large number of scores or snapshots may impact the performance of widgets and dashboards.
Consider other options, such as a grouped report if you only need to break down a single score, before enabling second-level breakdowns.

This field is selected by default for new indicators. If you select this field for existing indicators, the scores for the second-level breakdowns are collected when you run the first new collection job.

Collection periods fields
Override collection periods Select this check box to override the number of periods to collect and preserve scores and snapshots for this indicator.
Periods to keep scores When Override collection periods is selected, specify how many periods to collect and preserve scores for. The unit of time for each period depends on the indicator source Frequency value, such as Daily, Weekly, or Monthly.

This value overrides the property com.snc.pa.dc.keep_scores_for.frequency for this indicator.

Periods to keep snapshots When Override collection periods is selected, specify how many periods to collect and preserve snapshots for. The unit of time for each period depends on the indicator source Frequency value, such as Daily, Weekly, or Monthly.

This value overrides the property com.snc.pa.dc.keep_snapshots_for.frequency for this indicator.