AdvAccountForecastSet

Represents the forecast sets that define the forecast configurations for each business unit or different groups of accounts. With separate forecast sets at account or business unit level, you can focus on account-specific data and manage configuration updates for one business unit without impacting any other business unit’s data.

This type extends Metadata and inherits its fields.

AdvAccountForecastSet components have the suffix .advAccountForecastSet and are stored in the AdvAccountForecastSet folder.

Introduced in API version 53.0.

The advanced account forecasting feature setting for Manufacturing Cloud is required to create an advanced account forecast set.

• Type: string
• Required: No
• Description: The field name for the account in the advanced account forecast fact record.

• Type: AdvAcctFcstCalcFrequency (enumeration of type string)
• Required: No
• Description: The frequency at which the forecast set is recalculated automatically.
• Possible values:
  • Monthly
  • Quarterly
  • Weekly
  • Yearly

• Type: string
• Required: No
• Description: The description of the advanced account forecast set record.

• Type: AdvAcctForecastDimension[]
• Required: No
• Description: The dimensions selected for an advanced account forecast set to categorize the forecast data.

• Type: AdvAcctFrcstDisplayGroup[]
• Required: No
• Description: The information about the groups for the advanced account forecast set measures or dimensions.

• Type: AdvAcctForecastAdjPeriod[]
• Required: No
• Description: The details about the adjustment period of the advanced account forecast values.

• Type: string

• Required: Yes

• Description: Required.

  The API name of the object that contains the advanced forecast fact records.

• Type: AdvAccountForecastFormula[]
• Required: No
• Description: The formulas based on which forecast values are calculated.

• Type: string

• Required: Yes

• Description: Required.

  The name of the advanced account forecast period group record.

• Type: string
• Required: No
• Description: The field name for the forecast quantity in the advanced account forecast fact record.

• Type: string
• Required: No
• Description: The field name for the forecast revenue in the advanced account forecast record.

• Type: string
• Required: No
• Description: The field name for the Forecast Set ID in the advanced account forecast fact record.

• Type: string

• Required: Yes

• Description: Required.

  The name of the advanced account forecast set record.

• Type: string
• Required: No
• Description: The field name for the status in the advanced account forecast fact record.

• Type: string
• Required: No
• Description: The name of the data processing engine (DPE) definition that’s used to generate advanced account forecast fact records.

• Type: AdvAcctForecastMeasureDef[]
• Required: No
• Description: The measures to display in the advanced account forecasts grid for the forecast set.

• Type: string
• Required: No
• Description: The field name for the period in the advanced account forecast fact record.

• Type: string
• Required: No
• Description: The name of the data processing engine definition that’s used to recalculate the advanced account forecast fact records.

• Type: string
• Required: No
• Description: The name of the data processing engine definition that’s used to regenerate the advanced account forecast fact records.

• Type: string
• Required: No
• Description: The data processing engine definition that’s used to generate the rollover advanced account forecast fact records.

• Type: AdvAcctFcstCalcFrequency (enumeration of type string)
• Required: No
• Description: The frequency of rollover of the advanced account forecast records.
• Possible values:
  • Monthly
  • Quarterly
  • Weekly
  • Yearly

• Type: AdvAccForecastSetStatus (enumeration of type string)

• Required: Yes

• Description: Required.

  The status of the advanced account forecast set.

• Possible values:

  • Active
  • Inactive

Represents the formulas that are used to calculate forecast values in real time after applying the DPE calculations. For example, processing forecast rollover for all accounts at the start of a month.

• Type: int

• Required: Yes

• Description: Required.

  The period until when the forecast formula is applicable.

• Type: string

• Required: Yes

• Description: Required.

  The formula based on which forecast values are calculated.

• Type: AdvAcctFcstFormulaType (enumeration of type string)

• Required: Yes

• Description: Required.

  Specifies the calculation type for the formula.

• Possible values:

  • QUANTITY
  • REVENUE

• Type: int

• Required: Yes

• Description: Required.

  The period from when the forecast formula is applicable.

Represents details about the adjustment period of the advanced account forecast values.

• Type: int

• Required: Yes

• Description: Required.

  The number of days during which you can make forecast adjustments.

• Type: PeriodTypes (enumeration of type string)

• Required: Yes

• Description: Required.

  The frequency that’s applicable to make any forecast adjustments.

• Possible values:

  • Month
  • Quarter
  • Week
  • Year

• Type: string
• Required: No
• Description: The name of the profile with which you can adjust the forecast set.

• Type: int

• Required: Yes

• Description: Required.

  The start date for forecast adjustments.

Represents the dimensions selected for an advanced account forecast set to categorize the data. For example, a business unit requires forecast data for each account aggregated by product and ship-from location.

• Type: string

• Required: Yes

• Description: Required.

  The name of the advanced account forecast dimension.

• Type: string

• Required: Yes

• Description: Required.

  The API name of the field for the dimension in the custom object that contains the generated advanced account forecast records.

• Type: string
• Required: No
• Description: The name of the dimension source associated with the advanced account forecast set dimension record.

• Type: int

• Required: Yes

• Description: Required.

  The sequence number of the dimension source associated with the forecast set.

Represents information about the measures to display in the advanced account forecasts grid for the forecast set.

• Type: string

• Required: Yes

• Description: Required.

  The name of the definition for the advanced account forecast measure.

• Type: AdvAcctFcstAggregationType (enumeration of type string)

• Required: No

• Description: Required.

  The type of aggregation that’s used for calculating the advanced account forecast values.

• Possible values:

  • AVERAGE
  • MAXIMUM
  • MINIMUM
  • SUM

• Type: AdvAcctFcstComputationMethod (enumeration of type string)

• Required: No

• Description: Required.

  The method that’s used for calculating the advanced account forecast values.

  Values are:

• Possible values:

  • CUSTOM
  • DATA_PROCESSING_ENGINE_DEFINITION
  • FORMULA

• Type: string

• Required: Yes

• Description: Required.

  The field of the facts object used for the advanced account forecast measure.

• Type: string

• Required: Yes

• Description: Required.

  The name for the advanced account forecast measure to show on UI.

• Type: AdvAcctFcstMeasureType (enumeration of type string)

• Required: Yes

• Description: Required.

  The measure type that’s used for the generated advanced forecast values.

• Possible values:

  • QUANTITY
  • REVENUE

• Type: boolean
• Required: No
• Description: Indicates whether the adjustments made to the advanced account forecast values for this metric are tracked (true) or not (false).

Represents information about the groups for the advanced account forecast set measures or dimensions.

• Type: string

• Required: Yes

• Description: Required.

  The name of the advanced account forecast display group.

• Type: AdvAcctFrcstDplyGroupItem[]
• Required: No
• Description: The items associated with a display group for an advanced account forecast set.

• Type: AdvAcctFrcstDisplayGroupType (enumeration of type string)

• Required: No

• Description: The category of the display group.

  Possible value is:

• Possible values:

  • MEASURE

• Type: boolean
• Required: No
• Description: Indicates whether the display group is the default group (true) or not (false).

• Type: string
• Required: No
• Description: The name of the profile for which the display group is applicable.

Represents information about the items associated with a display group for an advanced account forecast set.

• Type: string

• Required: Yes

• Description: Required.

  The name of the advanced account forecast display group that’s associated with the group item.

• Type: int

• Required: Yes

• Description: Required.

  The display order of the display group item.

• Type: string
• Required: No
• Description: The ID of the measure associated with the display group item.

The following is an example of an AdvAccountForecastSet component.

1<?xml version="1.0" encoding="UTF-8"?>
2<AdvAccountForecastSet xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
3    <calculationFrequency>Quarterly</calculationFrequency>
4    <forecastAdjPeriods>
5        <adjustmentDayCount>5</adjustmentDayCount>
6        <frequency>Quarter</frequency>
7        <profileName xsi:nil="true"/>
8        <startDay>1</startDay>
9    </forecastAdjPeriods>
10    <forecastFormulas>
11        <endPeriod>12</endPeriod>
12        <formulaExpression>6</formulaExpression>
13        <startPeriod>2</startPeriod>
14        <formulaType>QUANTITY</formulaType>
15    </forecastFormulas>
16    <forecastPeriodGroupName>PeriodGroup1</forecastPeriodGroupName>
17    <accountFieldName>Account</accountFieldName>
18    <periodFieldName>Period</periodFieldName>
19    <forecastQuantityFieldName>ForecastedQuantity</forecastQuantityFieldName>
20    <forecastRevenueFieldName>ForecastedRevenue</forecastRevenueFieldName>
21    <forecastFactObjectName>AdvAccountForecastFact</forecastFactObjectName>
22    <forecastSetFieldName>AdvAcctForecastSetPartner</forecastSetFieldName>
23    <rolloverFrequency>Monthly</rolloverFrequency>
24    <forecastStatusFieldName>Status</forecastStatusFieldName>
25    <description>sample forecast set</description>
26    <regenerationDpeDefName xsi:nil="true"/>
27    <rolloverDpeDefName xsi:nil="true"/>
28    <recalculateDpeDefName xsi:nil="true"/>
29    <generationDpeDefName xsi:nil="true"/>
30    <status>Inactive</status>
31    <forecastSetName>Forecast Set 1</forecastSetName>
32    <dimensions>
33        <dimensionFieldName>Account</dimensionFieldName>
34        <dimensionSourceName>DimSource1</dimensionSourceName>
35        <hierarchySequenceNumber>1</hierarchySequenceNumber>
36        <advAcctForecastDimName>DimensionName</advAcctForecastDimName>
37    </dimensions>
38    <measureDefinitions>
39        <forecastDataMeasureName>MeasureName</forecastDataMeasureName>
40        <advAcctForecastMeasureDefName>Sample Def Name</advAcctForecastMeasureDefName>
41        <isAdjustmentTracked>true</isAdjustmentTracked>
42        <forecastMeasureName>Samplemeasure name</forecastMeasureName>
43        <aggregationType>MINIMUM</aggregationType>
44        <computationMethod>DATA_PROCESSING_ENGINE_DEFINITION</computationMethod>
45        <forecastMeasureType>QUANTITY</forecastMeasureType>
46    </measureDefinitions>
47    <displayGroups>
48        <advAcctFrcstDisplayGroupName>Sample Measure Group</advAcctFrcstDisplayGroupName>
49        <displayGroupType>MEASURE</displayGroupType>
50        <isDefault>false</isDefault>
51        <userProfileName xsi:nil="true"/>
52        <displayGroupItems>
53            <advAcctFrcstDplyGroupItemName>Sample Quantity</advAcctFrcstDplyGroupItemName>
54            <measureReferenceName>Sample Def Name</measureReferenceName>
55            <displayOrder>1</displayOrder>
56        </displayGroupItems>
57    </displayGroups>
58</AdvAccountForecastSet>

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>AdvAccountForecastSet</name>
6    </types>
7   <version>68.0</version>
8</Package>

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.