メタデータ API 開発者ガイド
jForecastingSettings
コラボレーション売上予測設定オプションを表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
ForecastingSettings の値は、対応するパッケージディレクトリの settings ディレクトリの Forecasting.settings という 1 つのファイルに保存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。
バージョン
ForecastingSettings コンポーネントは、API バージョン 28 以降で使用できます。ForecastingSettings 型の構造は、API バージョン 30.0 で大幅に変更されました。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| displayCurrency | DisplayCurrency (string 型の列挙) | 売上予測の表示に使用する通貨。組織のマスタ通貨または各売上予測所有者の個人設定の通貨のいずれかになります。これは、コラボレーション売上予測で使用され、設定で選択されるデフォルトの通貨です。組織で使用するために有効化されているいずれか 1 つの通貨を選択する必要があり、選択できるのは 1 つのみです。デフォルトは Corporate です。有効な値は、次のとおりです。
|
| enableForecasts | boolean | コラボレーション売上予測が有効化されているかどうかを示します。コラボレーション売上予測を有効にするには true に設定し、無効にするには false に設定します。 |
| forecastingTypeSettings | ForecastingTypeSettings[] | 売上予測種別のリストです。項目値については、「ForecastingTypeSettings」を参照してください。売上予測種別の最大数は 4 です。 |
| forecastingCategoryMappings | ForecastingCategoryMappings[] | 売上予測種別と売上予測積み上げ集計を関連付ける対応付けのリスト。 |
| forecastingDisplayedFamilySettings | stringForecastingDisplayedFamilySettings[] | Lightning Experience で売上予測を可能にするために選択される商品ファミリ。この項目は、API バージョン 40.0 以降で使用できます。 |
ForecastingTypeSettings
各売上予測種別の設定。組織では、最大 4 個の売上予測種別を有効にできます。最小の API バージョンがメタデータパッケージバージョン以下の、以前有効だった売上予測種別を除外すると、その目標と調整データが組織から削除されます。
AdjustmentsSettings
| 項目 | データ型 | 説明 |
|---|---|---|
| enableAdjustments | boolean | コラボレーション売上予測マネージャによる調整を有効にするには true に設定し、無効にするには false に設定します。すべての売上予測種別には、同じ enableAdjustments 値が含まれている必要があります。 |
| enableOwnerAdjustments | boolean | コラボレーション売上予測所有者による調整を有効にするには true に設定し、無効にするには false に設定します。すべての売上予測種別には、同じ enableAdjustments 値が含まれている必要があります。 |
ForecastRangeSettings
コラボレーション売上予測のデフォルトの期間と範囲の選択。ユーザは、過去または将来の 12 か月または 8 四半期までの売上予測が可能です。売上予測範囲に当月または当四半期が含まれている場合、[売上予測] ページにはデフォルトで当月または当四半期が表示されます。含まれていない場合は、範囲の最初の月または四半期が選択されます。すべての売上予測種別には、同じ forecastRangeSettings 項目値が含まれている必要があります。
| 項目 | データ型 | 説明 |
|---|---|---|
| beginning | int | デフォルトで表示する開始月または開始四半期を示します。 |
| displaying | int | デフォルトで表示する月数または四半期数を示します。最大月数は 12、最大四半期数は 8 です。 |
| periodType | PeriodTypes (string 型の列挙) | 使用する期間の種別を示します。有効な値は、次のとおりです。
|
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 名を指定します。有効な値は、次のとおりです。
|
| weightedSourceCategories | WeightedSourceCategories[] | この項目は、複数の売上予測分類を積み上げ集計種別に含めるように指定した場合、複数回出現します。各出現箇所には、売上予測積み上げ集計種別に含める売上予測分類とその加重を指定する 2 つのサブ項目が含まれます。一部の積み上げ集計種別には、複数の売上予測分類が含まれます。次のリストは、各積み上げ集計種別に含まれる売上予測分類を示します。
|
WeightedSourceCategories
この項目は、複数の売上予測分類を積み上げ集計種別に含めるように指定した場合、複数回出現します。各出現箇所には、売上予測積み上げ集計種別に含める売上予測分類とその加重を指定する 2 つのサブ項目が含まれます。一部の積み上げ集計種別には、複数の売上予測分類が含まれます。次の表は、各積み上げ集計種別に含まれる売上予測分類を示します。
| 項目 | データ型 | 説明 |
|---|---|---|
| sourceCategoryApiName | string | 積み上げ集計種別に含める売上予測分類の API 名を指定します。有効な値は、次のとおりです。
|
| weight | double | 積み上げ集計種別の売上予測を計算するときに売上予測分類に指定される加重を指定します。サポートされる値は 1.0 のみです。 |