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` に設定します。売上予測を無効にすると、データが失われる可能性があります。機能を無効にする前に、オンラインヘルプを参照してください。警告
forecastingTypeSettings	ForecastingTypeSettings[]	売上予測種別のリストです。項目値については、「ForecastingTypeSettings」を参照してください。売上予測種別の最大数は 4 です。
forecastingCategoryMappings	ForecastingCategoryMappings[]	売上予測種別と売上予測積み上げ集計を関連付ける対応付けのリスト。

ForecastingTypeSettings

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

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

警告

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

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

OpportunityListFieldsSelectedSettings

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

項目	データ型	説明
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 のみです。

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

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

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