Defining KPIs

Edit online

About this task

The Add/Edit KPI page in Optimize enables you to create and edit KPIs. You can activate this page from the Business Data page in Optimize for Process or from the System Data page in either version of Optimize. For more information about the elements that make up KPIs and a description of how KPIs function within Optimize, see the “Business Visualization Concepts” chapter in IBM webMethods Optimize User’s Guide. Also, when creating KPIs it is helpful to understand how event maps function in Optimize. For more information about event maps, refer to Mapping Events.

Important: When Analytic Engine runs in Static DB Schema mode, you cannot create, edit, or delete dimensions, event maps, dimension hierarchies or KPI definitions. In addition, all respective buttons in the user interface will be unavailable. For more information about enabling and disabling Static DB Schema mode for the Analytic Engine, see the PDF publication Configuring BAM.

Optimize enables you to define two types of KPIs: individual KPIs and composite KPIs.

  • Individual KPIs associate one measure with one dimension attribute, such as revenue by region or queue length by host. When you define an individual KPI, Optimize creates a KPI instance for each attribute of the dimension defined for that KPI. For example, if you define a KPI to measure revenue by region and you have three regions, Optimize creates three separate KPI instances to collect revenue data for the three regions.
  • Composite KPIs consist of the result of a mathematical operation performed against two other KPIs. For example, if you defined individual KPIs for a product's operating costs and revenue, you can define a composite KPI for the product's profit by subtracting the operating cost KPI from the revenue KPI. A composite KPI must be set up on individual KPIs that have the same collection interval, and dimensionality. Also, composite KPIs should be set up only on two “Sum” calculation or “Average” calculation KPIs. Although it is possible to set up composite KPIs involving a combination of “Sum” or “Average” calculation KPIs, the resulting calculations may be incorrect.
Note: When you define an individual or composite KPI for which applicable data has already been collected, the KPI instances created for that KPI are automatically populated with that existing data. This enables you to determine a KPI's effectiveness without having to wait for new data to be collected. See KPI Back Population for more information.

There are two sections on the Add/Edit KPI page that enable you to define or update the characteristics of a KPI. These sections are KPI Information and KPI Definition. These sections and their related fields are explained below.

  • KPI Information: This section enables you to assign a name to the KPI and define a metric (including an appropriate unit of measure, a calculation type appropriate for data aggregation and a data collection interval). In addition, you can define a naming template which helps you to identify data on graphs and tables throughout Optimize. Finally, in this section you also set Empty Data Set Behavior (EDSB) for the KPI.
  • KPI Definition: The fields in this section enable you to define the KPI type (individual or composite) and to associate a fact with a dimension (a means for breaking out your data into slices), such as revenue by region or queue length by host. This creates a KPI Instance. In addition, you associate event maps and attributes with the KPI and you define a hierarchy.

Because of the inherent complexities involved in creating KPIs, you typically move back and forth between these two sections when defining a new KPI.

The fundamental factor to consider when creating a KPI is the event map selection. The event map you select defines the available dimensions, measures, naming templates, and other variables for the KPI. So, when creating a KPI it is important that you are familiar with the event maps configured on your system and know which one is appropriate for the KPI that you wish to create. For information about creating and editing event maps, refer to Mapping Events.

When creating a KPI, you must define Empty Data Set behavior (EDSB) for that KPI. EDSB behavior defines how the system handles intervals where no data is collected, and EDSB settings can have implications that ripple throughout the system. For an individual KPI with a calculation type of Sum or Count, the Empty Data Set Behavior can be defined as either “No Reading Provided” or “Value is Set To Zero.” For all other calculation types (Average, Last Value, and State), the EDSB is set to “No Reading Provided” and cannot be edited.

After the first KPI is defined on a given measure, all subsequent individual and composite KPIs on that measure must have the same EDSB setting. The EDSB setting for subsequently defined KPIs is defaulted to the setting specified for the first KPI defined on the measure and is not editable.

The following table lists the EDSB settings and summarizes their effects on the calculations and data displays.

EDSB Setting Description
No reading provided Applies only to Sum KPI instances. If applicable, when calculations are performed, zero readings are counted and factored into calculations and are displayed on graphs and tables. Null readings are not factored into calculations and are not displayed on graphs and tables.
Value is set to Zero Returns zero when zero or null readings are provided. The zero/null readings are factored into calculations, and they are displayed on graphs and tables; so they can potentially have a significant effect on values displayed throughout the system.

Also when you create an individual KPI, you can construct a naming template to use for that KPI using the Naming Template field. A naming template enables you to customize the name displayed for each KPI instance. By default, a KPI instance name is composed of the base KPI name plus the dimension hierarchy description. This naming structure is unique but can result in a lengthy display name that is difficult to interpret. Constructing an appropriate naming template enables you to customize the display name in a manner that suits your needs.

The event map and hierarchy you select for the KPI you are creating determine the variables available in the Naming Template field. Variables are constructed using the following format:

[$[DimensionName].[AttributeName]]

The naming template can contain any descriptive text in combination with one or more variables you select. When creating a naming template, you should select variables that make the derived name distinctive for each KPI instance. When working with composite KPIs, the variables available for use in the Naming Template field are those that are common across both KPIs specified.

Adding Individual KPIs

Edit online

About this task

To add or edit an individual KPI

Procedure

  1. In My webMethods, select: Navigate > Applications > Administration > Analytics > KPIs > Business Data (Optimize for Process only) or Navigate > Applications > Administration> Analytics > KPIs > System Data
  2. Click Add KPI.

    Optimize displays the Add/Edit KPI page.

  3. Ensure that the Type field displays the appropriate type of KPI (System or Business). System KPIs monitor intrinsic system information, and Business KPIs monitor process data.
  4. On the KPI Information panel, do the following:
    1. In the Name field, type a name for the KPI.
    2. For the moment, disregard the Unit of Measure and Calculation fields. They are populated automatically when you make a selection in the Fact field below.
    3. In the Collection Interval drop-down list, specify how often Optimize should collect data for this KPI. The default is five minutes. The minimum collection interval is one minute, and the maximum collection interval is eight hours.
  5. On the KPI Definition panel, do the following:
    1. From the Definition Type list, select Individual.
    2. From the Event Mapping list, select an appropriate event map for this KPI.
    3. From the Measure list, select a measure to associate with the KPI. One or more measures associated with the event map you selected in the previous step appear in the Measure list. The appropriate selections appear in the Unit of Measure (UOM) and Calculation text boxes in the KPI Information panel after you have selected a measure.
    4. From the Hierarchy list, select a dimension hierarchy, or select [No Hierarchy]. Optimize displays only those dimension hierarchies that include one or more dimension attributes associated with the event map you selected in the Event Mapping list.
    5. From the Dimension list, select the dimension to associate with the KPI. Optimize displays only those dimensions that are associated with the KPI hierarchy you selected in the previous step.
    6. From the Attribute list, select an attribute associated with the dimension you selected in the previous step.
  6. If you are creating a Sum KPI and it is the first KPI on the specified measure, ensure that the Empty Data Set Behavior field displays the appropriate selection for the behavior you want.
  7. Go back to the KPI Information panel and ensure that the Unit of Measure (UOM) and Calculation text boxes are populated appropriately.
  8. Also in the KPI Information panel, enter or select the appropriate dimension variables for the Naming Template field, if applicable to your system. Dimension variables enable you to ensure that dimension instances are displayed with meaningful names on various data displays. Click the icon to view a list of dimension variables for the selected event map and process.
    Tip: Click the magnifying glass icon to see a sample KPI Instance name using the specified naming template.
  9. Click Save.

Adding Composite KPIs

Edit online

About this task

Observe the following rules when working with Composite KPIs. Note that not all of these rules are enforced through the user interface, so users must be aware of and observe them manually. Failure to observe these rules may result in system problems and/or invalid data.

  • Only individual KPIs with calculation types of SUM-SUM and AVERAGE-AVERAGE are supported for use in Composite KPIs.
  • EDSB for composite KPIs is inherited from the underlying KPIs if the underlying KPIs use the same setting. If the underlying KPIs use different settings, the EDSB for the composite KPI defaults to “Value is set to Zero”.
  • Individual KPIs used in a Composite KPI must have the same dimensionality (including hierarchy).
  • Individual KPIs used in a Composite KPI must all have the same collection interval.

To add or edit a composite KPI

Procedure

  1. In My webMethods select: Navigate > Applications> Administration > Analytics > KPIs > Business Data (Optimize for Process only) or Navigate > Applications > Administration > Analytics > KPIs > System Data
  2. Click Add KPI.

    Optimize displays the Add/Edit KPI page.

  3. In the KPI Information panel, type a name for the KPI in the Name field.
  4. In the KPI Definition panel, do the following:
    1. From the Definition Type list, select Composite.
    2. From the first KPI list, select a KPI. In the KPI Information panel, the Collection Interval field reflects the collection interval for this KPI.
    3. From the Operator list, select the mathematical operation you want Optimize to perform on the two KPIs. Valid operators are Add, Subtract, Multiply, and Divide.
    4. From the second KPI list, select a KPI. This list displays all eligible KPIs based on the first KPI selected.
      Note: The collection interval of the second KPI must match that of the first KPI. Individual KPIs with the same collection interval, event map, and dimensionality are pre-populated, offering a list of KPIs that can be combined with the first KPI selected.
  5. In the KPI Information panel, do the following:
    1. In the Unit of Measure field, type the unit of measure that Optimize should use to evaluate data associated with this KPI (for example, Dollars or Bytes).
      The following table describes the keywords(keywords are not case sensitive) which you should use if you want the unit of measure to be automatically formatted when the KPI results are displayed.
      Unit of Measure Keyword(s) Display
      Dollars “Dollars” or “$” $<value to two decimals>
      Thousands of Dollars “$1000” $<value>, 000.00
      Percentage “%” or “Percent” <value to two decimals>%
      Time in Milliseconds “MS”, “Millis”, or “Milliseconds” <dd> Days <hh:mm:ss.mmm> Hours
  6. Also in the KPI Information panel, enter or select the appropriate dimension variables for the Naming Template field, if applicable to your system. Dimension variables enable you to ensure that dimension instances are displayed with meaningful names on various data displays. Click the icon to view a list of dimension variables for the selected event map and process. Also, type the appropriate free text to create a name that is meaningful for you.
    Tip: Click the magnifying glass icon to see a sample KPI Instance name using the specified naming template.
  7. Click Save.

    To view the data collected for a KPI, you can click KPI Detail icon or search for the name of the KPI in the Search panel on the Business Data page (Optimize for Process only) or the System Data page. For multi-dimensional KPIs (as with the KPI for the three revenue regions described in the paragraph above), navigation will be to the KPI Summary page, where all of the KPI instances associated with the KPI are displayed. To view data for a specific instance, click a KPI icon to go to the KPI Instance Detail page.

    For single-dimension KPIs, clicking the monitor icon or the name of the KPI activates the KPI Instance Detail page.

    For more information on the KPI Instance Detail page, see “Using the KPI Instance Detail Page” in IBM webMethods Optimize User’s Guide.