Create a custom metric

How to create a custom metric.

Metrics are created by using the available data sources and existing standard or custom mapping categories. Domain functions, associated with the data sources, retrieve specific data from the transactional database and apply any necessary business logic. A metric is the combination of a data source and a mapping category. For example, the domain function that acts upon the Actual Hours data source retrieves the actual hours worked by an employee. A Pay Code Mapping Category may be applied to the data source to define which actual hours are included in the metric.

To create a new custom metric:

  1. Navigate to Main Menu > Administration > Time application setup > KPI Builder > Metric Definition. A list displays the Name, Description, Short Name, Data Source, Display Format, Precision, Type (STANDARD or CUSTOM), and Status (Enabled or Disabled) of each existing metric.
  2. Click Tap Create . The New Metric Definition page appears.
  3. Enter a name and description for the new metric.
  4. Enter a short name for the metric. The short name is the name of the metric that is used in the raw syntax of a KPI formula. It can have up to 15 characters. The underscore (_) is the only supported special character.
  5. In Category, select Analytics.
    Caution: If you select Healthcare Productivity, see the Configure Custom Metrics for topic.
  6. Select a data source from the drop-down list. All appropriate mapping categories for that data source are loaded into the Mapping Category table.
  7. The Mapping Category table lists all mapping categories configured for the selected data source. To filter this list, click tap Filter and enter a search string in the empty cells immediately beneath the column headings.

    You can condense the table by removing any unpinned columns (columns with a blue heading). Click Tap Column Selection and select or deselect the appropriate columns.

  8. Highlight the mapping categories that you would like to add to the metric and click tap Assign . The mapping categories are added to the list of currently assigned Mapping Categories.
  9. Highlight the mapping categories that you would like to remove from the metric and click tap Un-assign .
  10. Select a mapping category from the table.
  11. Select the display format (NUMBER, PERCENTAGE, CURRENCY, or DURATION). DURATION allows the metric to be displayed based on the user's defined duration display (minutes format or decimal format).
  12. In Precision, enter the precision for calculations such as the number of decimal points.
    Caution: The displayed values are rounded to the decimal according to the locale policy. However, the system calculates with the raw values from the database tables to maintain precise accuracy. As a result, the displayed values may not be exactly the same as the calculated values.
  13. Click Tap Save. The metric has been created as a custom API and is now available to be added to a Dataview or report.
Note: You can use the custom metric in KPI formulas; see the Create a custom KPI topic.

Show example

Assume that managers want to see the number of hours related to Leave. A system administrator would enter the following information in the metric definition:

  • Name: Leave Hours % of Absenteeism
  • Description: Percentage of absenteeism hours that are related to paid leave time
  • First metric selected in the KPI Formula Builder: Leave Hours Paid
  • Second metric selected in the KPI Formula Builder: Absenteeism Hours
  • Operator placed between the two metrics in the formula: /
  • Short Name: LV_PER_ABS
  • Aggregation: SUM
  • Display Format: PERCENTAGE
  • Precision: 2