Metadata API Developer’s Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

ForecastingSettings

Represents the Collaborative Forecasts settings options. It extends the Metadata metadata type and inherits its fullName field.

This information only applies to Collaborative Forecasts.

Note

File Suffix and Directory Location

ForecastingSettings values are stored in a single file named Forecasting.settings in the settings directory of the corresponding package directory. The .settings files are different from other named components, as there is only one settings file for each settings component.

Version

ForecastingSettings components are available in API version 28 and later. The structure of the ForecastingSettings type changed significantly in API version 30.0.

Fields

Field Name Field Type Description
displayCurrency DisplayCurrency (enumeration of type string) The currency for displaying forecasts; either the organization's corporate currency or each forecast owner's personal currency setting. This is the default currency used in Collaborative Forecasts and selected in setup. The selection must be one of the currencies enabled for use in the organization, and only one selection is allowed. The default is Corporate. The valid values are:
  • Corporate
  • Personal
enableForecasts boolean Indicates if Collaborative Forecasts is enabled or not. Set to true to enable Collaborative Forecasts and false to disable the functionality.

Disabling Forecasts can result in data loss. Refer to the online Help before disabling any functionality.

Warning
forecastingTypeSettings ForecastingTypeSettings[] A list of forecast types. For field values, see ForecastingTypeSettings. The maximum number of forecast types is four.

ForecastingTypeSettings

The settings for each forecast type. An organization can have up to 4 forecast types active. Omitting a previously enabled forecast type that has a minimum API version less than or equal to the metadata package version deletes its quota and adjustment data from the organization.

Omitting a forecast type field from the XML can deactivate that forecast type: if the forecast type was available in the release specified by the XML package version, that forecast type is deactivated and its quota and adjustment data are deleted.

Warning

Field Name Field Type Description
active boolean This indicates whether the forecast type specified in the name field is active.

Setting the active field to false purges all forecasting data, adjustments, and quotas for the forecast type. When active is set to true, some values on the Forecasts tab may not appear immediately. An in-process icon appears to indicate that the values are being calculated.

Note
adjustmentsSettings AdjustmentsSettings This enables or disables the Forecasts adjustments option in Forecasts.
forecastRangeSettings ForecastRangeSettings The default periods and range selections in Collaborative Forecasts.
name string The name of the forecast type. Each forecast type requires a specific string.

Valid values include:

  • OpportunityRevenue : Opportunities - Revenue
  • OpportunityQuantity : Opportunities - Quantity
  • OpportunitySplitRevenue : Opportunity Revenue Splits - Revenue
  • OpportunityLineItemRevenue : Product Families - Revenue
  • OpportunityLineItemQuantity : Product Families - Quantity
opportunityListFieldsSelectedSettings OpportunityListFieldsSelectedSettings The fields selected to appear in the opportunity pane of the forecast page for the forecast type. Opportunity Name is required. You can select up to 15 fields.
quotasSettings QuotasSettings This enables or disables the quota option in Forecasts.

AdjustmentsSettings

The adjustment options for Collaborative Forecasts.

Field Field Type Description
enableAdjustments boolean Set to true to enable Collaborative Forecasts adjustments and false to disable them. All forecast types must contain the same enableAdjustments value.

Disabling adjustments results in Collaborative Forecasts adjustment data being purged.

Warning

ForecastRangeSettings

The default periods and range selections in Collaborative Forecasts. Users can forecast up to 12 months or eight quarters in the future or past. In the forecasts page, the period selected by default in the rollup table is the current month or quarter if the forecast range includes the current month or quarter. If not, then the first month or quarter is selected by default in the rollup table instead. All forecast types must contain the same forecastRangeSettings field values.

If you change the period setting from monthly to quarterly or quarterly to monthly, or you change the standard fiscal year, all adjustments and quotas are purged. These changes trigger a forecast recalculation that can take significant time, depending on the quantity of data in your organization.

Warning

Field Field Type Description
beginning int Indicates the beginning month or quarter to display by default.
displaying int Indicates the number of months or quarters to display by default. The maximum number of months is 12 and quarters is 8.
periodType PeriodTypes (enumeration of type string) Indicates what type of period to use. Valid values are:
  • Month
  • Quarter

OpportunityListFieldsSelectedSettings

The fields selected to appear in the opportunity pane of the forecast page for the forecast type. Opportunity Name is required. You can select up to 15 fields.

Field Field Type Description
field string Specifies a field name to display in the opportunity pane.

QuotasSettings

QuotasSettings indicates if quotas is available in Collaborative Forecasts.

Field Field Type Description
showQuotas boolean Set to true to enable quotas. All forecast types must contain the same showQuotas field value.

Declarative Metadata Sample Definition

The following is an example of a ForecastingSettings component that enables the Opportunity-Revenue and Product Family-Quantity forecast types:

1<?xml version="1.0" encoding="UTF-8"?>
2<ForecastingSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <enableForecasts>true</enableForecasts>
4    <forecastingTypeSettings>
5        <active>true</active>
6        <adjustmentsSettings>
7            <enableAdjustments>true</enableAdjustments>
8        </adjustmentsSettings>
9        <name>OpportunityRevenue</name>
10        <forecastRangeSettings>
11            <beginning>0</beginning>
12            <displaying>6</displaying>
13            <periodType>Month</periodType>
14        </forecastRangeSettings>
15        <opportunityListFieldsSelectedSettings>
16            <field>OPPORTUNITY.NAME</field>
17        </opportunityListFieldsSelectedSettings>
18        <quotasSettings>
19            <showQuotas>true</showQuotas>
20        </quotasSettings>
21    </forecastingTypeSettings>
22    <forecastingTypeSettings>
23        <active>false</active>
24        <adjustmentsSettings>
25            <enableAdjustments>true</enableAdjustments>
26        </adjustmentsSettings>
27        <name>OpportunityLineItemQuantity</name>
28        <forecastRangeSettings>
29            <beginning>0</beginning>
30            <displaying>6</displaying>
31            <periodType>Month</periodType>
32        </forecastRangeSettings>
33        <opportunityListFieldsSelectedSettings>
34            <field>OPPORTUNITY.NAME</field>
35        </opportunityListFieldsSelectedSettings>
36        <quotasSettings>
37            <showQuotas>true</showQuotas>
38        </quotasSettings>
39    </forecastingTypeSettings>