SalesAgreementSettings | Metadata API Developer Guide

This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See Settings for more details.

File Suffix and Directory Location

SalesAgreementSettings values are stored in the SalesAgreementSettings.salesAgreementSetting file in the salesAgreementSettings directory.

Version

SalesAgreementSettings components are available in API version 47.0 and later.

Fields

Field Name	Field Type	Description
actualsCalculationMode	ActualsCalculationMode(enumeration of type string)	Required. Source from which the actual ordered quantity of a product in a sales agreement is calculated. Valid values are: `Manual: Default` `Orders` `OrdersThroughContracts`
displayGroups	AdvAcctFrcstDisplayGroup	Represents information about the groups for the advanced account forecast set measures or dimensions. Available in API version 56.0 and later.
displayedAgreementTermsMetrics	string	Required. Metrics that are selected for display in the sales agreement terms in the specified sequence. There can be a maximum of 10 comma-separated metric names in this list.
isOnlyApprovalProcessUsed	boolean	Required. Indicates whether both self-approval and approval of sales agreements are allowed (`true`) or only approval of sales agreements is allowed `false`) through the Approval Flow.
measureDefinitions	AdvAcctForecastMeasureDef	Represents information about the measures to be displayed in the advanced account forecasts grid for the forecast set. Available in API version 56.0 and later.
objectMapping	ObjectMapping	Foreign key to ObjectMapping that maps fields from the input object of SalesAgreementSettings to fields in the output object of SalesAgreementSettings.
primaryNotifEmailAddress	string	The email address to which notifications are sent.
renewalPeriodDayCount	int	The number of days before the end date of a sales agreement from when the agreement can be renewed. Available in API version 50.0 and later.
secondaryNotifEmailAddress	string	The second email address to which notifications are sent.

AdvAcctFrcstDisplayGroup

Represents information about the groups for the advanced account forecast set measures or dimensions. Available in API version 56.0 and later.

Field Name	Field Type	Description
advAcctFrcstDisplayGroupName	string	Required. Name of the advanced account forecast display group.
displayGroupItems	AdvAcctFrcstDplyGroupItem	Represents information about the items associated with a display group for an advanced account forecast set.
displayGroupType	AdvAcctFrcstDisplayGroupType(enumeration of type string)	Category for the display group. Possible values are: `MEASURE`
isDefault	boolean	Indicates whether the display group is the default group (`true`) or not (`false`). The default value is `false`.
userProfileName	string	Profile for which the display group is applicable.

AdvAcctFrcstDplyGroupItem

Represents information about the items associated with a display group for an advanced account forecast set. Available in API version 56.0 and later.

Field Name	Field Type	Description
advAcctFrcstDplyGroupItemName	string	Required. Name of the advanced account forecast display group item.
displayOrder	string	Required. Display order of the display group item.
measureReferenceName	string	Name of the measure associated with the display group item.

AdvAcctForecastMeasureDef

Represents information about the measures to be displayed in the advanced account forecasts grid for the forecast set. Available in API version 56.0 and later.

Field Name	Field Type	Description
advAcctForecastMeasureDefName	string	Required. Name for the measure.
aggregationType	AdvAcctFcstAggregationType(enumeration of type string)	Required. Type of aggregation used for calculating advanced account forecast values. Possible values are: `AVERAGE` `MAXIMUM` `MINIMUM` `SUM`
computationMethod	AdvAcctFcstComputationMethodenumeration of type string)	Required. Method used for calculating advanced account forecast values. Possible values are: `CUSTOM` `DATA_PROCESSING_ENGINE_DEFINITION` `FORMULA`
forecastDataMeasureName	string	Required. Field of the facts object used for this measure.
forecastMeasureName	string	Required. Name for the measure to show on UI.
forecastMeasureType	AdvAcctFcstMeasureType(enumeration of type string)	Required. Measure type used for the generated advanced forecast values. Possible values are: `QUANTITY` `REVENUE`
isAdjustmentTracked	boolean	Indicates whether the adjustments made to the advanced account forecast values for this metric are tracked (`true`) or not (`false`). The default value is `false`.

ObjectMapping

Represents a map of fields in the input object of SalesAgreementSettings to fields in the output object of SalesAgreementSettings. The input object is SalesAgreementProductSchedule. The output object is SalesAgreementProduct.

Field Name	Field Type	Description
inputObject	string	Required. The input object for the SalesAgreementSettings. SalesAgreementProductSchedule is the input object for the SalesAgreementSettings.
mappingFields	ObjectMappingField	The mapping of source object fields to target object fields for SalesAgreementSettings.
outputObject	string	Required. The output object for the SalesAgreementSettings. SalesAgreementProduct is the output object for the SalesAgreementSettings.

ObjectMappingField

A field name in the SalesAgreementProductSchedule object and the corresponding field name in the SalesAgreementProduct object.

For example, you can create a field named Revenue on the SalesAgreementProductSchedule object and a field named Total Revenue on the SalesAgreementProduct object. To view these field values in the agreement terms of a sales agreement, select the input object as SalesAgreementProductSchedule and the output object as SalesAgreementProduct. In this case, the input field is Revenue and the output field is Total Revenue.

Field Name	Field Type	Description
inputField	string	Required. Field in the object specified by the inputObject field in ObjectMapping. This field is mapped to the field in outputField, which is a field in the object specified by the outputObject field in ObjectMapping.
outputField	string	Required. Field in the object specified by the outputObject field in ObjectMapping. This field is mapped to the field name in inputField, which is a field in the object specified by the inputObject field in ObjectMapping.

Declarative Metadata Sample Definition

The following is an example of SalesAgreementSettings component.

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>

The following is an example package.xml that references the previous definition.

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>62.0</version>
13</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.