ForecastingObjectListSettings

Represents an org’s forecasting object list settings. Use these settings to control which object types and field types appear in the list of object details on the forecasts page. For example, pipeline forecasts use the Opportunity object, and the object list settings specify which fields from that object are available in the opportunity list section of the forecasts page. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See Settings for details.

File Suffix and Directory Location

ForecastingObjectListSettings values are stored in the ForecastingObjectList.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

Version

ForecastingObjectListSettings is available in API versions 52.0 and later.

The information in this topic applies only to forecast types created in Summer ’21 and later.

Note

Fields

Field Name	Field Type	Description
forecastingTypeObjectListSettings	ForecastingTypeObjectListSettings	For each forecast type, specifies the information that is displayed in the list of object details that roll up into the forecasts. For example, the list of opportunities rolls up into opportunity-based forecasts.

ForecastingTypeObjectListSettings

Represents an org’s forecasting type object list settings.

Field Name	Field Type	Description
forecastingObjectListLabelMappings	ForecastingObjectListLabelMapping	Mapping of labels with each field displayed as a column in the object detail list on the forecasts page.
forecastingObjectListSelectedSettings	forecastingObjectListSelectedSettings	Specifies the object fields that are used as columns in the object detail list on the forecasts page.
forecastingObjectListUnselectedSettings	forecastingObjectListUnselectedSettings	Lists the object fields that are available but not currently used as columns in the object detail list on the forecasts page. Changes to forecastingObjectListSelectedSettings field are reflected in this field.
forecastingTypeDeveloperName	string	Developer name of the forecast type that these object list settings apply to.

ForecastingObjectListLabelMapping

Represents an org’s forecasting type object list label mapping.

Field Name	Field Type	Description
field	string	Object field’s API name.
label	string	Object field’s name in the object detail list on the forecasts page.

forecastingObjectListSelectedSettings

Represents an org’s forecasting type object list selected settings.

Field Name	Field Type	Description
field	string	Object field’s API name.

forecastingObjectListUnselectedSettings

Represents an org’s forecasting type object list unselected settings.

Field Name	Field Type	Description
field	string	Object field’s API name.

Declarative Metadata Sample Definition

The following is an example of the ForecastingObjectListSettings.settings file:

1<?xml version="1.0" encoding="UTF-8"?>
2<ForecastingObjectListSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <forecastingTypeObjectListSettings>
4        <forecastingObjectListLabelMappings>
5            <field>CREATEDBY_USER.ALIAS</field>
6            <label>Created By Alias</label>
7        </forecastingObjectListLabelMappings>
8        <forecastingObjectListLabelMappings>
9            <field>OPPORTUNITY.AMOUNT</field>
10            <label>Amount</label>
11        </forecastingObjectListLabelMappings>
12        <forecastingObjectListLabelMappings>
13            <field>OPPORTUNITY.CLOSE_DATE</field>
14            <label>Close Date</label>
15        </forecastingObjectListLabelMappings>
16        <forecastingObjectListLabelMappings>
17            <field>OPPORTUNITY.TYPE</field>
18            <label>Type</label>
19        </forecastingObjectListLabelMappings>
20        <forecastingObjectListLabelMappings>
21            <field>OPPORTUNITY.CREATED_DATE</field>
22            <label>Created Date</label>
23        </forecastingObjectListLabelMappings>
24        <forecastingObjectListLabelMappings>
25            <field>OPPORTUNITY.LAST_UPDATE</field>
26            <label>Last Modified Date</label>
27        </forecastingObjectListLabelMappings>
28        <forecastingObjectListLabelMappings>
29            <field>OPPORTUNITY.LEAD_SOURCE</field>
30            <label>Lead Source</label>
31        </forecastingObjectListLabelMappings>
32        <forecastingObjectListLabelMappings>
33            <field>OPPORTUNITY.EXP_AMOUNT</field>
34            <label>Expected Revenue</label>
35        </forecastingObjectListLabelMappings>
36        <forecastingObjectListLabelMappings>
37            <field>OPPORTUNITY.CLOSED</field>
38            <label>Closed</label>
39        </forecastingObjectListLabelMappings>
40        <forecastingObjectListLabelMappings>
41            <field>OPPORTUNITY.WON</field>
42            <label>Won</label>
43        </forecastingObjectListLabelMappings>
44        <forecastingObjectListLabelMappings>
45            <field>00Nxx000001G2W0</field>
46            <label>CustomOppCurr</label>
47        </forecastingObjectListLabelMappings>
48        <forecastingObjectListLabelMappings>
49            <field>CORE.USERS.ALIAS</field>
50            <label>Opportunity Owner Alias</label>
51        </forecastingObjectListLabelMappings>
52        <forecastingObjectListLabelMappings>
53            <field>OPPORTUNITY.PROBABILITY</field>
54            <label>Probability (%)</label>
55        </forecastingObjectListLabelMappings>
56        <forecastingObjectListLabelMappings>
57            <field>OPPORTUNITY.LAST_ACTIVITY</field>
58            <label>Last Activity</label>
59        </forecastingObjectListLabelMappings>
60        <forecastingObjectListLabelMappings>
61            <field>OPPORTUNITY.FISCAL_QUARTER</field>
62            <label>Fiscal Quarter</label>
63        </forecastingObjectListLabelMappings>
64        <forecastingObjectListLabelMappings>
65            <field>00Nxx000001G8GS</field>
66            <label>TaraTestOppCurr</label>
67        </forecastingObjectListLabelMappings>
68        <forecastingObjectListLabelMappings>
69            <field>DESCRIPTION</field>
70            <label>Description</label>
71        </forecastingObjectListLabelMappings>
72        <forecastingObjectListLabelMappings>
73            <field>OPPORTUNITY.FISCAL_PERIOD</field>
74            <label>Fiscal Period</label>
75        </forecastingObjectListLabelMappings>
76        <forecastingObjectListLabelMappings>
77            <field>FULL_NAME</field>
78            <label>Owner Full Name</label>
79        </forecastingObjectListLabelMappings>
80        <forecastingObjectListLabelMappings>
81            <field>OPPORTUNITY.NEXT_STEP</field>
82            <label>Next Step</label>
83        </forecastingObjectListLabelMappings>
84        <forecastingObjectListLabelMappings>
85            <field>UPDATEDBY_USER.ALIAS</field>
86            <label>Last Modified By Alias</label>
87        </forecastingObjectListLabelMappings>
88        <forecastingObjectListLabelMappings>
89            <field>OPPORTUNITY.STAGE_NAME</field>
90            <label>Stage</label>
91        </forecastingObjectListLabelMappings>
92        <forecastingObjectListLabelMappings>
93            <field>CONTRACT.NAME</field>
94            <label>Contract Name</label>
95        </forecastingObjectListLabelMappings>
96        <forecastingObjectListLabelMappings>
97            <field>OPPORTUNITY.QUANTITY</field>
98            <label>Quantity</label>
99        </forecastingObjectListLabelMappings>
100        <forecastingObjectListLabelMappings>
101            <field>SPLITAMOUNT</field>
102            <label>Forecasted Amount</label>
103        </forecastingObjectListLabelMappings>
104        <forecastingObjectListLabelMappings>
105            <field>OPPORTUNITY.NAME</field>
106            <label>Opportunity Name</label>
107        </forecastingObjectListLabelMappings>
108        <forecastingObjectListLabelMappings>
109            <field>CORE.USERS.LAST_NAME</field>
110            <label>Owner Last Name</label>
111        </forecastingObjectListLabelMappings>
112        <forecastingObjectListLabelMappings>
113            <field>OPPORTUNITY.FISCAL_YEAR</field>
114            <label>Fiscal Year</label>
115        </forecastingObjectListLabelMappings>
116        <forecastingObjectListLabelMappings>
117            <field>TERR2_NAME</field>
118            <label>Territory Name</label>
119        </forecastingObjectListLabelMappings>
120        <forecastingObjectListLabelMappings>
121            <field>CORE.USERS.FIRST_NAME</field>
122            <label>Owner First Name</label>
123        </forecastingObjectListLabelMappings>
124        <forecastingObjectListLabelMappings>
125            <field>ACCOUNT.SITE</field>
126            <label>Account Site</label>
127        </forecastingObjectListLabelMappings>
128        <forecastingObjectListLabelMappings>
129            <field>ACCOUNT.NAME</field>
130            <label>Account Name</label>
131        </forecastingObjectListLabelMappings>
132        <forecastingObjectListLabelMappings>
133            <field>OPPORTUNITY.PRIVATE</field>
134            <label>Private</label>
135        </forecastingObjectListLabelMappings>
136        <forecastingObjectListLabelMappings>
137            <field>TERR2_DESC</field>
138            <label>Territory Description</label>
139        </forecastingObjectListLabelMappings>
140        <forecastingObjectListLabelMappings>
141            <field>CONTRACT.CONTRACT_NUMBER</field>
142            <label>Contract Number</label>
143        </forecastingObjectListLabelMappings>
144        <forecastingObjectListLabelMappings>
145            <field>FORECAST_CATEGORY</field>
146            <label>Forecast Category</label>
147        </forecastingObjectListLabelMappings>
148        <forecastingObjectListSelectedSettings>
149            <field>OPPORTUNITY.NAME</field>
150        </forecastingObjectListSelectedSettings>
151        <forecastingObjectListUnselectedSettings>
152            <field>ACCOUNT.NAME</field>
153            <field>CONTRACT.CONTRACT_NUMBER</field>
154            <field>CONTRACT.NAME</field>
155            <field>OPPORTUNITY.STAGE_NAME</field>
156            <field>FORECAST_CATEGORY</field>
157            <field>OPPORTUNITY.CLOSE_DATE</field>
158            <field>OPPORTUNITY.AMOUNT</field>
159            <field>CORE.USERS.ALIAS</field>
160            <field>CORE.USERS.FIRST_NAME</field>
161            <field>CORE.USERS.LAST_NAME</field>
162            <field>FULL_NAME</field>
163            <field>OPPORTUNITY.PROBABILITY</field>
164            <field>DESCRIPTION</field>
165            <field>OPPORTUNITY.EXP_AMOUNT</field>
166            <field>OPPORTUNITY.LEAD_SOURCE</field>
167            <field>OPPORTUNITY.NEXT_STEP</field>
168            <field>OPPORTUNITY.PRIVATE</field>
169            <field>OPPORTUNITY.QUANTITY</field>
170            <field>OPPORTUNITY.TYPE</field>
171            <field>UPDATEDBY_USER.ALIAS</field>
172            <field>CREATEDBY_USER.ALIAS</field>
173            <field>OPPORTUNITY.CLOSED</field>
174            <field>OPPORTUNITY.WON</field>
175            <field>ACCOUNT.SITE</field>
176            <field>OPPORTUNITY.FISCAL_YEAR</field>
177            <field>OPPORTUNITY.FISCAL_QUARTER</field>
178            <field>OPPORTUNITY.FISCAL_PERIOD</field>
179            <field>OPPORTUNITY.LAST_ACTIVITY</field>
180            <field>OPPORTUNITY.CREATED_DATE</field>
181            <field>OPPORTUNITY.LAST_UPDATE</field>
182            <field>SPLITAMOUNT</field>
183            <field>00Nxx000001G2W0</field>
184            <field>00Nxx000001G8GS</field>
185            <field>TERR2_NAME</field>
186            <field>TERR2_DESC</field>
187        </forecastingObjectListUnselectedSettings>
188        <forecastingTypeDeveloperName>OpportunityLineItemRevenue</forecastingTypeDeveloperName>
189    </forecastingTypeObjectListSettings>

Example Package Manifest

The following is an example package manifest used to deploy or retrieve the ForecastingObjectListSettingsSettings settings metadata:

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3	<types>
4		<members>ForecastingObjectListSettings</members>
5		<name>Settings</name>
6	</types>
7	<version>52.0</version>
8</Package>

Wildcard Support in the Manifest File

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide