Newer Version Available

This content describes an older version of this product. View Latest

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.

The package file references the following Opportunity.settings file.