---
schema_version: "1"
id: 70be535a3a4fbdd7e07a9fe67c41c25949e9138586f7827277ca579a27e1e56c
title: OpportunitySettings
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_opportunityssettings.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_opportunityssettings.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 201e1f9e5893371f7061762d5ddcfcb047c06d60aedab4c43277ecc207ebd7e3
description: Represents org preferences for features such as automatic opportunity updates and similar-opportunity filters.
---
# OpportunitySettings

Represents org preferences for features such as automatic opportunity updates and similar-opportunity filters.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for 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.

## Version

OpportunitySettings is available in API version 28.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d721353e114">Field Name</th>

              <th class="featureTableHeader  " id="d721353e117">Field Type</th>

              <th class="featureTableHeader  " id="d721353e120">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">autoActivateNewReminders</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Automatically uses scheduled updates for new
                opportunities.</td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">customizableProductSchedulesEnabled</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">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. <p class="p">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.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">doesEnforceStandardOpportunitySaveLogic</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Enforces standard validation and triggers for opportunity
                products and opportunity product schedules. Default value is <samp class="codeph nolang">true</samp>. Can't be set to <samp class="codeph nolang">false</samp>. <p class="p">Available in API version
                  47.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">enableExpandedPipelineInspectionSetup</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type"></td>

              <td class="entry" headers="d721353e120" data-title="Description">Displays a Pipeline Inspection setup page to Salesforce admins
                with all setup steps for enabling and configuring the feature. The
                set up also includes historical trending. The default value is
                false.<p class="p">Available in API version 52.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">enableFindSimilarOpportunities</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Lets users see related or similar existing opportunities.</td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">enableForecastCategoryMetrics</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Lets users see single and cumulative forecast category rollups
                over a selected period. Applies to the following categories: Best
                Case, Closed Lost, Closed Won, Commit, Most Likely, Open Pipeline,
                and Total. <p class="p">Default value is <samp class="codeph nolang">true</samp>. Available in API version 57.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">enableOpportunityFieldHistoryTracking</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Enables history tracking for the opportunity field. For more
                information, see “Field History Tracking” in Salesforce Help.
                Default value is <samp class="codeph nolang">true</samp>.
                <p class="p">Available in API version 47.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">enableOpportunityInsightsInMobile</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Deprecated in API version 59.0 and later because the feature is
                no longer available. Indicates whether a user can see Einstein
                Opportunity Insights on their mobile device <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>. 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. <p class="p">Available in API version 47.0 to
                  58.0.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">enableOpportunityTeam</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Lets users associate team members with opportunities.</td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">enablePipelineChangesMetrics</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Lets users see net change to the pipeline (positive or negative)
                contributed by each deal within a selected timeframe. Applies to the
                following categories: Open Pipeline, New, Won, Increased, Moved In,
                Moved Out, Decreased, Lost, and Overdue. <p class="p">Default value is <samp class="codeph nolang">true</samp>. Available in API version
                  57.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">enablePipelineInspection</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Enables the Pipeline Inspection feature in the Opportunity tab.
                Also enables historical trending for opportunities, if the org has
                the historical trending org perm. Pipeline Inspection is a
                consolidated view of pipeline metrics, corresponding opportunities,
                and highlights of recent opportunity changes and insights. The
                default value is false.<p class="p">Also enables historical trending for
                  opportunities, if historical trending isn’t already enabled. To
                  use Pipeline Inspection, additional configuration in Setup is
                  required.</p>
                <p class="p">Available in API version 52.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">enablePipelineInspectionFlow</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Enables the Pipeline Inspection Flow Chart in the Opportunity
                tab. This chart shows Pipeline Inspection users the changes to
                opportunities in different forecast categories over time. Users can
                filter results to see the data that’s most useful to them.<p class="p">To use
                  this feature, access to Revenue Insights is
                  required.</p>
                <p class="p">Available in API version 54.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">enablePipelineInspectionSingleCategoryRollup</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Indicates that Pipeline Inspection metrics display as single
                forecast categories <samp class="codeph nolang">(true)</samp>, or
                multiple categories rolled up <samp class="codeph nolang">(false)</samp>. The default value is <samp class="codeph nolang">(false)</samp>.<p class="p">To use this feature,
                  Pipeline Inspection configuration in Setup is
                  required.</p>
                <p class="p">Available in API version 55.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">enableRevenueInsights</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Sets up Revenue Insights dashboards and installs the related CRM
                Analytics app. The dashboards give users access to sales
                performance, pipeline, and forecasting reports and
                analytics.<p class="p">Revenue Insights is part of Revenue Intelligence,
                  which is available for an additional cost.</p>
                <p class="p">Available in
                  API version 54.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">enableServiceCaseInsights</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Indicates whether insights based on service cases are enabled
                <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp> in Pipeline Inspection. The
                default value is <samp class="codeph nolang">(false)</samp>.<p class="p">Available in API version 55.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">enableUpdateReminders</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Lets users enable automatic, scheduled updates on
                opportunities.</td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">findSimilarOppFilter</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type"><a class="xref" href="#FindSimilarOppFilter">FindSimilarOppFilter</a></td>

              <td class="entry" headers="d721353e120" data-title="Description">Defines parameters for similar opportunities.</td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">oppAmountDealMotionEnabled</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Indicates whether deal change highlights are enabled for
                opportunity amounts <samp class="codeph nolang">(true)</samp> or
                not <samp class="codeph nolang">(false)</samp>. The default value
                is <samp class="codeph nolang">(true)</samp>.<p class="p">Available in API
                  version 50.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">oppCloseDateDealMotionEnabled</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Indicates whether deal change highlights are enabled for
                opportunity close dates <samp class="codeph nolang">(true)</samp>
                or not <samp class="codeph nolang">(false)</samp>. The default
                value is <samp class="codeph nolang">(true)</samp>.<p class="p">Available in
                  API version 50.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">promptToAddProducts</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Prompts users to add related products to an opportunity.</td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">pushCountEnabled</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Indicates whether the Push Count field is visible to users in
                opportunity list views and Pipeline Inspection views <samp class="codeph nolang">(true)</samp> or not (<samp class="codeph nolang">false</samp>). The default value is
                (<samp class="codeph nolang">true</samp>).<p class="p">Available in API
                  version 56.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">simpleOppCreateFromContact</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Indicates whether you can create an opportunity with prefilled
                information (such as the contact’s account) from the Global Actions
                menu while viewing a contact <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>. Available in API version 54.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d721353e114" data-title="Field Name"><span class="keyword parmname">simpleOppCreateFromEvent</span></td>

              <td class="entry" headers="d721353e117" data-title="Field Type">boolean</td>

              <td class="entry" headers="d721353e120" data-title="Description">Indicates whether you can create an opportunity with prefilled
                information (such as the event’s account) from the Global Actions
                menu while viewing an event <samp class="codeph nolang">(true)</samp> or not <samp class="codeph nolang">(false)</samp>. Available in API version 54.0 and
                later.</td>

            </tr>

          </tbody>

        </table>

## 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.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Opportunity</members\>
        <name\>Settings</name\>
    </types\>
    <version\>28.0</version\>
</Package\>

The package file references the following Opportunity.settings file.

<?xml version="1.0" encoding="UTF-8"?>
<OpportunitySettings xmlns="http://soap.sforce.com/2006/04/metadata">
  <autoActivateNewReminders\>true</autoActivateNewReminders\>
  <customizableProductSchedulesEnabled\>false</customizableProductSchedulesEnabled\>
  <doesEnforceStandardOpportunitySaveLogic\>true</doesEnforceStandardOpportunitySaveLogic\>
  <enableFindSimilarOpportunities\>true</enableFindSimilarOpportunities\>
  <enableForecastCategoryMetrics\>true</enableForecastCategoryMetrics\>
  <enablePipelineChangesMetrics\>true</enablePipelineChangesMetrics\>
  <findSimilarOppFilter\>
    <similarOpportunitiesMatchFields\>OPPORTUNITY.Account</similarOpportunitiesMatchFields\>
    <similarOpportunitiesMatchFields\>OPPORTUNITY.OpportunityCompetitors</similarOpportunitiesMatchFields\>
    <similarOpportunitiesMatchFields\>CustomField\_\_c</similarOpportunitiesMatchFields\>
    <similarOpportunitiesDisplayColumns\>CustomField\_\_c</similarOpportunitiesDisplayColumns\>
  </findSimilarOppFilter\>
  <enableOpportunityFieldHistoryTracking\>true</enableOpportunityFieldHistoryTracking\>
  <enableOpportunityInsightsInMobile\>false</enableOpportunityInsightsInMobile\>
  <enableOpportunityTeam\>true</enableOpportunityTeam\>
  <enableUpdateReminders\>true</enableUpdateReminders\>
  <promptToAddProducts\>true</promptToAddProducts\>
..<oppAmountDealMotionEnabled\>true</oppAmountDealMotionEnabled\>
..<oppCloseDateDealMotionEnabled\>true</oppCloseDateDealMotionEnabled\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).