Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

PipelineInspMetricConfig

Represents the settings of Pipeline Inspection forecast category metrics.

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

PipelineInspMetricConfig components have the suffix .pipelineInspMetricConfig and are stored in the pipelineInspMetricConfigs folder.

Version

PipelineInspMetricConfig components are available in API version 57.0 and later.

Special Access Rules

Only users with the Customize Application or Modify All Data permission can access this type.

Fields

Field Name	Description
isCumulative	Field Type boolean Description Required. Read only. Indicates whether the metric is cumulative (`true`) or not (`false`). The default value is `true`.
isProtected	Field Type boolean Description Indicates whether the component is protected (`true`) or not (`false`). The default value is `false`.
masterLabel	Field Type string Description Required. Customized label of the Pipeline Inspection metric. Limit: 50 characters.
metric	Field Type PipelineInspectionMetric (enumeration of type string) Description Required. The Pipeline Inspection metric. Possible values are: `BestCase` (available in API version 58.0 and later) `ClosedLost` (available in API version 58.0 and later) `ClosedWon` (available in API version 58.0 and later) `Commit` (available in API version 58.0 and later) `MostLikely` (available in API version 58.0 and later) `OpenPipeline` (available in API version 58.0 and later) `TotalPipeline` (available in API version 58.0 and later)

Declarative Metadata Sample Definition

The following is an example of a PipelineInspMetricConfig component.

1<?xml version="1.0" encoding="UTF-8"?>
2<PipelineInspMetricConfig xmlns="http://soap.sforce.com/2006/04/metadata">
3    <isCumulative>true</isCumulative>
4    <isProtected>false</isProtected>
5    <masterLabel>Lost the opportunity</masterLabel>
6    <metric>ClosedLost</metric>
7
8</PipelineInspMetricConfig>

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>PipelineInspMetricConfig</name>
6    </types>
7    <version>57.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.

Metadata API Developer Guide