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

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

パッケージマニフェストでは、Settings の名前を使用してすべての組織設定メタデータ型にアクセスします。詳細は「設定」を参照してください。

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

SalesAgreementSettings の値は、SalesAgreementSettings ディレクトリの SalesAgreementSettings.salesAgreementSetting ファイルに保存されます。

バージョン

SalesAgreementSettings コンポーネントは、API バージョン 47.0 以降で使用できます。

項目

項目名	項目の型	説明
actualsCalculationMode	ActualsCalculationMode(string 型の列挙)	必須。販売計画の商品の実際の注文数を算出するための取得元。有効な値は、次のとおりです。 `Manual: デフォルト` `Orders` `OrdersThroughContracts`
displayGroups	AdvAcctFrcstDisplayGroup	高度な取引先販売予測セットの指標またはディメンションのグループに関する情報を表します。API バージョン 56.0 以降で利用できます。
displayedAgreementTermsMetrics	string	必須。販売計画期間で指定した順序で表示するために選択する指標。このリストには、カンマ区切りで指標の名前を最大 10 個まで含めることができます。
isOnlyApprovalProcessUsed	boolean	必須。承認フローで、自己承認と販売計画の承認の両方が可能か (`true`)、販売計画の承認のみが可能か (`false`) を示します。
measureDefinitions	AdvAcctForecastMeasureDef	販売予測セットの高度な取引先販売予測グリッドに表示する指標についての情報を表します。API バージョン 56.0 以降で利用できます。
objectMapping	ObjectMapping	SalesAgreementSettings の入力オブジェクトの項目を SalesAgreementSettings の出力オブジェクトの項目に対応付ける、ObjectMapping の外部キー。
primaryNotifEmailAddress	string	通知の送信先となるメールアドレス。
renewalPeriodDayCount	int	販売計画の更新が可能になる、販売計画の終了日前の日数。API バージョン 50.0 以降で利用できます。
secondaryNotifEmailAddress	string	通知を送信する 2 番目のメールアドレス。

AdvAcctFrcstDisplayGroup

高度な取引先販売予測セットの指標またはディメンションのグループに関する情報を表します。API バージョン 56.0 以降で利用できます。

項目名	項目の型	説明
advAcctFrcstDisplayGroupName	string	必須。高度な取引先販売予測の表示グループの名前。
displayGroupItems	AdvAcctFrcstDplyGroupItem	高度な取引先販売予測セットの表示グループに関連付けられた項目についての情報を表します。
displayGroupType	AdvAcctFrcstDisplayGroupType(string 型の列挙)	表示グループのカテゴリ。可能な値は次のとおりです。 `MEASURE`
isDefault	boolean	表示グループがデフォルトのグループであるか (`true`)、否か (`false`) を示します。デフォルト値は `false` です。
userProfileName	string	表示グループが適用されるプロファイル。

AdvAcctFrcstDplyGroupItem

高度な取引先販売予測セットの表示グループに関連付けられた項目についての情報を表します。API バージョン 56.0 以降で利用できます。

項目名	項目の型	説明
advAcctFrcstDplyGroupItemName	string	必須。高度な取引先販売予測の表示グループ項目の名前。
displayOrder	string	必須。表示グループ項目の表示順序。
measureReferenceName	string	表示グループ項目に関連付けられた指標の名前。

AdvAcctForecastMeasureDef

販売予測セットの高度な取引先販売予測グリッドに表示する指標についての情報を表します。API バージョン 56.0 以降で利用できます。

項目名	項目の型	説明
advAcctForecastMeasureDefName	string	必須。指標の名前。
aggregationType	AdvAcctFcstAggregationType(string 型の列挙)	必須。高度な取引先販売予測値を計算するために使用する集計の種別。可能な値は次のとおりです。 `AVERAGE` `MAXIMUM` `MINIMUM` `SUM`
computationMethod	AdvAcctFcstComputationMethod (string 型の列挙)	必須。高度な取引先販売予測の値を計算するために使用するメソッド。可能な値は次のとおりです。 `CUSTOM` `DATA_PROCESSING_ENGINE_DEFINITION` `FORMULA`
forecastDataMeasureName	string	必須。この指標に使用する結果オブジェクトの項目。
forecastMeasureName	string	必須。UI で表示する指標の名前。
forecastMeasureType	AdvAcctFcstMeasureType(string 型の列挙)	必須。生成される高度な販売予測値に使用する指標種別。可能な値は次のとおりです。 `QUANTITY` `REVENUE`
isAdjustmentTracked	boolean	この指標の高度な取引先販売予測値への調整を追跡するか (`true`)、否か (`false`) を示します。デフォルト値は `false` です。

ObjectMapping

SalesAgreementSettings の入力オブジェクトの項目と SalesAgreementSettings の出力オブジェクトの項目との対応付けを表します。入力オブジェクトは SalesAgreementProductSchedule です。出力オブジェクトは SalesAgreementProduct です。

項目名	項目の型	説明
inputObject	string	必須。SalesAgreementSettings の入力オブジェクト。SalesAgreementProductSchedule は、SalesAgreementSettings に対する入力オブジェクトです。
mappingFields	ObjectMappingField	SalesAgreementSettings の参照元オブジェクト項目と参照先オブジェクト項目の対応付け。
outputObject	string	必須。SalesAgreementSettings の出力オブジェクト。SalesAgreementProduct は、SalesAgreementSettings の出力オブジェクトです。

ObjectMappingField

SalesAgreementProductSchedule オブジェクトの項目名と、SalesAgreementProduct オブジェクトの対応する項目名。

たとえば、SalesAgreementProductSchedule オブジェクトに Revenue という項目を作成し、SalesAgreementProduct オブジェクトに Total Revenue という項目を作成できます。販売計画の計画期間にこれらの項目値を表示するには、入力オブジェクトに SalesAgreementProductSchedule、出力オブジェクトに SalesAgreementProduct を選択します。この場合、入力項目は収益であり、出力オブジェクトは合計収益です。

項目名	項目の型	説明
inputField	string	必須。ObjectMapping の inputObject 項目によって指定されるオブジェクトの項目。この項目は outputField の項目に対応付けられます。outputField は、ObjectMapping の outputObject 項目によって指定されるオブジェクトの項目です。
outputField	string	必須。ObjectMapping の outputObject 項目によって指定されるオブジェクトの項目。この項目は inputField の項目名に対応付けられます。inputField は、ObjectMapping の inputObject によって指定されるオブジェクトの項目です。

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

SalesAgreementSettings コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<SalesAgreementSettings
3	xmlns="http://soap.sforce.com/2006/04/metadata"
4	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
5	<actualsCalculationMode>Orders</actualsCalculationMode>
6	<displayGroups>
7		<advAcctFrcstDisplayGroupName>Test Measure Group</advAcctFrcstDisplayGroupName>
8		<displayGroupItems>
9			<advAcctFrcstDplyGroupItemName>PlannedQuantity</advAcctFrcstDplyGroupItemName>
10			<displayOrder>1</displayOrder>
11			<measureReferenceName>PlannedQuantity</measureReferenceName>
12		</displayGroupItems>
13		<displayGroupType>MEASURE</displayGroupType>
14		<isDefault>false</isDefault>
15		<userProfileName xsi:nil="true"/>
16	</displayGroups>
17	<displayedAgreementTermsMetrics>PlannedQuantity,ActualQuantity,SalesPrice,DiscountPercentage,DerivedPlannedAmount</displayedAgreementTermsMetrics>
18	<isOnlyApprovalProcessUsed>false</isOnlyApprovalProcessUsed>
19	<measureDefinitions>
20		<advAcctForecastMeasureDefName>PlannedQuantity</advAcctForecastMeasureDefName>
21		<aggregationType>MINIMUM</aggregationType>
22		<computationMethod>DATA_PROCESSING_ENGINE_DEFINITION</computationMethod>
23		<forecastDataMeasureName>PlannedQuantity</forecastDataMeasureName>
24		<forecastMeasureName>PlannedQuantity</forecastMeasureName>
25		<forecastMeasureType>QUANTITY</forecastMeasureType>
26		<isAdjustmentTracked>true</isAdjustmentTracked>
27	</measureDefinitions>
28	<secondaryNotifEmailAddress>abc@salesforce.com</secondaryNotifEmailAddress>
29	<primaryNotifEmailAddress>abc@salesforce.com</primaryNotifEmailAddress>
30	<renewalPeriodDayCount>50</renewalPeriodDayCount>
31	<objectMapping>
32		<inputObject>SalesAgreementProductSchedule</inputObject>
33		<mappingFields>
34			<inputField>SAPS1__c</inputField>
35			<outputField>SAP1__c</outputField>
36		</mappingFields>
37		<outputObject>SalesAgreementProduct</outputObject>
38	</objectMapping>
39</SalesAgreementSettings>

前の定義を参照する package.xml の例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3     <types>   
4         <members>SalesAgreementProduct.SAP1__c</members>
5         <members>SalesAgreementProductSchedule.SAPS1__c</members>
6         <name>CustomField</name>
7     </types>
8     <types>
9         <members>*</members>
10         <name>SalesAgreementSettings</name>
11     </types>
12     <version>60.0</version>
13</Package>

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。