ActnblListKeyPrfmIndDef

Represents custom key performance indicators that’re defined for a specific field on an object. This object is available in API version 64.0 and later.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

ActnblListKeyPrfmIndDef components have the suffix .actnblListKeyPrfmIndDef and are stored in the actnblListKeyPrfmIndDefs folder.

Version

ActnblListKeyPrfmIndDef components are available in API version 64.0 and later.

Special Access Rules

This metadata type is available with the Industries Sales Excellence add-on license.

Fields

aggregateOperationName

Field Type: ActionableListKPIAggType (enumeration of type string)
Description: Required. Specifies the name of the aggregate operation associated with the custom key performance indicator.
Possible values:
- AVG
- COUNT
- MAX
- MIN
- SUM

description

Field Type: string
Description: Description of the custom key performance indicator.

fieldName

Field Type: string
Description: Required. The field on which the operation associated with the custom key performance indicator is performed.

filterExpression

Field Type: string
Description: Filters associated with the field on which the operation is performed.

masterLabel

Field Type: string
Description: Required. Controlling label for this actionable list key performance indicator definition.

objectName

Field Type: string
Description: Required. The object associated with the custom key performance indicator.

status

Field Type: ActionableListKPIStType (enumeration of type string)
Description: Required. Specifies the status of the custom key performance indicator.
Possible values:
- ACTIVE
- INACTIVE

Declarative Metadata Sample Definition

The following is an example of an ActnblListKeyPrfmIndDef component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ActnblListKeyPrfmIndDef xmlns="http://soap.sforce.com/2006/04/metadata">
3    <masterLabel>Total Revenue</masterLabel>
4    <description>Total Revenue</description>
5    <objectName>ACCOUNT</objectName>
6    <aggregateOperationName>SUM</aggregateOperationName>
7    <fieldName>AnnualRevenue</fieldName>
8    <filterExpression></filterExpression>
9    <status>ACTIVE</status>
10</ActnblListKeyPrfmIndDef>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>ActnblListKeyPrfmIndDef</name>
6    </types>
7    <version>68.0</version>
8</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.