Metadata API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
EnablementMeasureDefinition
Parent Type
File Suffix and Directory Location
EnablementMeasureDefinition components have the suffix .enablementMeasureDefinition and are stored in the enablementMeasureDefinitions folder.
Version
EnablementMeasureDefinition components are available in API version 61.0 and later.
Special Access Rules
To access Enablement measures, the Design and Deliver Enablement Programs permission is required. This permission is available with the Enablement add-on license.
Fields
| Field Name | Description |
|---|---|
| description |
|
| developerName |
|
| masterLabel |
|
| sourceMeasureObject |
|
| status |
|
EnablementMeasureSourceObjectDefinition
Defines the source object, fields, field values, and calculation method for the job-related activity you’re measuring.
| Field Name | Description |
|---|---|
| aggregateFieldApiName |
|
| aggregateFunction |
|
| dateFieldApiName |
|
| displayFieldApiName |
|
| filterLogic |
|
| filters |
|
| objectApiName |
|
| relatedMeasureObjects |
|
| userFieldApiName |
|
EnablementMeasureFilterDefinition
Represents the fields on the source object or related objects and the corresponding field values that further specify criteria for the activity you’re measuring.
| Field Name | Description |
|---|---|
| fieldApiName |
|
| fieldValue |
|
| operator |
|
| sequenceNumber |
|
EnablementMeasureRelatedObjectDefinition
Represents objects related to the source object. Related objects can further specify criteria for the activity you’re measuring. Related objects can also have additional filters. For example, maybe you’re measuring deals won for a specific product line. In this case, the source object is Opportunity, the related object is Opportunity Product, and the related object can have a filter for the specific product name.
| Field Name | Description |
|---|---|
| filterLogic |
|
| filters |
|
| idFieldApiName |
|
| objectApiName |
|
Declarative Metadata Sample Definition
The following is an example of an EnablementMeasureDefinition component.
<?xml version="1.0" encoding="UTF-8"?>
<EnablementMeasureDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
<description>Total amount in pipeline measure</description>
<developerName>TotalAmountInPipeline</developerName>
<masterLabel>Total Amount in Pipeline</masterLabel>
<status>Draft</status>
<sourceMeasureObject>
<aggregateFieldApiName>Amount</aggregateFieldApiName>
<aggregateFunction>Sum</aggregateFunction>
<dateFieldApiName>CreatedDate</dateFieldApiName>
<displayFieldApiName>Name</displayFieldApiName>
<objectApiName>Opportunity</objectApiName>
<userFieldApiName>OwnerId</userFieldApiName>
<filters>
<fieldApiName>StageName</fieldApiName>
<fieldValue>Closed Won</fieldValue>
<operator>Equals</operator>
<sequenceNumber>1</sequenceNumber>
</filters>
<relatedMeasureObjects>
<objectApiName>OpportunityLineItem</objectApiName>
<idFieldApiName>OpportunityId</idFieldApiName>
<filterLogic>1 OR 2</filterLogic>
<filters>
<fieldApiName>UnitPrice</fieldApiName>
<fieldValue>10000</fieldValue>
<operator>GreaterThan</operator>
<sequenceNumber>1</sequenceNumber>
</filters>
<filters>
<fieldApiName>TotalPrice</fieldApiName>
<fieldValue>10000</fieldValue>
<operator>GreaterThan</operator>
<sequenceNumber>2</sequenceNumber>
</filters>
</relatedMeasureObjects>
</sourceMeasureObject>
</EnablementMeasureDefinition>The following is an example package.xml that references the previous definition.
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>TotalAmountInPipeline</members>
<name>EnablementMeasureDefinition</name>
</types>
<version>61.0</version>
</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.