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.

ForecastingFilter

Represents the custom filter for including or excluding data from opportunity forecasts.

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

ForecastingFilter components have the suffix .forecastingFilter and are stored in the forecastingFilters folder.

Version

ForecastingFilter components are available in API version 55.0 and later.

Special Access Rules

There are no additional access requirements that are specific to this type.

Fields

Field Name	Description
filterLogic	Field Type string Description The logic that controls the evaluation of conditions. Only `AND` is supported. For example, `1 AND 2 AND 3`.
forecastingType	Field Type string Description Required. The ID of the forecast type. Can be linked only to forecast types created in Summer ’21 and later.
forecastingTypeSource	Field Type string Description Required. The ID of the forecast type source. Can be linked only to forecast type sources created in Summer ’21 or later and with a forecast source definition with source object of 'Opportunity.'
masterLabel	Field Type string Description Required. The label for this object, which displays in Setup. The label is in the default language locale for the organization. If there’s no default language locale, the label is in en_US.

Declarative Metadata Sample Definition

The following is an example of a ForecastingFilter component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ForecastingFilter xmlns="http://soap.sforce.com/2006/04/metadata">
3    <filterLogic>1 AND 2</filterLogic>
4    <forecastingType>d</forecastingType>
5    <forecastingTypeSource>d7</forecastingTypeSource>
6    <masterLabel>FF_OpportunityLineItem</masterLabel>
7</ForecastingFilter>

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>ForecastingFilter</name>
6    </types>
7    <version>55.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