ForecastingFilterCondition | Metadata API Developer Guide

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

ForecastingFilterCondition components have the suffix .ForecastingFilterCondition and are stored in the ForecastingFilterConditions folder.

Version

ForecastingFilterCondition 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
fieldName	Field Type string Description Required. The name of the opportunity field to be filtered.
forecastingFilter	Field Type string Description Required. The ID of the forecast filter.
forecastingSourceDefinition	Field Type string Description The ID of the forecasting source definition.
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.
operation	Field Type FilterOperation (enumeration of type string) Description Required. The operator in the filter condition. Possible values are: `equals` `greaterOrEqual`—greater than or equal to `greaterThan` `lessOrEqual`—less than or equal to `lessThan` `notEqual`—not equal to
sortOrder	Field Type int Description Required. The index value for the condition. This value represents the condition in the FilterLogic field on the ForecastingFilter object. For example, `1`.
value	Field Type string Description The value of the filter condition. If multiple values are specified, they must be separated by a comma delimiter. If you have multiple currencies enabled, and add a custom filter on a currency field as part of your forecast type definition, the corporate currency at the time the filter was created is used. If you have a single currency enabled, the absolute value is used in your filter condition. Note

Declarative Metadata Sample Definition

The following is an example of a ForecastingFilterCondition component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ForecastingFilterCondition xmlns="http://soap.sforce.com/2006/04/metadata">
3    <colName>mostlikely</colName>
4    <fieldName>Amount</fieldName>
5    <forecastingFilter>d</forecastingFilter>
6    <forecastingSourceDefinition>d7</forecastingSourceDefinition>
7    <masterLabel>FFC_Opportunity</masterLabel>
8    <operation>greaterThan</masterLabel>
9    <sortOrder>1</masterLabel>
10    <value>100000</value>
11</ForecastingFilterCondition>

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>ForecastingFilterCondition</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.

Usage

A forecast type can contain up to three filter conditions.