Create an automated indicator

Automated indicators are used 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

Each indicator is linked to an indicator source. You can define several properties—such as, frequency, direction, and a default time series—to influence the way the data is processed. You can define extra properties in the Source section, such as aggregates or a script that needs to be executed. The Additional Conditions section enables you to define extra conditions that must be met for the data collected.

Note: You can add indicator groups for the indicator by entering them in the bar below the indicator title. You can assign more than one indicator group one indicator and remove them by clicking the delete (x) icon. Use indicator groups to search for indicators that belong together when creating a widget.

To create an automated indicator:

Procedure

  1. Navigate to Performance Analytics > Indicators > Automated Indicators.
  2. Fill in the fields, as appropriate.
    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 used for displaying this indicator on scorecards and widgets, such as Daily, Weekly, Bi-weekly, 4-Weeks, Monthly. The frequency of the indicators are independent from the job frequency. For example, you could set an indicator's display frequency as monthly, while the job collection runs daily. This ensures that when the indicator is shown, it displays recent data. However, when creating a new indicator, you must select indicator sources that match the frequency of the indicator.
    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 tab 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. Possible values are Count, Sum, Average, Minimum, Maximum, or Count distinct. Count distinct counts the number of unique records rather than the total number of records. So, for example, if the name of a user appears more than once in a list, the user is only counted once.
    Scripted A check box to indicate if the value should be aggregated based on a script. This option is available only if Aggregate is set to Sum, Average, Minimum, Maximum, or Count Distinct. Clear the Scripted check box to aggregate the value by 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.
    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 tab 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. Query 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. You can use these operators 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 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.
    Roles The roles that are required to view this indicator. This field appears only when Visible by all roles is not selected.
    Other tab 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.
    Managed source fields
    Managing indicator If this indicator is a managed indicator, this field references the parent managing indicator.
    Collect breakdown matrix

    If the indicator contains multiple breakdowns, select this option to collect a breakdown matrix. An example of a scorecard with two breakdown layers is: problems by priority and by assignment group. The option is enabled by default for new indicators, which means scores are collected for multiple breakdowns. If the option is selected for existing indicators, the scores for the breakdown matrix are collected on running the first new collection job. Note that enabling this option multiplies the amount of data Performance Analytics collects. If a second level breakdown is only required for a single score, using a 'group by' report on the record set is preferable.

    Users with the data_collector role can enable this option.

  3. Click Submit.
    Create automated indicator