mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-07-30 03:09:50 +08:00
132 lines
12 KiB
JSON
132 lines
12 KiB
JSON
|
{
|
|||
|
|
"sections": [
|
|||
|
|
"title",
|
|||
|
|
"description",
|
|||
|
|
"file_information",
|
|||
|
|
"directory_location",
|
|||
|
|
"fields",
|
|||
|
|
"sub_types",
|
|||
|
|
"wsdl_segment",
|
|||
|
|
"declarative_metadata_sample_definition"
|
|||
|
|
],
|
|||
|
|
"title": "OpportunitySettings - Metadata API",
|
|||
|
|
"description": "Represents org preferences for features such as automatic opportunity updates and similar-opportunity filters.",
|
|||
|
|
"file_information": ".settings",
|
|||
|
|
"directory_location": "settings",
|
|||
|
|
"fields_columns": [
|
|||
|
|
"type",
|
|||
|
|
"description"
|
|||
|
|
],
|
|||
|
|
"fields": {
|
|||
|
|
"autoActivateNewReminders": {
|
|||
|
|
"type": "boolean",
|
|||
|
|
"description": "Automatically uses scheduled updates for new opportunities."
|
|||
|
|
},
|
|||
|
|
"customizableProductSchedulesEnabled": {
|
|||
|
|
"type": "boolean",
|
|||
|
|
"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. 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."
|
|||
|
|
},
|
|||
|
|
"doesEnforceStandardOpportunitySaveLogic": {
|
|||
|
|
"type": "boolean",
|
|||
|
|
"description": "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."
|
|||
|
|
},
|
|||
|
|
"enableExpandedPipelineInspectionSetup": {
|
|||
|
|
"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. Available in API version 52.0 and later."
|
|||
|
|
},
|
|||
|
|
"enableFindSimilarOpportunities": {
|
|||
|
|
"type": "boolean",
|
|||
|
|
"description": "Lets users see related or similar existing opportunities."
|
|||
|
|
},
|
|||
|
|
"enableForecastCategoryMetrics": {
|
|||
|
|
"type": "boolean",
|
|||
|
|
"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. Default value is true. Available in API version 57.0 and later."
|
|||
|
|
},
|
|||
|
|
"enableOpportunityFieldHistoryTracking": {
|
|||
|
|
"type": "boolean",
|
|||
|
|
"description": "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": {
|
|||
|
|
"type": "boolean",
|
|||
|
|
"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 (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 to 58.0."
|
|||
|
|
},
|
|||
|
|
"enableOpportunityTeam": {
|
|||
|
|
"type": "boolean",
|
|||
|
|
"description": "Lets users associate team members with opportunities."
|
|||
|
|
},
|
|||
|
|
"enablePipelineChangesMetrics": {
|
|||
|
|
"type": "boolean",
|
|||
|
|
"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. Default value is true. Available in API version 57.0 and later."
|
|||
|
|
},
|
|||
|
|
"enablePipelineInspection": {
|
|||
|
|
"type": "boolean",
|
|||
|
|
"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. Also enables historical trending for opportunities, if historical trending isn’t already enabled. To use Pipeline Inspection, additional configuration in Setup is required. Available in API version 52.0 and later."
|
|||
|
|
},
|
|||
|
|
"enablePipelineInspectionFlow": {
|
|||
|
|
"type": "boolean",
|
|||
|
|
"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. To use this feature, access to Revenue Insights is required. Available in API version 54.0 and later."
|
|||
|
|
},
|
|||
|
|
"enablePipelineInspectionSingleCategoryRollup": {
|
|||
|
|
"type": "boolean",
|
|||
|
|
"description": "Indicates that Pipeline Inspection metrics display as single forecast categories (true), or multiple categories rolled up (false). The default value is (false). To use this feature, Pipeline Inspection configuration in Setup is required. Available in API version 55.0 and later."
|
|||
|
|
},
|
|||
|
|
"enableRevenueInsights": {
|
|||
|
|
"type": "boolean",
|
|||
|
|
"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. Revenue Insights is part of Revenue Intelligence, which is available for an additional cost. Available in API version 54.0 and later."
|
|||
|
|
},
|
|||
|
|
"enableServiceCaseInsights": {
|
|||
|
|
"type": "boolean",
|
|||
|
|
"description": "Indicates whether insights based on service cases are enabled (true) or not (false) in Pipeline Inspection. The default value is (false). Available in API version 55.0 and later."
|
|||
|
|
},
|
|||
|
|
"enableUpdateReminders": {
|
|||
|
|
"type": "boolean",
|
|||
|
|
"description": "Lets users enable automatic, scheduled updates on opportunities."
|
|||
|
|
},
|
|||
|
|
"findSimilarOppFilter": {
|
|||
|
|
"type": "FindSimilarOppFilter",
|
|||
|
|
"description": "Defines parameters for similar opportunities."
|
|||
|
|
},
|
|||
|
|
"oppAmountDealMotionEnabled": {
|
|||
|
|
"type": "boolean",
|
|||
|
|
"description": "Indicates whether deal change highlights are enabled for opportunity amounts (true) or not (false). The default value is (true). Available in API version 50.0 and later."
|
|||
|
|
},
|
|||
|
|
"oppCloseDateDealMotionEnabled": {
|
|||
|
|
"type": "boolean",
|
|||
|
|
"description": "Indicates whether deal change highlights are enabled for opportunity close dates (true) or not (false). The default value is (true). Available in API version 50.0 and later."
|
|||
|
|
},
|
|||
|
|
"promptToAddProducts": {
|
|||
|
|
"type": "boolean",
|
|||
|
|
"description": "Prompts users to add related products to an opportunity."
|
|||
|
|
},
|
|||
|
|
"pushCountEnabled": {
|
|||
|
|
"type": "boolean",
|
|||
|
|
"description": "Indicates whether the Push Count field is visible to users in opportunity list views and Pipeline Inspection views (true) or not (false). The default value is (true). Available in API version 56.0 and later."
|
|||
|
|
},
|
|||
|
|
"simpleOppCreateFromContact": {
|
|||
|
|
"type": "boolean",
|
|||
|
|
"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 (true) or not (false). Available in API version 54.0 and later."
|
|||
|
|
},
|
|||
|
|
"simpleOppCreateFromEvent": {
|
|||
|
|
"type": "boolean",
|
|||
|
|
"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 (true) or not (false). Available in API version 54.0 and later."
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"sub_types": {
|
|||
|
|
"FindSimilarOppFilter": {
|
|||
|
|
"similarOpportunitiesDisplayColumns": {
|
|||
|
|
"type": "string",
|
|||
|
|
"description": "The columns to compare."
|
|||
|
|
},
|
|||
|
|
"similarOpportunitiesMatchFields": {
|
|||
|
|
"type": "string",
|
|||
|
|
"description": "The fields to compare."
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"wsdl_segment": "```xml\n<xsd:complexType name=\"FindSimilarOppFilter\">\n <xsd:sequence>\n <xsd:element name=\"similarOpportunitiesDisplayColumns\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"xsd:string\"/>\n <xsd:element name=\"similarOpportunitiesMatchFields\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"xsd:string\"/>\n </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"OpportunitySettings\">\n <xsd:complexContent>\n <xsd:extension base=\"tns:Metadata\">\n <xsd:sequence>\n <xsd:element name=\"autoActivateNewReminders\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"customizableProductSchedulesEnabled\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"doesEnforceStandardOpportunitySaveLogic\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enableExpandedPipelineInspectionSetup\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enableFindSimilarOpportunities\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enableForecastCategoryMetrics\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enableOpportunityFieldHistoryTracking\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enableOpportunityInsightsInMobile\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enableOpportunityTeam\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enablePipelineChangesMetrics\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enablePipelineInspection\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enablePipelineInspectionFlow\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enablePipelineInspectionSingleCategoryRollup\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enableRevenueInsights\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enableServiceCaseInsights\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enableUpdateReminders\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"findSimilarOppFilter\" minOccurs=\"0\" type=\"tns:FindSimilarOppFilter\"/>\n <xsd:element name=\"oppAmountDealMotionEnabled\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"oppCloseDateDealMotionEnabled\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"promptToAddProducts\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"pushCountEnabled\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"simpleOppCreateFromContact\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"simpleOppCreateFromEvent\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n```",
|
|||
|
|
"declarative_metadata_sample_definition": [
|
|||
|
|
{
|
|||
|
|
"description": "The package file references the following Opportunity.settings file.",
|
|||
|
|
"code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<OpportunitySettings xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n <autoActivateNewReminders>true</autoActivateNewReminders>\n <customizableProductSchedulesEnabled>false</customizableProductSchedulesEnabled>\n <doesEnforceStandardOpportunitySaveLogic>true</doesEnforceStandardOpportunitySaveLogic>\n <enableFindSimilarOpportunities>true</enableFindSimilarOpportunities>\n <enableForecastCategoryMetrics>true</enableForecastCategoryMetrics>\n <enablePipelineChangesMetrics>true</enablePipelineChangesMetrics>\n <findSimilarOppFilter>\n <similarOpportunitiesMatchFields>OPPORTUNITY.Account</similarOpportunitiesMatchFields>\n <similarOpportunitiesMatchFields>OPPORTUNITY.OpportunityCompetitors</similarOpportunitiesMatchFields>\n <similarOpportunitiesMatchFields>CustomField__c</similarOpportunitiesMatchFields>\n <similarOpportunitiesDisplayColumns>CustomField__c</similarOpportunitiesDisplayColumns>\n </findSimilarOppFilter>\n <enableOpportunityFieldHistoryTracking>true</enableOpportunityFieldHistoryTracking>\n <enableOpportunityInsightsInMobile>false</enableOpportunityInsightsInMobile>\n <enableOpportunityTeam>true</enableOpportunityTeam>\n <enableUpdateReminders>true</enableUpdateReminders>\n <promptToAddProducts>true</promptToAddProducts>\n..<oppAmountDealMotionEnabled>true</oppAmountDealMotionEnabled>\n..<oppCloseDateDealMotionEnabled>true</oppCloseDateDealMotionEnabled>\n</OpportunitySettings>"
|
|||
|
|
}
|
|||
|
|
]
|
|||
|
|
}
|