OpportunitySettings | Metadata API Developer Guide

Use opportunity settings to control the actions that users can perform on their opportunities.

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

Opportunities values are stored in a single file named Opportunity.settings in the settings directory of the corresponding package directory. The .settings files are different from other named components because there is only one settings file for each settings component.

Version

OpportunitySettings is available in API version 28.0 and later.

Fields

Field Name	Field Type	Description
autoActivateNewReminders	boolean	Automatically uses scheduled updates for new opportunities.
customizableProductSchedulesEnabled	boolean	Lets Salesforce admins customize product schedules by using custom fields, validation rules, and Apex triggers on the LineItemSchedule object. This field is available in API version 46.0 and later. If customizable product schedules are enabled, you can use custom fields in default schedules and customize their layout, but Apex triggers or validation rules that you apply to default schedules are bypassed. Note
doesAutoAddSplitOwnerAsOpportunityTeamMember	boolean	If `true`, members are automatically added to opportunity teams when a user edits the opportunity splits. If `false`, users must use the opportunity team's related list to add members. Default value is `true` for Enterprise, Performance, Developer, and Ultimate Editions. Available in API version 47.0 and later.
doesEnforceStandardOpportunitySaveLogic	boolean	Enforces standard validation and triggers for opportunity products and opportunity product schedules. Default value is `true`. Can't be set to `false`. Available in API version 47.0 and later.
enableUpdateReminders	boolean	Lets users enable automatic, scheduled updates on opportunities.
enableFindSimilarOpportunities	boolean	Lets users see related or similar existing opportunities.
enableOpportunityFieldHistoryTracking	boolean	Enables history tracking for the opportunity field. For more information, see “Field History Tracking” in Salesforce Help. Default value is `true`. Available in API version 47.0 and later.
enableOpportunityInsightsInMobile	boolean	Indicates whether a user can see Einstein Opportunity Insights on their mobile device `(true)` or not `(false)`. Einstein Opportunity Insights includes predictions about which deals are likely to be won, reminders to follow up, and notifications when key moments in a deal take place. Available in API version 47.0 and later.
enableOpportunityTeam	boolean	Lets users associate team members with opportunities.
findSimilarOppFilter	FindSimilarOppFilter	Defines parameters for similar opportunities.
promptToAddProducts	boolean	Prompts users to add related products to an opportunity.

FindSimilarOppFilter

Defines whether to match by entire columns or fields.

Field	Field Type	Description
similarOpportunitiesDisplayColumns	string	The columns to compare.
similarOpportunitiesMatchFields	string	The fields to compare.

Declarative Metadata Sample Definition

The following is an example of the package file.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>Opportunity</members>
5        <name>Settings</name>
6    </types>
7    <version>28.0</version>
8</Package>

The package file references the following Opportunity.settings file.

1<?xml version="1.0" encoding="UTF-8"?>
2<OpportunitySettings xmlns="http://soap.sforce.com/2006/04/metadata">
3  <autoActivateNewReminders>true</autoActivateNewReminders>
4  <customizableProductSchedulesEnabled>false</customizableProductSchedulesEnabled>
5  <doesAutoAddSplitOwnerAsOpportunityTeamMember>true</doesAutoAddSplitOwnerAsOpportunityTeamMember>
6  <doesEnforceStandardOpportunitySaveLogic>true</doesEnforceStandardOpportunitySaveLogic>
7  <enableFindSimilarOpportunities>true</enableFindSimilarOpportunities>
8  <findSimilarOppFilter>
9    <similarOpportunitiesMatchFields>OPPORTUNITY.Account</similarOpportunitiesMatchFields>
10    <similarOpportunitiesMatchFields>OPPORTUNITY.OpportunityCompetitors</similarOpportunitiesMatchFields>
11    <similarOpportunitiesMatchFields>CustomField__c</similarOpportunitiesMatchFields>
12    <similarOpportunitiesDisplayColumns>CustomField__c</similarOpportunitiesDisplayColumns>
13  </findSimilarOppFilter>
14  <enableOpportunityFieldHistoryTracking>true</enableOpportunityFieldHistoryTracking>
15  <enableOpportunityInsightsInMobile>true</enableOpportunityInsightsInMobile>
16  <enableOpportunityTeam>true</enableOpportunityTeam>
17  <enableUpdateReminders>true</enableUpdateReminders>
18  <promptToAddProducts>true</promptToAddProducts>
19</OpportunitySettings>

Wildcard Support in the Manifest File

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.