---
schema_version: "1"
id: 877964f2b7e517373da1f673ad27a24b95870eff57917b0b13979b313d8e3577
title: ForecastingObjectListSettings
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_forecastingobjectlistsettings.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_forecastingobjectlistsettings.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 2d35d898dd16d73e46a588792cd9a7a01303ceea42ab2cc105cf2849879b4fc2
description: 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.
---
# 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") 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.

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

#### Note

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

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| forecastingTypeObjectListSettings | [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](#forecastingObjectListLabelMapping) | Mapping of labels with each field displayed as a column in the object detail list on the forecasts page. |
| forecastingObjectListSelectedSettings | [forecastingObjectListSelectedSettings](#forecastingObjectListSelectedSettings) | Specifies the object fields that are used as columns in the object detail list on the forecasts page. |
| forecastingObjectListUnselectedSettings | [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:

<?xml version="1.0" encoding="UTF-8"?>
<ForecastingObjectListSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <forecastingTypeObjectListSettings\>
        <forecastingObjectListLabelMappings\>
            <field\>CREATEDBY\_USER.ALIAS</field\>
            <label\>Created By Alias</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.AMOUNT</field\>
            <label\>Amount</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.CLOSE\_DATE</field\>
            <label\>Close Date</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.TYPE</field\>
            <label\>Type</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.CREATED\_DATE</field\>
            <label\>Created Date</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.LAST\_UPDATE</field\>
            <label\>Last Modified Date</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.LEAD\_SOURCE</field\>
            <label\>Lead Source</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.EXP\_AMOUNT</field\>
            <label\>Expected Revenue</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.CLOSED</field\>
            <label\>Closed</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.WON</field\>
            <label\>Won</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>00Nxx000001G2W0</field\>
            <label\>CustomOppCurr</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>CORE.USERS.ALIAS</field\>
            <label\>Opportunity Owner Alias</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.PROBABILITY</field\>
            <label\>Probability (%)</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.LAST\_ACTIVITY</field\>
            <label\>Last Activity</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.FISCAL\_QUARTER</field\>
            <label\>Fiscal Quarter</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>00Nxx000001G8GS</field\>
            <label\>TaraTestOppCurr</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>DESCRIPTION</field\>
            <label\>Description</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.FISCAL\_PERIOD</field\>
            <label\>Fiscal Period</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>FULL\_NAME</field\>
            <label\>Owner Full Name</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.NEXT\_STEP</field\>
            <label\>Next Step</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>UPDATEDBY\_USER.ALIAS</field\>
            <label\>Last Modified By Alias</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.STAGE\_NAME</field\>
            <label\>Stage</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>CONTRACT.NAME</field\>
            <label\>Contract Name</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.QUANTITY</field\>
            <label\>Quantity</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>SPLITAMOUNT</field\>
            <label\>Forecasted Amount</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.NAME</field\>
            <label\>Opportunity Name</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>CORE.USERS.LAST\_NAME</field\>
            <label\>Owner Last Name</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.FISCAL\_YEAR</field\>
            <label\>Fiscal Year</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>TERR2\_NAME</field\>
            <label\>Territory Name</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>CORE.USERS.FIRST\_NAME</field\>
            <label\>Owner First Name</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>ACCOUNT.SITE</field\>
            <label\>Account Site</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>ACCOUNT.NAME</field\>
            <label\>Account Name</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>OPPORTUNITY.PRIVATE</field\>
            <label\>Private</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>TERR2\_DESC</field\>
            <label\>Territory Description</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>CONTRACT.CONTRACT\_NUMBER</field\>
            <label\>Contract Number</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListLabelMappings\>
            <field\>FORECAST\_CATEGORY</field\>
            <label\>Forecast Category</label\>
        </forecastingObjectListLabelMappings\>
        <forecastingObjectListSelectedSettings\>
            <field\>OPPORTUNITY.NAME</field\>
        </forecastingObjectListSelectedSettings\>
        <forecastingObjectListUnselectedSettings\>
            <field\>ACCOUNT.NAME</field\>
            <field\>CONTRACT.CONTRACT\_NUMBER</field\>
            <field\>CONTRACT.NAME</field\>
            <field\>OPPORTUNITY.STAGE\_NAME</field\>
            <field\>FORECAST\_CATEGORY</field\>
            <field\>OPPORTUNITY.CLOSE\_DATE</field\>
            <field\>OPPORTUNITY.AMOUNT</field\>
            <field\>CORE.USERS.ALIAS</field\>
            <field\>CORE.USERS.FIRST\_NAME</field\>
            <field\>CORE.USERS.LAST\_NAME</field\>
            <field\>FULL\_NAME</field\>
            <field\>OPPORTUNITY.PROBABILITY</field\>
            <field\>DESCRIPTION</field\>
            <field\>OPPORTUNITY.EXP\_AMOUNT</field\>
            <field\>OPPORTUNITY.LEAD\_SOURCE</field\>
            <field\>OPPORTUNITY.NEXT\_STEP</field\>
            <field\>OPPORTUNITY.PRIVATE</field\>
            <field\>OPPORTUNITY.QUANTITY</field\>
            <field\>OPPORTUNITY.TYPE</field\>
            <field\>UPDATEDBY\_USER.ALIAS</field\>
            <field\>CREATEDBY\_USER.ALIAS</field\>
            <field\>OPPORTUNITY.CLOSED</field\>
            <field\>OPPORTUNITY.WON</field\>
            <field\>ACCOUNT.SITE</field\>
            <field\>OPPORTUNITY.FISCAL\_YEAR</field\>
            <field\>OPPORTUNITY.FISCAL\_QUARTER</field\>
            <field\>OPPORTUNITY.FISCAL\_PERIOD</field\>
            <field\>OPPORTUNITY.LAST\_ACTIVITY</field\>
            <field\>OPPORTUNITY.CREATED\_DATE</field\>
            <field\>OPPORTUNITY.LAST\_UPDATE</field\>
            <field\>SPLITAMOUNT</field\>
            <field\>00Nxx000001G2W0</field\>
            <field\>00Nxx000001G8GS</field\>
            <field\>TERR2\_NAME</field\>
            <field\>TERR2\_DESC</field\>
        </forecastingObjectListUnselectedSettings\>
        <forecastingTypeDeveloperName\>OpportunityLineItemRevenue</forecastingTypeDeveloperName\>
    </forecastingTypeObjectListSettings\>

## Example Package Manifest

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

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
	<types\>
		<members\>ForecastingObjectListSettings</members\>
		<name\>Settings</name\>
	</types\>
	<version\>52.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).