Specific Widgets: KPI Widgets

A KPI widget is a ticker that will give you an immediate overview of a particular key performance indicator (KPI). In MYOB Acumatica, you can configure a scorecard, meter, or trend card widget to track KPI.

Applicable Scenarios

You use KPI widgets to show any of the following:

  • Single parameters that are critical for particular business processes in your organization, such the number of new support cases from customers
  • Progress against a key business indicator, such as the current number of deals against the goal number
  • A trend of metrics that change over time, such as the total sum of closed deals in the current month in comparison to the sum in the previous month, so you can see if it is increasing or decreasing

Data Source for KPI Widgets

The source of the calculation of a KPI is data collected by an inquiry from the system database. You select a source inquiry in the Inquiry Screen box of the Widget Properties dialog box for a KPI widget (see Item 1 in the screenshot below). You can use a predefined inquiry or develop one that suits your needs by using the Generic Inquiry (SM208000) form.

Each column of a generic inquiry is a data field configured in the inquiry settings. It can be a data field from an existing database table or a custom data field whose value is calculated by the system based on the formula specified for this field in the generic inquiry.

By using data fields from the generic inquiry specified as a source for the widget you are configuring, you define the metric to track with the widget in the Field to Aggregate box (Item 2). Also, you can use data fields to define thresholds of KPI if you select the Inquiry Field option in the Normal Level Type or Alarm Level Type box (Item 3).

Figure 1. The settings of a KPI widget where a user can use data fields of a source inquiry


Operations Used to Calculate a KPI

A KPI is a measurement that evaluates the performance of a business activity. To measure the business activity, you need to define the data field and the operation to perform upon the values provided by the field.

In the Widget Properties dialog box for a KPI widget, you specify a data field by selecting a column from the source generic inquiry in the Field to Aggregate box. In the Aggregate Function box, you select one of the following operations:

  • Average: Calculates the average value in the column.
  • Count All (default value): Determines the number of unique items in the column.
  • Max: Determines the highest individual value in the column. For text data, the highest value is the last alphabetic value. This function ignores null values.
  • Min: Determines the lowest individual value in the column. For text data, the lowest value is the first alphabetic value. This function ignores null values.
  • Sum: Calculates the sum of the items in the column.

The system performs the selected operation on the data from the specified column and displays the result on the KPI widget.

Threshold Values of KPI Widgets

To measure the performance of a business activity, you need to define thresholds that help you gauge success and failure (that is, what number is considered to be successful performance and what number is considered unsuccessful).

In MYOB Acumatica, a KPI value can be placed in any of the following ranges: normal, warning, and alarm. In the Widget Properties dialog box for a KPI widget, you can define the upper bound of the normal range (the Normal Level or Normal Level Field box) and the lower bound of the alarm range (the Alarm Level or Alarm Level Field box). The system calculates the warning range as the difference between these two values. You can identify the ranges on a widget by the colors assigned to each range.

To define the upper bound of the normal range or the lower bound of the alarm range, you should first select a source type for the thresholds and then specify the values that will indicate bounds. The following source types are available:

  • Fixed Value: The value to be specified for the level is any positive or negative integer or decimal number.
  • Inquiry Field: The value to be specified for the level is any inquiry field (that is, any field represented by a column in the results grid of the inquiry form selected in the Inquiry Screen box) that contains numeric values. The system adds up the values in the column of the specified field. That is, it uses the SUM operation for the returned results.
  • Percent Value: The value to be specified for the level is any positive or negative integer or fractional number that represents the percent value (without %). If the percent value is specified for the normal level, the system calculates it as the percentage of the value specified for alarm level. If the percent value is specified for the alarm level, the system calculates it as the percentage of the value specified for the normal level. Thus, you can select this option as a source either for the normal level or for the alarm level.

You select a source type for both the normal level (success) and the alarm level (failure) and then specify the exact values. You can select different source types for both levels if it works for your KPI.

Background Colors of KPI Widgets

The background color of the KPI widgets is used to convey the trend of the KPI. The color helps viewers to instantly understand whether immediate action is needed or the KPI is under control.

In MYOB Acumatica, you can specify colors for the normal, warning, or alarm levels for the scorecard and meter widgets. Similarly, for a trend card, you can specify the colors that indicate whether a trend is rising, flat, or falling.

If a number you are tracking is for informational purposes only and its change does not require any action, you can specify the same color for all three KPI positions.

Visual Representation of Ranges

When you have specified the source and the values for the upper bound of the normal range and the lower bound of the alarm range and you have assigned colors to each range, the system calculates the bounds for each range and shows them on the widget.

Suppose that in the Widget Properties dialog box, you have assigned the colors to the ranges as follows:

  • Normal Color: Green
  • Warning Color: Yellow
  • Alarm Color: Red

If the Normal Level value specified in the Widget Properties dialog box is a positive number and less than the Alarm Level value, then the system defines the bounds for each range as follows:

  • Normal range: From zero to the Normal Level value
  • Warning range: From the Normal Level value to the Alarm Level value
  • Alarm range: From the Alarm Level value to the Alarm Level value plus 20 percent of the sum of the Normal Level value and the Alarm Level value

Suppose that the Normal Level value is 25 and the Alarm Level value is 50. The system will calculate the ranges as shown in the following screenshot.

Figure 2. Range placement if the Normal Level value is positive and less than the Alarm Level value


If the Normal Level value is a negative number and less than the Alarm Level value, the system defines the bounds for each range as follows:

  • Normal range: From the Normal Level value plus 20 percent of the range between the Normal Level value and the Alarm Level value to the Normal Level value
  • Warning range: From the Normal Level value to the Alarm Level value
  • Alarm range: From the Alarm Level value to the Alarm Level value plus 20 percent of the range between the Normal Level value and the Alarm Level value

Suppose that the Normal Level value is minus 25 and the Alarm Level value is 50. The system will calculate the ranges as shown in the following screenshot.

Figure 3. Range placement if the Normal Level value is negative and less than the Alarm Level value


If the Normal Level value is a positive number and larger than the Alarm Level value, the system defines the bounds for each range as follows:

  • Normal range: From the Normal Level value to the Normal Level value minus 20 percent of the sum of the Normal Level value and the Alarm Level value
  • Warning range: From the Alarm Level value to the Normal Level value
  • Alarm range: From zero to the Alarm Level value

Suppose that the Normal Level value is 75 and the Alarm Level value is 35. The system will calculate the ranges as shown in the following screenshot.

Figure 4. Range placement if the Alarm Level value is less than the Normal Level value


Scorecard Widget

A scorecard is a rectangle with a number and title in the upper right corner. Optionally, it can display an icon of your choice in the upper left corner and a different background color to indicate a change in the value it is showing.

A scorecard widget is useful when you need to monitor single parameters that are critical for particular business processes in your organization. For example, a scorecard can display the number of new support cases from customers. For an example of a scorecard KPI widget, see the following screenshot.

Figure 5. Scorecard KPI widget


To add a scorecard widget, you select the Key Performance Indicator (KPI) widget type in the Add Widget dialog box, which opens when you click Add a New Widget in a widget placeholder. You specify the following information in the Widget Properties dialog box:

  • The inquiry to provide data for the widget
  • The column from the inquiry to be used for calculation
  • The operation to perform with the column values
  • The normal and alarm level types
  • The threshold values for normal and alarm levels
  • The colors for the widget background based on the level

The following screenshot shows an example of the configuration of a scorecard that displays the current number of open opportunities in the system.

Figure 6. Properties of a scorecard widget


Meter Widget

A meter widget uses a needle and colors to show data similarly to a reading on a speedometer. Meters are useful when you need to monitor all levels of the data (normal, warning, and alarm), with the colors and values that the user designing the widget has assigned to each level. For an example of a meter KPI widget, see the following screenshot.

Figure 7. Meter KPI widget


The system builds the view of each widget automatically, based on the properties specified for the widget in the Widget Properties dialog box. If the numbers defining the ranges of the normal, warning, and alarm levels (for the selected field of the specified form) are positive, then the starting point of the meter is 0; if any number defining the levels is negative, then the starting point of the gauge is a negative number.

You configure the widget in the same way as you configure a scorecard widget, except that you select the Meter option in the Visualization Type box of the Widget Properties dialog box.

Trend Card Widget

The KPI values to be displayed on the trend card KPI widget are calculated based on the selected period, the aggregate function, and the current business date.

Attention: The source inquiry should include a date parameter to be used by the system for the calculation of a trend.

For example, suppose that you want to display the number of support cases and compare it with the number in the previous month on the trend card KPI widget. The inquiry should include the date when a case was created. By using this date, the system will calculate the number of cases created during a particular period of time. Further suppose that the current business date is July 14, 2024. To find the current KPI value, the system counts the number of cases from July 1, 2024, to July 14, 2024. To find the difference, the system counts the number of cases in the previous calendar month—from June 1, 2024, to June 14, 2024—and calculates the difference between the current value and the previous one. Then the absolute difference, the difference expressed as a percent, and the current number of cases are displayed on the widget.

The following screenshot shows an example of a trend card KPI widget and its elements.

Figure 8. Trend card widget


The trend card widget consists of the following parts:

  1. An arrow that shows whether the trend is rising or falling
  2. The difference in the percent between the current KPI value and the previous one
  3. The current KPI value
  4. The difference between the current KPI value and the previous one
  5. The trend card title (caption)

The color of the background indicates whether a trend is rising, falling, or flat.

To add a trend card widget, you select the Trend Card KPI widget type in the Add Widget dialog box, which opens when you click Add a New Widget in a widget placeholder. You specify the following settings in the Widget Properties dialog box:

  • The inquiry form to provide data for the dashboard
  • The column from the inquiry to be used for calculation
  • The operation to perform with the column values to calculate the KPI
  • The timeline field from the inquiry to provide data about dates
  • The period for comparison
  • The trend name, which is displayed in all capital letters on the card
  • The colors for the widget background based on the trend direction

The following screenshot shows an example of the configuration of the trend card widget to calculate the number of created cases in a month in comparison to the previous month.

Figure 9. Properties of a trend card widget