メタデータ API 開発者ガイド
jForecastingSettings
パッケージマニフェストでは、Settings の名前を使用してすべての組織設定メタデータ型にアクセスします。詳細は、「設定」を参照してください。
ファイルのサフィックスおよびディレクトリの場所
ForecastingSettings の値は、対応するパッケージディレクトリの settings ディレクトリの Forecasting.settings という 1 つのファイルに保存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。
バージョン
ForecastingSettings コンポーネントは、API バージョン 28 以降で利用できます。ForecastingSettings 型の構造は、API バージョン 30.0 および API バージョン 53.0 で大幅に変更されました。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| displayCurrency | DisplayCurrency (string 型の列挙) | 削除済み。売上予測の表示に使用する通貨。組織のマスタ通貨または各売上予測所有者の個人設定の通貨のいずれかになります。選択された通貨は、コラボレーション売上予測で使用され、設定で選択されるデフォルトです。組織で使用するために有効化されているいずれか 1 つの通貨を選択する必要があり、選択できるのは 1 つのみです。デフォルトは CORPORATE です。有効な値は、次のとおりです。
API バージョン 28.0 ～ 46.0 で使用可能です。API バージョン 47.0 以降では、defaultToPersonalCurrency を使用します。 |
| defaultToPersonalCurrency | boolean | マルチ通貨が有効な場合、この項目はユーザの個人設定の通貨を売上予測で使用するかどうかを示します。true (デフォルト) の場合、ユーザの個人設定の通貨が使用されます。false の場合、マスタ通貨が使用されます。 API バージョン 47.0 以降で利用できます。 |
| enableForecasts | boolean | コラボレーション売上予測が有効化されているかどうかを示します。コラボレーション売上予測を有効にするには true に設定し、無効にするには false に設定します。 売上予測を無効にすると、データが失われる可能性があります。機能を無効にする前に、Salesforce ヘルプを参照してください。 |
| forecastingCategoryMappings | ForecastingCategoryMapping[] | 売上予測種別と売上予測積み上げ集計を関連付ける対応付けのリスト。Spring ’20 以降、このサブタイプにアクセスできるのは、「すべての売上予測の参照」権限もしくは「売上予測を許可」権限を持つ標準ユーザ、または代理売上予測マネージャ状況の標準ユーザのみとなります。 |
| forecastingDisplayedFamilySettings | ForecastingDisplayedFamilySettings[] | Lightning Experience で売上予測を可能にするために選択される商品ファミリ。この項目は、API バージョン 40.0 以降で使用できます。 |
| forecastingTypeSettings | ForecastingTypeSettings[] | 売上予測種別のリストです。項目値については、ForecastingTypeSettings を参照してください。売上予測種別の最大数は 4 です。 |
| globalAdjustmentsSettings | AdjustmentsSettings[] | コラボレーション売上予測の調整オプション。API バージョン 53.0 以降で利用できます。API バージョン 52.0 以前では、adjustmentsSettings 項目を ForecastingTypeSettings で使用します。 |
| globalForecastRangeSettings | ForecastRangeSettings[] | コラボレーション売上予測のデフォルトの期間と範囲の選択。API バージョン 53.0 以降で利用できます。API バージョン 52.0 以前では、forecastRangeSettings 項目を ForecastingTypeSettings で使用します。 |
| globalQuotasSettings | QuotasSettings[] | コラボレーション売上予測の目標を有効または無効にします。API バージョン 53.0 以降で利用できます。API バージョン 52.0 以前では、quotasSettings 項目を ForecastingTypeSettings で使用します。 |
ForecastingCategoryMapping
コラボレーション売上予測の売上予測分類の対応付け。このサブタイプは、ForecastingSettings 種別内に 8 回出現します。各出現箇所には、売上予測分類積み上げ集計の種別を指定する項目、各積み上げ集計に含まれる売上予測分類、および積み上げ集計での各売上予測分類の加重が含まれます。累積売上予測積み上げ集計列または個々の売上予測分類列を使用する組織は、このサブタイプの 8 つの出現箇所すべてを含める必要があります。Spring ’20 以降、このサブタイプにアクセスできるのは、「すべての売上予測の参照」権限もしくは「売上予測を許可」権限を持つ標準ユーザ、または代理売上予測マネージャ状況の標準ユーザのみとなります。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| forecastingItemCategoryApiName | string | 必須。この項目は、積み上げ集計種別の API 名を指定します。有効な値は、次のとおりです。
|
| weightedSourceCategories | WeightedSourceCategory[] | この項目は、複数の売上予測分類を積み上げ集計種別に含めるように指定した場合、複数回出現します。各出現箇所には、売上予測積み上げ集計種別に含める売上予測分類とその加重を指定する 2 つのサブ項目が含まれます。一部の積み上げ集計種別には、複数の売上予測分類が含まれます。次のリストは、各積み上げ集計種別に含まれる売上予測分類を示します。
|
ForecastingDisplayedFamilySettings
Lightning Experience で売上予測を可能にするためにシステム管理者が選択する商品ファミリ。この項目は、API バージョン 40.0 以降で使用できます。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| productFamily | string | 売上予測に使用可能な商品ファミリ。商品ファミリはそれぞれ異なります。 |
ForecastingTypeSettings
各売上予測種別の設定。組織では、最大 4 個の売上予測種別を有効にできます。最小の API バージョンがメタデータパッケージバージョン以下の、以前有効だった売上予測種別を除外すると、その目標と調整データが組織から削除されます。
XML から売上予測種別項目を除外すると、その売上予測種別が無効になる場合があります。その売上予測種別が XML パッケージバージョンで指定されたリリースで使用可能だった場合、その売上予測種別は無効になり、その目標および調整データは削除されます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| active | boolean | 必須。name 項目で指定されている売上予測種別が有効かどうかを示します。 active 項目を false に設定すると、その売上予測種別のすべての売上予測データ、調整、および目標が消去されます。active を true に設定すると、[売上予測] タブの一部の値の即時表示が行われなくなります。処理中アイコンが表示され、値が計算中であることを示します。 |
| adjustmentsSettings | AdjustmentsSettings | 削除済み。この項目は、コラボレーション売上予測の売上予測調整オプションを有効または無効にします。API バージョン 53.0 以降では、globalAdjustmentsSettings を使用します。 |
| displayedCategoryApiNames | string | この参照のみ項目は、累積売上予測積み上げ集計または個々の売上予測分類積み上げ集計について、[売上予測] タブに表示される 4 つの売上予測積み上げ集計カテゴリを指定するために 4 回出現します。displayedCategoryApiNames と forecastedCategoryApiNames の両方で、常に同じ 4 つの値を使用します。 累積売上予測積み上げ集計を使用する組織の有効値は次のとおりです。
個々の売上予測分類積み上げ集計を使用する組織の有効値は次のとおりです。
|
| forecastedCategoryApiNames | string | この項目は、累積売上予測積み上げ集計または個々の売上予測分類積み上げ集計について、組織で使用される 4 つの売上予測積み上げ集計カテゴリを指定するために 4 回出現します。 累積売上予測積み上げ集計を使用する組織の有効値は次のとおりです。
個々の売上予測分類積み上げ集計を使用する組織の有効値は次のとおりです。
ある 4 つの値のセットから他のセットに変更すると、[設定] の [累積売上予測積み上げ集計列を有効化] の組織設定が変更されます。この項目を省略した場合、設定は変更されません。 |
| forecastingDateType | ForecastingDateType (string 型の列挙) | 必須。コラボレーション売上予測で売上予測金額のベースとなる date 型。 有効な値は、次のとおりです。
API バージョン 42.0 以降で利用できます。API バージョン 42.0 に限り、date 型を参照のみで API を介してのみ使用できます。 |
| forecastRangeSettings | ForecastRangeSettings | 削除済み。コラボレーション売上予測のデフォルトの期間と範囲の選択。API バージョン 53.0 以降では、globalForecastRangeSettings を使用します。 |
| 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 項目の値と一致する必要もあります。 累積売上予測積み上げ集計を使用する組織の有効値は次のとおりです。
個々の売上予測分類積み上げ集計を使用する組織の有効値は次のとおりです。
|
| masterLabel | string | 必須。この参照のみの項目は、売上予測種別の UI 表示ラベルを示します。 |
| name | string | 必須。売上予測種別の名前。売上予測種別ごとに特定の文字列が必要です。 ForecastingSettings では、次の売上予測種別のみを有効化できます。
API バージョン 52.0 以降で他の売上予測種別を作成および管理するには、ForecastingSourceDefinition、ForecastingType、ForecastingTypeSource を使用します。 |
| opportunityListFieldsLabelMappings | OpportunityListFieldsLabelMapping | 商談オブジェクトのすべての項目の API 名と UI 表示ラベルの参照のみリスト。 |
| opportunityListFieldsSelectedSettings | OpportunityListFieldsSelectedSettings | 必須。売上予測種別の売上予測ページの商談ペインに表示するために選択された項目。選択した項目の 1 つが [商談名] である必要があります。15 項目まで選択できます。 |
| opportunityListFieldsUnselectedSettings | OpportunityListFieldsUnselectedSettings | 必須。売上予測種別の売上予測ページの商談ペインに表示される対象として選択されていない項目。 |
| opportunitySplitName | string | 売上予測種別に分割種別があるかどうか、ある場合はその分割種別名を示します。API バージョン 41.0 以降で利用できます。 |
| ownerAdjustableCategoryApiNames | string | この参照のみの項目は、累積売上予測積み上げ集計または個々の売上予測分類積み上げ集計について、組織で売上予測所有者が調整可能な 2 つの売上予測積み上げ集計カテゴリを指定するために 2 回出現します。この項目は、enableOwnerAdjustments 項目の値が true の場合にのみ使用できます。managerAdjustableCategoryApiNames および ownerAdjustableCategoryApiNames の両方の項目が使用されている場合、同じ 2 つの値が含まれている必要があります。それらの値は、enableAdjustments および enableOwnerAdjustments 項目の値と一致する必要もあります。 累積売上予測積み上げ集計を使用する組織の有効値は次のとおりです。
個々の売上予測分類積み上げ集計を使用する組織の有効値は次のとおりです。
|
| quotasSettings | QuotasSettings | 削除済み。この項目は、コラボレーション売上予測の目標オプションを有効または無効にします。API バージョン 53.0 以降では、globalQuotasSettings を使用します。 |
| territory2ModelName | string | 売上予測種別に Territory2 モデルがあるかどうか、ある場合はその Territory2 モデル名を示します。API バージョン 41.0 以降で利用できます。 |
AdjustmentsSettings
| 項目 | 項目の型 | 説明 |
|---|---|---|
| enableAdjustments | boolean | 必須。コラボレーション売上予測マネージャによる調整を有効にするには true に設定し、無効にするには false に設定します。すべての売上予測種別には、同じ enableAdjustments 値が含まれている必要があります。 調整を無効にすると、コラボレーション売上予測調整データが消去されます。 |
| enableOwnerAdjustments | boolean | 必須。コラボレーション売上予測所有者による調整を有効にするには true に設定し、無効にするには false に設定します。すべての売上予測種別には、同じ enableAdjustments 値が含まれている必要があります。 調整を無効にすると、コラボレーション売上予測調整データが消去されます。 |
ForecastRangeSettings
コラボレーション売上予測のデフォルトの期間と範囲の選択。ユーザは、過去または将来の 15 か月、15 会計期間、または 8 四半期までの売上予測が可能です。売上予測範囲に当月、当期間、または当四半期が含まれている場合、売上予測ページにはデフォルトで当月、当期間、または当四半期が表示されます。含まれていない場合は、範囲の最初の月、期間、または四半期が選択されます。すべての売上予測種別には、同じ forecastRangeSettings 項目値が含まれている必要があります。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| beginning | int | 必須。デフォルトで表示する開始月または開始四半期を示します。 |
| displaying | int | 必須。デフォルトで表示する月数または四半期数を示します。最大月数は 12、最大四半期数は 8 です。 |
| periodType | PeriodTypes (string 型の列挙) | 必須。使用する期間の種別を示します。有効な値は、次のとおりです。
|
OpportunityListFieldsLabelMapping
商談オブジェクトのすべての項目の API 名と UI 表示ラベルの参照のみリスト。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| field | string | 必須。商談項目の API 名。 |
| label | string | 必須。商談項目の UI 表示ラベル。 |
OpportunityListFieldsSelectedSettings
売上予測種別の売上予測ページの商談ペインに表示するために選択された項目。選択した項目の 1 つが [商談名] である必要があります。15 項目まで選択できます。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| field | string | 商談ペインに表示する項目名を指定します。 |
OpportunityListFieldsUnselectedSettings
売上予測種別の売上予測ページの商談ペインに表示される対象として選択されていない項目。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| field | string | 商談ペインに表示しない項目名を指定します。 |
QuotasSettings
QuotasSettings は、コラボレーション売上予測で目標を使用できるかどうかを示します。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| showQuotas | boolean | 必須。目標を有効にするには、true に設定します。すべての売上予測種別には、同じ showQuotas 項目値が含まれている必要があります。 |
WeightedSourceCategory
この項目は、複数の売上予測分類を積み上げ集計種別に含めるように指定した場合、複数回出現します。各出現箇所には、売上予測積み上げ集計種別に含める売上予測分類とその加重を指定する 2 つのサブ項目が含まれます。一部の積み上げ集計種別には、複数の売上予測分類が含まれます。次の表は、各積み上げ集計種別に含まれる売上予測分類を示します。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| sourceCategoryApiName | string | 必須。積み上げ集計種別に含める売上予測分類の API 名を指定します。有効な値は、次のとおりです。
|
| weight | double | 必須。積み上げ集計種別の売上予測を計算するときに売上予測分類に指定される加重を指定します。サポートされている値は、1.0 のみです。 |
宣言的なメタデータの定義のサンプル
次に、商談収益の売上予測種別、調整、所有者による調整、および目標を有効にし、売上予測範囲の設定を変更する ForecastingSettings コンポーネントの例を示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<ForecastingSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3 <defaultToPersonalCurrency>false</defaultToPersonalCurrency>
4 <enableForecasts>true</enableForecasts>
5 <globalAdjustmentsSettings>
6 <enableAdjustments>true</enableAdjustments>
7 <enableOwnerAdjustments>true</enableOwnerAdjustments>
8 </globalAdjustmentsSettings>
9 <globalForecastRangeSettings>
10 <beginning>1</beginning>
11 <displaying>6</displaying>
12 <periodType>Month</periodType>
13 </globalForecastRangeSettings>
14 <globalQuotasSettings>
15 <showQuotas>true</showQuotas>
16 </globalQuotasSettings>
17 <forecastingCategoryMappings>
18 <forecastingItemCategoryApiName>commitonly</forecastingItemCategoryApiName>
19 <weightedSourceCategories>
20 <sourceCategoryApiName>commit</sourceCategoryApiName>
21 <weight>1.0</weight>
22 </weightedSourceCategories>
23 </forecastingCategoryMappings>
24 <forecastingCategoryMappings>
25 <forecastingItemCategoryApiName>closedonly</forecastingItemCategoryApiName>
26 <weightedSourceCategories>
27 <sourceCategoryApiName>closed</sourceCategoryApiName>
28 <weight>1.0</weight>
29 </weightedSourceCategories>
30 </forecastingCategoryMappings>
31 <forecastingCategoryMappings>
32 <forecastingItemCategoryApiName>openpipeline</forecastingItemCategoryApiName>
33 <weightedSourceCategories>
34 <sourceCategoryApiName>most likely</sourceCategoryApiName>
35 <weight>1.0</weight>
36 </weightedSourceCategories>
37 <weightedSourceCategories>
38 <sourceCategoryApiName>commit</sourceCategoryApiName>
39 <weight>1.0</weight>
40 </weightedSourceCategories>
41 <weightedSourceCategories>
42 <sourceCategoryApiName>pipeline</sourceCategoryApiName>
43 <weight>1.0</weight>
44 </weightedSourceCategories>
45 <weightedSourceCategories>
46 <sourceCategoryApiName>best case</sourceCategoryApiName>
47 <weight>1.0</weight>
48 </weightedSourceCategories>
49 </forecastingCategoryMappings>
50 <forecastingCategoryMappings>
51 <forecastingItemCategoryApiName>omittedonly</forecastingItemCategoryApiName>
52 <weightedSourceCategories>
53 <sourceCategoryApiName>omitted</sourceCategoryApiName>
54 <weight>1.0</weight>
55 </weightedSourceCategories>
56 </forecastingCategoryMappings>
57 <forecastingCategoryMappings>
58 <forecastingItemCategoryApiName>bestcaseforecast</forecastingItemCategoryApiName>
59 <weightedSourceCategories>
60 <sourceCategoryApiName>most likely</sourceCategoryApiName>
61 <weight>1.0</weight>
62 </weightedSourceCategories>
63 <weightedSourceCategories>
64 <sourceCategoryApiName>commit</sourceCategoryApiName>
65 <weight>1.0</weight>
66 </weightedSourceCategories>
67 <weightedSourceCategories>
68 <sourceCategoryApiName>closed</sourceCategoryApiName>
69 <weight>1.0</weight>
70 </weightedSourceCategories>
71 <weightedSourceCategories>
72 <sourceCategoryApiName>best case</sourceCategoryApiName>
73 <weight>1.0</weight>
74 </weightedSourceCategories>
75 </forecastingCategoryMappings>
76 <forecastingCategoryMappings>
77 <forecastingItemCategoryApiName>pipelineonly</forecastingItemCategoryApiName>
78 <weightedSourceCategories>
79 <sourceCategoryApiName>pipeline</sourceCategoryApiName>
80 <weight>1.0</weight>
81 </weightedSourceCategories>
82 </forecastingCategoryMappings>
83 <forecastingCategoryMappings>
84 <forecastingItemCategoryApiName>commitforecast</forecastingItemCategoryApiName>
85 <weightedSourceCategories>
86 <sourceCategoryApiName>closed</sourceCategoryApiName>
87 <weight>1.0</weight>
88 </weightedSourceCategories>
89 <weightedSourceCategories>
90 <sourceCategoryApiName>commit</sourceCategoryApiName>
91 <weight>1.0</weight>
92 </weightedSourceCategories>
93 </forecastingCategoryMappings>
94 <forecastingCategoryMappings>
95 <forecastingItemCategoryApiName>bestcaseonly</forecastingItemCategoryApiName>
96 <weightedSourceCategories>
97 <sourceCategoryApiName>best case</sourceCategoryApiName>
98 <weight>1.0</weight>
99 </weightedSourceCategories>
100 </forecastingCategoryMappings>
101 <forecastingTypeSettings>
102 <name>OpportunityRevenue</name>
103 <active>true</active>
104 <hasProductFamily>false</hasProductFamily>
105 <isAmount>true</isAmount>
106 <isAvailable>true</isAvailable>
107 <isQuantity>false</isQuantity>
108 <managerAdjustableCategoryApiNames>commitonly</managerAdjustableCategoryApiNames>
109 <managerAdjustableCategoryApiNames>bestcaseonly</managerAdjustableCategoryApiNames>
110 <masterLabel>Opportunities</masterLabel>
111 <displayedCategoryApiNames>closedonly</displayedCategoryApiNames>
112 <displayedCategoryApiNames>commitonly</displayedCategoryApiNames>
113 <displayedCategoryApiNames>bestcaseonly</displayedCategoryApiNames>
114 <displayedCategoryApiNames>pipelineonly</displayedCategoryApiNames>
115 <forecastedCategoryApiNames>commitonly</forecastedCategoryApiNames>
116 <forecastedCategoryApiNames>closedonly</forecastedCategoryApiNames>
117 <forecastedCategoryApiNames>pipelineonly</forecastedCategoryApiNames>
118 <forecastedCategoryApiNames>bestcaseonly</forecastedCategoryApiNames>
119 <forecastingDateType>OpportunityCloseDate</forecastingDateType>
120 <opportunityListFieldsSelectedSettings>
121 <field>OPPORTUNITY.NAME</field>
122 </opportunityListFieldsSelectedSettings>
123 </forecastingTypeSettings>
124</ForecastingSettings>マニフェストファイル内のワイルドカードのサポート
package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) は、機能設定のメタデータ型には適用されません。ワイルドカードは、個々の設定ではなくすべての設定を取得するときにのみ適用されます。詳細は、「設定」を参照してください。マニフェストファイル��使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。