This topic describes how to use the KPI Manager to create an aggregate
key performance indicator (KPI) to be used in your dashboard. An aggregate
KPI takes its value from a metric and the aggregation function that
you select.
You must have the user role of KPI Administrator, Public KPI
Administrator, or Personal KPI Administrator to perform this task.
To create an aggregate KPI with KPI Manager, complete the
following steps:
- Click the Utilities tab of your
dashboard navigation bar and then click KPI Manager.
- Select a Model and Version.
- Click . The KPI
properties window will open.
- On the Name tab:
- Required: Type the name of the KPI into
the KPI name field.
- Type any additional information you want to include
with the KPI in the Description field.
- Under Access, select either Personal or Shared.
The default privacy setting is Personal. Only you can view a personal KPI, while all users can view
a shared KPI.
- On the Definition tab of the KPI
properties table, define the KPI:
- Required: Select an operator.
- Required: Select a metric.
- Select a time reference:
- For a Last completed period time reference:
- Select a period.
- Select a time zone.
- Selecting a location is optional.
- Select a time metric.
- For a Current period time reference:
- Select a period.
- Select a time zone.
- Select a location.
- Select a time metric.
- For a Sliding interval time reference:
- Specify the sliding interval by typing a number in the Past field
and selecting a Period. This interval will
slide back from the current date and time.
- Select a time metric.
- For a Fixed interval time reference:
- Specify a From and To date
range using the calendar icons.
- Select a time zone.
- Select a location.
- Select a time metric.
The default time reference is None.
- Optional: In the Data filter field:
- Click Add to create the first filter criteria
line.
- Select a metric from the Metric field.
- Select an operator from the Operator field.
If the In operator is select, click the ellipse
button to input the value.
- Input the value of your filter in the Value field.
For numerical and string filters, type the value into the field. For
a duration filter, click the ellipse button to display the duration
picker. For a boolean filter, select either True or False from
the menu.
- Select Case sensitive to make your filter
value case sensitive.
- Click Add to create an additional filter
criteria line.
- To delete a filter criteria line, click
.
- To save and exit, click OK. To
save and continue making changes, click Apply.
To exit without saving, click Cancel.
- Optional: Click the Range tab
of the KPI properties table to specify a target and range:
- In the Target field:
- If the KPI is a decimal KPI, type a value for the target.
- If the KPI is a duration KPI, click [...]
and select values for day, hour, minute, and second.
- For the Range definition, select
either Numerical or Percentage.
- To add a range, click Add.
- Type the range name by selecting the Range
Name field.
- Type the start and end values of your range by selecting
the Start Value and End Value fields.
- Under the Color column, click
the color and use the color palette to select a color that will represent
that range in the KPI. Click OK to save and
apply the color. Click Cancel to exit without
saving any colors.
- Under the Icon column, click
the icon and use the icon palette to select an icon that will represent
that range and the KPI's status. Click OK to
save and apply the icon. Click Cancel to exit
without saving any icons.
- To add another range to the bottom of the table, click Add.
- To delete a range from the table, click the delete icon.
- To save and exit, click OK. To
save and continue making changes, click Apply.
To exit without saving, click Cancel.
- Optional: Click the Other tab
of the KPI properties table:
- Type the name of the KPI owner in the KPI
owner field. This field will only be enabled
during an edit of a KPI, not a creation. It is also only enabled for
administrators to assign a new owner.
- Specify the display format of the KPI value:
- In the Decimal place precision field, type
the decimal place precision.
- In the Currency field, select a currency
symbol.
- Click Show percent sign to display the
percent sign in the KPI.
- Under Source of data used to calculate the
KPI value, select whether you want to use All
versions of the selected model or Current version
of the selected model only. All
versions of the selected model aggregates all the data
points regardless of the model version used when the data points are
collected. This is the common option.Current version of
the selected model only aggregates those data points collected
for this current selected model version only. This option is helpful
when the KPI has incompatible changes from previous version of the
same model.
- To save and exit, click OK. To
save and continue making changes, click Apply.
To exit without saving, click Cancel.
- To ensure your current setting are valid,
click the Preview tab. Clicking Preview will
automatically validate your specified settings. Click OK to
save and exit. To save and continue making changes, click Apply.
To exit without saving, click Cancel.