ForecastingSettings

コラボレーション売上予測設定オプションを表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。

この情報は、コラボレーション売上予測にのみ適用されます。

メモ

ファイルのサフィックスおよびディレクトリの場所

ForecastingSettings の値は、対応するパッケージディレクトリの settings ディレクトリの Forecasting.settings という 1 つのファイルに保存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。

バージョン

ForecastingSettings コンポーネントは、API バージョン 28 以降で使用できます。ForecastingSettings 型の構造は、API バージョン 30.0 で大幅に変更されました。

項目

項目名	データ型	説明
displayCurrency	DisplayCurrency (string 型の列挙)	売上予測の表示に使用する通貨。組織のマスタ通貨または各売上予測所有者の個人設定の通貨のいずれかになります。これは、コラボレーション売上予測で使用され、設定で選択されるデフォルトの通貨です。組織で使用するために有効化されているいずれか 1 つの通貨を選択する必要があり、選択できるのは 1 つのみです。デフォルトは `Corporate` です。有効な値は、次のとおりです。 `Corporate` `Personal`
enableForecasts	boolean	コラボレーション売上予測が有効化されているかどうかを示します。コラボレーション売上予測を有効にするには `true` に設定し、無効にするには `false` に設定します。売上予測を無効にすると、データが失われる可能性があります。機能を無効にする前に、オンラインヘルプを参照してください。警告
forecastingCategoryMappings	ForecastingCategoryMappings[]	売上予測種別と売上予測��み上げ集計を関連付ける対応付けのリスト。
forecastingDisplayedFamilySettings	string ForecastingDisplayedFamilySettings[]	Lightning Experience で売上予測を可能にするために選択される商品ファミリ。この項目は、API バージョン 40.0 以降で使用できます。
forecastingTypeSettings	ForecastingTypeSettings[]	売上予測種別のリストです。項目値については、ForecastingTypeSettings を参照してください。売上予測種別の最大数は 4 です。

ForecastingTypeSettings

各売上予測種別の設定。組織では、最大 4 個の売上予測種別を有効にできます。最小の API バージョンがメタデータパッケージバージョン以下の、以前有効だった売上予測種別を除外すると、その目標と調整データが組織から削除されます。

XML から売上予測種別項目を除外すると、その売上予測種別が無効になる場合があります。その売上予測種別が XML パッケージバージョンで指定されたリリースで使用可能だった場合、その売上予測種別は無効になり、その目標および調整データは削除されます。

警告

項目名	データ型	説明
active	boolean	name 項目で指定されている売上予測種別が有効かどうかを示します。 active 項目を false に設定すると、その売上予測種別のすべての売上予測データ、調整、および目標が消去されます。active を true に設定すると、[売上予測] タブの一部の値がすぐに表示されない場合があります。処理中アイコンが表示され、値が計算中であることを示します。メモ
adjustmentsSettings	AdjustmentsSettings	これは、売上予測の売上予測調整オプションを有効または無効にします。
displayedCategoryApiNames	string	この参照のみ項目は、累積売上予測積み上げ集計または個々の売上予測分類積み上げ集計について、[売上予測] タブに表示される 4 つの売上予測積み上げ集計カテゴリを指定するために 4 回出現します。displayedCategoryApiNames と forecastedCategoryApiNames の両方で、常に同じ 4 つの値を使用します。累積売上予測積み上げ集計を使用する組織の有効値は次のとおりです。 `openpipeline` `bestcaseforecast` `commitforecast` `closedonly` 個々の売上予測分類積み上げ集計を使用する組織の有効値は次のとおりです。 `pipelineonly` `bestcaseonly` `commitonly` `closedonly`
forecastedCategoryApiNames	string	この項目は、累積売上予測積み上げ集計または個々の売上予測分類積み上げ集計について、組織で使用される 4 つの売上予測積み上げ集計カテゴリを指定するために 4 回出現します。累積売上予測積み上げ集計を使用する組織の有効値は次のとおりです。 `openpipeline` `bestcaseforecast` `commitforecast` `closedonly` 個々の売上予測分類積み上げ集計を使用する組織の有効値は次のとおりです。 `pipelineonly` `bestcaseonly` `commitonly` `closedonly` ある 4 つの値のセットから他のセットに変更すると、[設定] の [累積売上予測積み上げ集計列を有効化] の組織設定が変更されます。この項目が省略されると、設定は変更されません。
ForecastingDateType	ForecastingDateType (string 型の列挙)	コラボレーション売上予測で売上予測金額のベースとなる date 型。有効な値は、次のとおりです。 `OpportunityCloseDate` (デフォルト) `ProductDate` `ScheduleDate` API バージョン 42.0 以降で使用できます。API バージョン 42.0 では、date 型は参照のみで API を介してのみ使用できます。
forecastRangeSettings	ForecastRangeSettings	コラボレーション売上予測のデフォルトの期間と範囲の選択。
hasProductFamily	boolean	売上予測種別で商品ファミリ売上予測が有効かどうかを示します。API バージョン 41.0 以降で使用できます。
isAmount	boolean	この参照のみ項目は、売上予測種別が収益金額に基づくかどうかを示します。isAmount の値は常に isQuantity の値の反対です。
isAvailable	boolean	この参照のみ項目は、売上予測種別を現在組織で使用できるかどうかを示します。たとえば、収益分割売上予測種別は、商談の分割が有効ではない組織では使用できません。
isQuantity	boolean	この参照のみ項目は、売上予測種別が商品数量に基づくかどうかを示します。isQuantity の値は常に isAmount の値の反対です。
managerAdjustableCategoryApiNames	string	この参照のみの項目は、累積売上予測積み上げ集計または個々の売上予測分類積み上げ集計について、組織で売上予測マネージャが調整可能な 2 つの売上予測積み上げ集計カテゴリを指定するために 2 回出現します。この項目は、enableAdjustments 項目の値が true の場合にのみ使用できます。managerAdjustableCategoryApiNames および ownerAdjustableCategoryApiNames の両方の項目が使用されている場合、同じ 2 つの値が含まれている必要があります。それらの値は、enableAdjustments および enableOwnerAdjustments 項目の値と一致する必要もあります。累積売上予測積み上げ集計を使用する組織の有効値は次のとおりです。 `bestcaseforecast` `commitforecast` 個々の売上予測分類積み上げ集計を使用する組織の有効値は次のとおりです。 `bestcaseonly` `commitonly`
masterLabel	string	この参照のみの項目は、売上予測種別の UI 表示ラベルを示します。
name	string	売上予測種別の名前。売上予測種別ごとに特定の文字列が必要です。使用できる値は次のとおりです。 `OpportunityRevenue`: 商談 - 収益 `OpportunityQuantity`: 商談 - 数量 `OpportunitySplitRevenue`: 商談収益分割 - 収益 `OpportunityOverlayRevenue`: 商談オーバーレイ分割 - 収益 `OpportunityLineItemRevenue`: 商品ファミリ - 収益 `OpportunityLineItemQuantity`: 商品ファミリ - 数量売上予測種別として有効化されているカスタム商談分割種別の名前。カスタム分割種別は通貨項目に基づいており、収益金額のみを保存できます。
opportunityListFieldsLabelMappings	OpportunityListFieldsLabelMappings	商談オブジェクトのすべての項目の API 名と UI 表示ラベルの参照のみリスト。
opportunityListFieldsSelectedSettings	OpportunityListFieldsSelectedSettings	売上予測種別の売上予測ページの商談ペインに表示するために選択された項目。[商談名] は必須項目です。15 項目まで選択できます。
opportunityListFieldsUnselectedSettings	OpportunityListFieldsUnselectedSettings	売上予測種別の売上予測ページの商談ペインに表示される対象として選択されていない項目。
opportunitySplitName	string	売上予測種別に分割種別があるかどうか、ある場合はその分割種別名を示します。API バージョン 41.0 以降で使用できます。
ownerAdjustableCategoryApiNames	string	この参照のみの項目は、累積売上予測積み上げ集計または個々の売上予測分類積み上げ集計について、組織で売上予測所有者が調整可能な 2 つの売上予測積み上げ集計カテゴリを指定するために 2 回出現します。この項目は、enableOwnerAdjustments 項目の値が true の場合にのみ使用できます。managerAdjustableCategoryApiNames および ownerAdjustableCategoryApiNames の両方の項目が使用されている場合、同じ 2 つの値が含まれている必要があります。それらの値は、enableAdjustments および enableOwnerAdjustments 項目の値と一致する必要もあります。累積売上予測積み上げ集計を使用する組織の有効値は次のとおりです。 `bestcaseforecast` `commitforecast` 個々の売上予測分類積み上げ集計を使用する組織の有効値は次のとおりです。 `bestcaseonly` `commitonly`
quotasSettings	QuotasSettings	これは、売上予測の目標オプションを有効または無効にします。
territory2ModelName	string	売上予測種別に Territory2 モデルがあるかどうか、ある場合はその Territory2 モデル名を示します。API バージョン 41.0 以降で使用できます。

AdjustmentsSettings

コラボレ��ション売上予測の調整オプション。

項目	データ型	説明
enableAdjustments	boolean	コラボレーション売上予測マネージャによる調整を有効にするには `true` に設定し、無効にするには `false` に設定します。すべての売上予測種別には、同じ enableAdjustments 値が含まれている必要があります。調整を無効にすると、コラボレーション売上予測調整データが消去されます。警告
enableOwnerAdjustments	boolean	コラボレーション売上予測所有者による調整を有効にするには `true` に設定し、無効にするには `false` に設定します。すべての売上予測種別には、同じ enableAdjustments 値が含まれている必要があります。調整を無効にすると、コラボレーション売上予測調整データが消去されます。警告

ForecastRangeSettings

コラボレーション売上予測のデフォルトの期間と範囲の選択。ユーザは、過去または将来の 12 か月または 8 四半期までの売上予測が可能です。売上予測範囲に当月または当四半期が含まれている場合、[売上予測] ページにはデフォルトで当月または当四半期が表示されます。含まれていない場合は、範囲の最初の月または四半期が選択されます。すべての売上予測種別には、同じ forecastRangeSettings 項目値が含まれている必要があります。

期間を [毎月] から [毎四半期] または [毎四半期] から [毎月] に変更するか、標準会計年度を変更すると、すべての調整および目標が消去されます。カスタム会計年度を有効にした場合、最初のカスタム会計年度を作成すると、対応する標準会計年度以降の目標と調整が削除されます。これらの変更により、売上予測の再計算がトリガされます。データ量によっては、この再計算にかなりの時間がかかる場合があります。

警告

項目	データ型	説明
beginning	int	デフォルトで表示する開始月または開始四半期を示します。
displaying	int	デフォルトで表示する月数または四半期数を示します。最大月数は 12、最大四半期数は 8 です。
periodType	PeriodTypes (string 型の列挙)	使用する期間の種別を示します。有効な値は、次のとおりです。 `Month` `Quarter`

OpportunityListFieldsLabelMappings

商談オブジェクトのすべての項目の API 名と UI 表示ラベルの参照のみリスト。

項目	データ型	説明
field	string	商談項目の API 名。
label	string	商談項目の UI 表示ラベル。

OpportunityListFieldsSelectedSettings

売上予測種別の売上予測ページの商談ペインに表示するために選択された項目。[商談名] は必須項目です。15 項目まで選択できます。

項目	データ型	説明
field	string	商談ペインに表示する項目名を指定します。

OpportunityListFieldsUnselectedSettings

売上予測種別の売上予測ページの商談ペインに表示される対象として選択されていない項目。

項目	データ型	説明
field	string	商談ペインに表示しない項目名を指定します。

QuotasSettings

QuotasSettings は、コラボレーション売上予測で目標を使用できるかどうかを示します。

項目	データ型	説明
showQuotas	boolean	目標を有効にするには、`true` に設定します。すべての売上予測種別には、同じ showQuotas 項目値が含まれている必要があります。

ForecastingCategoryMappings

コラボレーション売上予測の売上予測分類の対応付け。このサブタイプは、ForecastingSettings 種別内に 8 回出現します。各出現箇所には、売上予測分類積み上げ集計の種別を指定する項目、各積み上げ集計に含まれる売上予測分類、および積み上げ集計での各売上予測分類の加重が含まれます。累積売上予測積み上げ集計列または個々の売上予測分類列を使用する組織は、このサブタイプの 8 つの出現箇所すべてを含める必要があります。

項目	データ型	説明
forecastingItemCategoryApiName	string	この項目は、積み上げ集計種別の API 名を指定します。有効な値は、次のとおりです。 openpipeline bestcaseforecast commitforecast pipelineonly bestcaseonly commitonly closedonly omittedonly
weightedSourceCategories	WeightedSourceCategories[]	この項目は、複数の売上予測分類を積み上げ集計種別に含めるように指定した場合、複数回出現します。各出現箇所には、売上予測積み上げ集計種別に含める売上予測分類とその加重を指定する 2 つのサブ項目が含まれます。一部の積み上げ集計種別には、複数の売上予測分類が含まれます。次のリストは、各積み上げ集計種別に含まれる売上予測分類を示します。積み上げ集計: openpipeline、売上予測分類: パイプラ��ン、最善達成予測、達成予測積み上げ集計: bestcaseforecast、売上予測分類: 最善達成予測、達成予測、完了積み上げ集計: commitforecast、売上予測分類: 達成予測、完了積み上げ集計: pipelineonly、売上予測分類: パイプライン積み上げ集計: bestcaseonly、売上予測分類: 最善達成予測積み上げ集計: commitonly、売上予測分類: 達成予測積み上げ集計: closedonly、売上予測分類: 完了積み上げ集計: omittedonly、売上予測分類: 売上予測から除外

WeightedSourceCategories

この項目は、複数の売上予測分類を積み上げ集計種別に含めるように指定した場合、複数回出現します。各出現箇所には、売上予測積み上げ集計種別に含める売上予測分類とその加重を指定する 2 つのサブ項目が含まれます。一部の積み上げ集計種別には、複数の売上予測分類が含まれます。次の表は、各積み上げ集計種別に含まれる売上予測分類を示します。

項目	データ型	説明
sourceCategoryApiName	string	積み上げ集計種別に含める売上予測分類の API 名を指定します。有効な値は、次のとおりです。パイプライン最善達成予測達成予測完了売上予測から除外
weight	double	積み上げ集計種別の売上予測を計算するときに売上予測分類に指定される加重を指定します。サポートされる値は 1.0 のみです。

ForecastingDisplayedFamilySettings

Lightning Experience で売上予測を可能にするためにシステム管理者が選択する商品ファミリ。この項目は、API バージョン 40.0 以降で使用できます。

項目	データ型	説明
productFamily	文字列型	売上予測に使用可能な商品ファミリ。商品ファミリはそれぞれ異なります。

宣言的なメタデータの定義のサンプル

次に、[商談 - 収益] および [商品ファミリ - 数量] 売上予測種別を有効にする ForecastingSettings コンポーネントの例を示します。

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        <displayedCategoryApiNames>pipelineonly</displayedCategoryApiNames>
40        <displayedCategoryApiNames>bestcaseonly</displayedCategoryApiNames>
41        <displayedCategoryApiNames>commitonly</displayedCategoryApiNames>
42        <displayedCategoryApiNames>closedonly</displayedCategoryApiNames>
43        <forecastedCategoryApiNames>commitonly</forecastedCategoryApiNames>
44        <forecastedCategoryApiNames>closedonly</forecastedCategoryApiNames>
45        <forecastedCategoryApiNames>bestcaseonly</forecastedCategoryApiNames>
46        <forecastedCategoryApiNames>pipelineonly</forecastedCategoryApiNames>
47        <managerAdjustableCategoryApiNames>commitonly</managerAdjustableCategoryApiNames>
48        <managerAdjustableCategoryApiNames>bestcaseonly</managerAdjustableCategoryApiNames>
49        <ownerAdjustableCategoryApiNames>commitonly</ownerAdjustableCategoryApiNames>
50        <ownerAdjustableCategoryApiNames>bestcaseonly</ownerAdjustableCategoryApiNames>
51    </forecastingTypeSettings>
52    <forecastingCategoryMappings>
53        <forecastingItemCategoryApiName>commitonly</forecastingItemCategoryApiName>
54        <weightedSourceCategories>
55            <sourceCategoryApiName>commit</sourceCategoryApiName>
56            <weight>1.0</weight>
57        </weightedSourceCategories>
58    </forecastingCategoryMappings>
59    <forecastingCategoryMappings>
60        <forecastingItemCategoryApiName>closedonly</forecastingItemCategoryApiName>
61        <weightedSourceCategories>
62            <sourceCategoryApiName>closed</sourceCategoryApiName>
63            <weight>1.0</weight>
64        </weightedSourceCategories>
65    </forecastingCategoryMappings>
66    <forecastingCategoryMappings>
67        <forecastingItemCategoryApiName>bestcaseforecast</forecastingItemCategoryApiName>
68        <weightedSourceCategories>
69            <sourceCategoryApiName>commit</sourceCategoryApiName>
70            <weight>1.0</weight>
71        </weightedSourceCategories>
72        <weightedSourceCategories>
73            <sourceCategoryApiName>best case</sourceCategoryApiName>
74            <weight>1.0</weight>
75        </weightedSourceCategories>
76        <weightedSourceCategories>
77            <sourceCategoryApiName>closed</sourceCategoryApiName>
78            <weight>1.0</weight>
79        </weightedSourceCategories>
80    </forecastingCategoryMappings>
81    <forecastingCategoryMappings>
82        <forecastingItemCategoryApiName>omittedonly</forecastingItemCategoryApiName>
83        <weightedSourceCategories>
84            <sourceCategoryApiName>omitted</sourceCategoryApiName>
85            <weight>1.0</weight>
86        </weightedSourceCategories>
87    </forecastingCategoryMappings>
88    <forecastingCategoryMappings>
89        <forecastingItemCategoryApiName>openpipeline</forecastingItemCategoryApiName>
90        <weightedSourceCategories>
91            <sourceCategoryApiName>commit</sourceCategoryApiName>
92            <weight>1.0</weight>
93        </weightedSourceCategories>
94        <weightedSourceCategories>
95            <sourceCategoryApiName>best case</sourceCategoryApiName>
96            <weight>1.0</weight>
97        </weightedSourceCategories>
98        <weightedSourceCategories>
99            <sourceCategoryApiName>pipeline</sourceCategoryApiName>
100            <weight>1.0</weight>
101        </weightedSourceCategories>
102    </forecastingCategoryMappings>
103    <forecastingCategoryMappings>
104        <forecastingItemCategoryApiName>bestcaseonly</forecastingItemCategoryApiName>
105        <weightedSourceCategories>
106            <sourceCategoryApiName>best case</sourceCategoryApiName>
107            <weight>1.0</weight>
108        </weightedSourceCategories>
109    </forecastingCategoryMappings>
110    <forecastingCategoryMappings>
111        <forecastingItemCategoryApiName>commitforecast</forecastingItemCategoryApiName>
112        <weightedSourceCategories>
113            <sourceCategoryApiName>closed</sourceCategoryApiName>
114            <weight>1.0</weight>
115        </weightedSourceCategories>
116        <weightedSourceCategories>
117            <sourceCategoryApiName>commit</sourceCategoryApiName>
118            <weight>1.0</weight>
119        </weightedSourceCategories>
120    </forecastingCategoryMappings>
121    <forecastingCategoryMappings>
122        <forecastingItemCategoryApiName>pipelineonly</forecastingItemCategoryApiName>
123        <weightedSourceCategories>
124            <sourceCategoryApiName>pipeline</sourceCategoryApiName>
125            <weight>1.0</weight>
126        </weightedSourceCategories>
127    </forecastingCategoryMappings>

メタデータ API 開発者ガイド