Metadata API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
ForecastingType
Parent Type
This type extends the Metadata metadata type and inherits its
fullName field.
File Suffix and Directory Location
ForecastingType components have the suffix .forecastingType and are stored in the forecastingTypes folder.
Version
ForecastingType components are available in API version 52.0 and later.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| active | boolean | Required. If true, the forecast type is active. If false, the forecast type isn’t active. The default value is false. |
| amount | boolean | Required. If true, the forecast type is based on a revenue measure. If false, the forecast type is based on a quantity measure. The default value is true. |
| dateType | string | Required. The date type that forecast amounts are based on.
The following values are available in API version 52.0 and later, in Performance Edition and in Unlimited Edition with Sales Cloud.
|
| developerName | string | Required. The name of the forecasting type. The DeveloperName is called name in ForecastingSettings and Forecasting Type in custom reports. |
| forecastingGroupDeveloperName | string | Indicates the forecast group assigned to the forecast type. Required if hasCustomGroup is true. |
| hasCustomGroup | boolean | Indicates whether the forecasting type has a forecast group, based on a custom picklist assigned. Use ForecastingGroup and ForecastingGroupItems subtypes in ForecastingSettings to identify the group and the values. |
| hasProductFamily | boolean | Required. If true, the forecast type includes product families. If false, the forecast type doesn’t include product families. The default value is false. |
| masterLabel | string | Required. Controlling label for this ForecastingType value. This display value is the internal label that doesn’t get translated. |
| opportunitySplitType | string | Indicates whether the forecasting type has a split type and, if so, the name of the split type. |
| opptyLineItemSplitType | string | Indicates whether the forecasting type has an opportunity line item (product) split type and, if so, the name of the line item split type. Available in API version 58.0 and later. |
| quantity | boolean | Required. If true, the forecast type is based on a quantity measure. If false, the forecast type is based on a revenue measure. The default value is false. |
| roleType | string | Required. Indicates whether the role type has a ForecastingType, and if so, which ForecastingType. Possible values are R (user role-based forecast type) and Y (Territory2-based forecast type). |
| territory2Model | string | Indicates whether the ForecastingType has a Territory2 model and, if so, the name of the Territory2 model. |
Declarative Metadata Sample Definition
The following is an example of a ForecastingType component using the role hierarchy.
<?xml version="1.0" encoding="UTF-8"?>
<ForecastingType xmlns="http://soap.sforce.com/2006/04/metadata">
<active>false</active>
<amount>true</amount>
<dateType>0</dateType>
<developerName>qqw</developerName>
<hasProductFamily>false</hasProductFamily>
<masterLabel>qqw</masterLabel>
<quantity>false</quantity>
<roleType>R</roleType>
</ForecastingType>The following is an example of a ForecastingType component using the territory hierarchy.
<?xml version="1.0" encoding="UTF-8"?>
<ForecastingType xmlns="http://soap.sforce.com/2006/04/metadata">
<active>false</active>
<amount>false</amount>
<dateType>0</dateType>
<developerName>New_Model6</developerName>
<hasProductFamily>false</hasProductFamily>
<masterLabel>Opportunity Quantity by Territory</masterLabel>
<quantity>true</quantity>
<roleType>Y</roleType>
<territory2Model>New_Model6</territory2Model>
</ForecastingType>The following is an example of a ForecastingType component using an opportunity split type.
<?xml version="1.0" encoding="UTF-8"?>
<ForecastingType xmlns="http://soap.sforce.com/2006/04/metadata">
<active>false</active>
<amount>true</amount>
<dateType>0</dateType>
<developerName>split12</developerName>
<hasProductFamily>false</hasProductFamily>
<masterLabel>split12</masterLabel>
<opportunitySplitType>Custom_Revenue</opportunitySplitType>
<quantity>false</quantity>
<roleType>R</roleType>
</ForecastingType>The following is an example of a ForecastingType component using an opportunity line item split type.
<?xml version="1.0" encoding="UTF-8"?>
<ForecastingType xmlns="http://soap.sforce.com/2006/04/metadata">
<active>true</active>
<amount>true</amount>
<dateType>0</dateType>
<developerName>productrevenuesplit</developerName>
<hasProductFamily>true</hasProductFamily>
<masterLabel>productrevenuesplit</masterLabel>
<opportunitySplitType>Revenue</opportunitySplitType>
<opptyLineItemSplitType>Revenue</opptyLineItemSplitType>
<quantity>false</quantity>
<roleType>R</roleType>
</ForecastingType>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>ForecastingType</name>
</types>
<version>52.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.
Usage
- Legacy forecast types that were available before API version 52.0 can be deactivated but not activated, created, or deleted.
- Forecast types that are available only in API version 52.0 and later can be created, activated, deactivated, and deleted. If the forecast type doesn’t exist, it’s created in the inactive state. If the forecast type exists, the active flag is updated. Deploy the zip file twice to create and activate the forecast type.
- Deploy Metadata API types in this sequence: ForecastingSettings, ForecastingType, ForecastingSourceDefinition, and then ForecastingTypeSource. If all are specified in the package file, the sequence is followed automatically.