About KPI tables

Defines a code that uniquely identifies each KPI in the table.

The code can be anything you want, as long as it is unique. For example, you might use a meaningful code format like KPI_ExpenseVar or KPI_ExpenseVar_D42000 (where KPIs are stored by department).

The kind of KPI, either Basic or Status. The kind determines whether the primary KPI value is numeric or a status icon.

If this column is blank, or if it contains any value other than Basic or Status, the KPI kind is interpreted as Legacy. The Legacy kind is for backward-compatibility only, and it displays KPIs using the format and properties supported by KPIs created in 2018.1.

The title of the KPI, displayed at the top of the KPI box.

Optional. The name of an icon to display in the KPI title. Enter any valid icon name, such as fa-dollar. The icon names are the same as the symbol names available for use in Axiom form components such as Formatted Grids. If specified, the symbol displays in the far left of the title, before the title text.

To look up valid icon names, you can use the symbol chooser available for Formatted Grid components. In a form-enabled file, right-click a cell and then choose Insert Formatted Grid Tag > Symbol. Then use the [...] button to the right of the Symbol box to open the Choose Symbol dialog. You can hover your cursor over an icon to see its name.

Optional. The subtitle of the KPI, displayed directly beneath the title.

The primary value to highlight for the KPI, when using the Basic kind. This value displays in large, bold font directly underneath the title. This is the value that you want to draw the most attention to. If you are using the Status kind, this value is ignored and instead the primary value is the StatusSign.

The number format of this value is determined by the value specified in the NumericType column.

Optional. A supporting value to show for the KPI. A label can be defined for this value, using the Value2Label column.

The supporting values can be used to provide additional information about the primary value. For example, if the primary value is a variance, then Value 2 and Value 3 might display the actual and budget numbers used to calculate that variance. Or if the primary value is the actual number, then Value 2 and Value 3 might display the variance and the budget number to provide more context for the actual number. The values displayed are entirely user-definable.

The number format of this value is determined by the value specified in the NumericType column.

Optional. The label for Value 2. The label precedes the value and displays with a colon, such as "Actuals: Value 2". The label should explain what Value 2 represents.

Optional. A supporting value to show for the KPI. A label can be defined for this value, using the Value3Label column. See the description of Value2 for more information.

The number format of this value is determined by the value specified in the NumericType column.

Optional. The label for Value 3. The label precedes the value and displays with a colon, such as "Budget: Value 3". The label should explain what Value 3 represents.

Optional. A supporting value to show for the KPI. A label can be defined for this value, using the Value4Label column. See the description of Value2 for more information.

When using the Basic kind, Value 4 and the chart are interchangeable. You can display either Value 4 or a chart, but not both. If both are defined, the chart takes precedence. When using the Status kind, the chart displays in a different place so you can display both if desired.

The number format of this value is determined by the value specified in the NumericType column.

Optional. The label for Value 4. The label precedes the value and displays with a colon, such as "Forecast: Value 4". The label should explain what Value 4 represents.

Optional. A value that defines the target line for the bullet chart. This value can be omitted if it is not needed.

Optional. A value that defines the actual line for the bullet chart. This value can be omitted if the KPI does not use a bullet chart.

Optional. The maximum value of the bullet chart. The chart target and actual values are represented in relation to this maximum value.

For example, if the actual value is 100 and the maximum value is 1000, then the actual bar will only take up 1/10th of the bullet chart. But if the maximum value is 150, then the actual bar will take up 2/3rds of the bullet chart.

This value is required if you want to display a bullet chart on the KPI. This value should be omitted if you don't want to display a chart at all, or if you want to display a sparkline chart instead by using the SparklineData column.

Optional. A value that illustrates the positive or negative measure of the KPI. This value can be omitted if not needed.

The Delta value displays in either red or green (as determined by the Sign value). The Delta value can be used to show a variance percent or a raw difference value. It can also be used to show the change in value since the last time the primary KPI value was measured.

The number format of this value is determined by the value specified in the DeltaNumericType column.

Optional. Specifies whether the primary KPI value is trending up (positive) or down (negative). Enter either Up or Down. If omitted, Down is assumed.

• If Up, then an up-arrow displays in front of the Delta value. The value, arrow, and the actual bar of the bullet chart display in green.
• If Down, then a down-arrow displays in front of the Delta value. The value, arrow, and the actual bar of the bullet chart display in red.

If the style of the KPI is anything other than white, S1, or blank (transparent), then these items display in white instead of green or red.

If the KPI does not have a defined Delta value, the Sign still determines the color of the bullet chart (if applicable).

Specifies the status of the KPI, when using the Status kind. Enter one of the following: Up, Down, Neutral. The status displays as a colored circle with a positive, neutral, or negative indicator:

Up		Neutral		Down

The green, orange, and red colors are only used when the style of the KPI is white, S1, or blank (transparent). If the box has a background color, then the status circle is white and the indicator uses the same color as the background.

Optional. Specifies a color style to set the background color of the KPI box. By default, the box is transparent.

The following Axiom color styles are supported (specify one per KPI): S1, S6, A11, A51, P5, P6, P7, P9, P10. You can also specify white. When using darker background colors, the text in the KPI automatically adjusts to white.

Optional. Defines a tooltip to display when a user hovers over the button in the top right corner of the KPI box. This applies as follows:

• If you are using the Command column, the tooltip displays for the default three-dots icon.
• If you are using the MenuData column and the KPIMenu data source contains multiple commands, the tooltip displays for the carat icon that opens the menu.
• If you are using the MenuData column and the KPIMenu data source contains one visible command, the tooltip defined for that command displays on the custom icon (instead of this tooltip).

Optional. Specifies a command to execute when the user clicks the icon in the top right corner of the KPI box.

If you want users to be able to execute a command from the KPI box, you can use the Command column or you can use the MenuData column.

• When using Command, you can define a single command to be triggered by a three-dots icon that displays in the top right corner of the box. This option is intended for cases where you only need to provide access to one command, and you don't need a custom icon.
• When using MenuData, you can define one or multiple commands in a separate KPIMenu data source. This option is intended for cases where you need to present multiple command options to the user, or if you need to specify a custom icon for a single command.

The valid entries for the Command column are the same that can be defined for the Command column in the KPIMenu data source. See Executing commands from KPI Panels in Axiom forms or Executing commands from KPI Panels in web reports.

Specifies the numeric type of the values in the value columns (1-4):

• Number
• Currency
• Decimal

This determines the format of these values within the KPI box. If blank, Number is assumed. The Numeric Type defined in the column properties for the individual value columns is not used.

Specifies the numeric type of the value in the Delta column:

• Number
• Currency
• Decimal

This determines the format of the Delta value within the KPI box. If blank, Number is assumed. The Numeric Type defined in the Delta column properties is not used.

Optional. Stores the contents of a KPIMenu data source as an XML string. The XML string is used to render one or more menu items on the KPI box.

In order to generate a valid XML string, the save-to-database file that populates the KPI table must contain a KPIMenu data source, and the MenuData column in the save must contain the syntax [Datasource=DatasourceName]. When the save occurs, Axiom Software reads the contents of the designated KPIMenu data source, creates the XML string, and saves it to the MenuData column in the table.

For more information, see Executing commands from KPI Panels in Axiom forms or Executing commands from KPI Panels in web reports.

Optional. Stores the contents of a specific series in an XYChart data source as an XML string. The XML string is used to render a sparkline chart in the KPI box.

In order to generate a valid XML string, the save-to-database file that populates the KPI table must contain a XYChart data source, and the SparklineData column in the save must contain the syntax [Datasource=DatasourceName;Series=SeriesName]. When the save occurs, Axiom Software reads the contents of the designated series in the XYChart data source, creates the XML string, and saves it to the SparklineData column in the table.

For more information, see Displaying charts in KPI Panels in Axiom forms or Displaying charts in KPI Panels in web reports.

Specifies whether a KPI row is omitted from KPI Panel components (True/False). The default value is False.

You can set this to True in order to temporarily hide a KPI, or to archive a KPI without deleting it.