Metadata API Developer Guide
jNewer Version Available
OpportunitySettings
Represents organization preferences for features such as automatic opportunity updates and similar-opportunity filters. This type extends the Metadata metadata type and inherits its fullName field.
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 |
|---|---|---|
| enableUpdateReminders | boolean | Lets users enable automatic, scheduled updates on opportunities. |
| autoActivateNewReminders | boolean | Automatically uses scheduled updates for new opportunities. |
| enableFindSimilarOpportunities | boolean | Lets users see related or similar existing opportunities. |
| findSimilarOppFilter | multipicklist | Defines parameters for similar opportunities. |
| enableOpportunityTeam | boolean | Lets users associate team members with 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 <enableFindSimilarOpportunities>true</enableFindSimilarOpportunities>
5 <findSimilarOppFilter>
6 <similarOpportunitiesMatchFields>OPPORTUNITY.Account</similarOpportunitiesMatchFields>
7 <similarOpportunitiesMatchFields>OPPORTUNITY.OpportunityCompetitors</similarOpportunitiesMatchFields>
8 <similarOpportunitiesMatchFields>CustomField__c</similarOpportunitiesMatchFields>
9 <similarOpportunitiesDisplayColumns>CustomField__c</similarOpportunitiesDisplayColumns>
10 </findSimilarOppFilter>
11 <enableOpportunityTeam>true</enableOpportunityTeam>
12 <enableUpdateReminders>true</enableUpdateReminders>
13 <promptToAddProducts>false</promptToAddProducts>
14</OpportunitySettings>