Previous Topic: SQL KPIs

Next Topic: Retrieve Ticket Data

KPI Fields

The following table describes the KPI fields. The Sys. S.Q. and SQL columns indicate the KPI types each field belongs to (System, Stored Query, or SQL).

Note: All fields are required unless specified as optional.

Field

Sys.

S.Q.

SQL

Description

KPI Name

X

X

X

Identifies the display name for the KPI. Not editable.

Type

X

X

X

Defines the record as a System, Stored Query, or SQL KPI. Not editable.

Keep Existing Version

X

X

X

Specifies that the current version of the KPI record will be retained if the record is updated. Editable when the @NX_ALWAYS_KEEP_KPI_VERSIONS setting in the NX.env is set to No.

Version

X

X

X

Identifies the version number of the KPI record. The version number is incremented automatically each time the record is updated. Not editable.

Record Status

X

X

X

Specifies whether the KPI is active (gathering data) or inactive (not gathering data). Editable only by using the "Edit in List" feature on the KPI List page.

Metric Type

X

X

X

Specifies the type of calculation the KPI will perform:

  • Stored Query KPIs are always Count.
  • System KPIs can be Count or Duration.
  • SQL KPIs can be Count, Sum, Max, or Duration.

Editable for SQL type KPI only.

Refresh
Time

X

X

X

Specifies the time interval for retrieving KPI metrics from the database. The value is editable. Refresh time is specified in HH:MM:SS format.

Process
Type

X

 

 

System KPI metrics can be derived from the following CA SDM processes:

  • domsrvr—Object Manager
  • bpvirtdb—BOP Virtual Database Server
  • db_agents—Database agents
  • webengine—The CA SDM web client

System
Name

X

 

 

The internal name of the System KPI. Not editable.

User
Context

 

X

X

(Optional) Specifies the userid of a CA SDM contact. The contact's role and tenant assignments are used to determine data partitioning for the metrics produced by the KPI. The value is editable.

Stored
Query

 

X

 

The name of the stored query called by this KPI. The value is editable.

SQL
Query

 

 

X

The SQL code for the query. The value is editable.

Description

X

X

X

(Optional) Provides a detailed description of the KPI. The value is editable.