PipelineInspMetricConfig

Represents the settings of Pipeline Inspection forecast category metrics.

This type extends Metadata and inherits its fields.

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

Introduced in API version 57.0.

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

• Type: boolean
• Required: Yes
• Description: Required. Read only. Indicates whether the metric is cumulative (true) or not (false). The default value is true.

• Type: boolean
• Required: No
• Description: Indicates whether the component is protected (true) or not (false). The default value is false.

• Type: string
• Required: Yes
• Description: Required. Customized label of the Pipeline Inspection metric. Limit: 50 characters.

• Type: PipelineInspectionMetric (enumeration of type string)
• Required: Yes
• Description: Required. The Pipeline Inspection metric.
• Possible values:
  • 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)

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>

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.