---
schema_version: "1"
id: 6008b40d6e7b39ccccdfdefa9e3a17e24078c902b9204584b3aeae2788af5381
title: PipelineInspMetricConfig
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_pipelineinspmetricconfig.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_pipelineinspmetricconfig.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 13e4ba4528e633bd32d1afa60ecc6b75a7613cbf4c6ca1346eeea4567aeb220f
description: Represents the settings of Pipeline Inspection forecast category metrics.
---
# PipelineInspMetricConfig

Represents the settings of Pipeline Inspection forecast category metrics.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") 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.

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

</PipelineInspMetricConfig\>

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\>\*</members\>
        <name\>PipelineInspMetricConfig</name\>
    </types\>
    <version\>57.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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").