With the launch of Maximo 7.6 came some enhanced functionality around KPI’s. Specifically, two new applications were added to the product: KPI Templates and KPI Viewer. This article will cover the features of how to utilize the KPI Templates application for your organization. For more information on the KPI Viewer application, please sure to visit our related blog article.

In previous versions of Maximo, users created and managed KPI’s through the KPI Manager application. There, they could define the queries that governed the KPI and the Target, Caution, and Alert thresholds. The reason the KPI Templates application was developed for version 7.6 was the challenge of efficiently managing slight variations on KPI’s through the KPI Manager.

For example, take the case of wanting to track the overall backlog of work by man-hours. That number by itself, trended over time, can provide some valuable insight to your organization. However, in most cases, it would behoove the people who analyze that number to know what the breakdown is by craft or crew. Unfortunately, the only way to know this is to create additional KPI’s with a slight change in the query. This can be done by duplicating the query and making the change, which is not overly difficult to do. The challenge comes when you have done this several times and then want to go back and make an adjustment to the query.

This is where KPI Templates come in. We now have an application that we can manage slight query variations in that can automatically generate the resulting records in the KPI Manager application. Let’s see an example.

  1. Log into Maximo as an administrative user.
  2. Go to the Administration > KPI > KPI Templates application.
  3. Create a new KPI Template by clicking the New Template button in the toolbar.
  4. Fill out the following fields:
    1. Description: Backlog Work Orders by Work Type
    2. Application: WOTRACK
    3. Format: Decimal
    4. KPI Query: select count(1) from workorder inner join synonymdomain on workorder.status = synonymdomain.value and synonymdomain.domainid = ‘WOSTATUS’ where synonymdomain.maxvalue not in (‘COMP’,’CLOSE’,’CAN’) and istask = 0 and worktype = ${worktype}
  5. Save the record.

The header section of the Template tab looks very similar to the KPI tab in the KPI Manager application, with one slight variation. Instead of separate Select and Where text boxes, there is a single text box for your KPI Query.

Within the KPI Query, you need to establish at least one variable that will be replaced in each KPI that is generated from the template. Variables are of the form ${variablename}. Variables will be replaced with string literals in the resulting KPI Query, so there is no need to quote them in the template query. In our example, we’ve created a variable called ${worktype}.

For each variable defined within the query, you will need to define a binding for that variable in the KPI Variables table. To continue with our example:

  1. Click the New Row button on the KPI Variables table.
  2. Fill out the following fields:
    1. Variable Name: worktype
    2. Object: WORKORDER
    3. Attribute: WORKTYPE
    4. Type: UPPER
  3. Save the record.

We now have bound the worktype variable to the WORKORDER.WORKTYPE field in Maximo.

The next step is to identify the possible values for your variable(s) and to establish the appropriate KPI targets for each variable value. This is done from both the KPI and Variable Values tables. To continue with our example:

  1. Click the New Row button on the KPI table. You’ll notice a new row has been added to both the KPI and Variable Values tables.
  2. Fill out the following fields in the KPI table:
    1. Target: 10
    2. Caution At: 15
    3. Alert At: 20
    4. Public: Yes
    5. Active: Yes
  3. Fill out the following fields in the Variable Values table:
    1. Value: CM
  4. You can validate the results of the query with variable substitution by clicking the Test Variable button in the KPI table.
  5. Save the record.

Next, perform the same steps as many times as you have variable values. In our example, we’ll create similar variables for EM and PM. Note that each time you click the New Row button in the KPI table, Maximo will automatically copy the values from the previous variable value. Highlight the appropriate KPI row to update your Variable Values.

Finally, we can turn our template into a series of KPIs.

  1. From the Select Action menu, choose the Generate KPIs option.
  2. Maximo will prompt you with the results. Press the OK button.

You can now navigate to the Administration > KPI > KPI Manager application and see your 3 new KPIs.

Please note that if you make changes to the KPI in the KPI Manager application that you may void the link with the template. Changes such as updating the Description or Select Clause of the KPI will result in the template no longer being able to update the KPI with changes.

To make a change to each KPI go back to your template. Let’s say you want to alter the KPI Query slightly by adding a woclass = ‘WORKORDER’ clause to the query. Simply alter your query, save the record, and choose the Select Action > Generate KPIs option. This action will generate any new variables into new KPIs, but also update existing KPIs.

I hope you enjoy this new application!