Metadata API Developer Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
OpportunityInsightsSettings
This type extends the Metadata metadata type and inherits its fullName field.
In the package manifest, all organization settings metadata types are accessed using the Settings name. See Settings for details.
File Suffix and Directory Location
OpportunityInsightsSettings values are stored in the OpportunityInsights.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.
Version
OpportunityInsightsSettings is available in API versions 48.0 to 58.0.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| enableOpportunityInsights | boolean | Indicates whether Einstein Opportunity Insights is enabled (true) or not (false). The default value is false. |
Declarative Metadata Sample Definition
The following is an example of the OpportunityInsights.settings file:
1<?xml version="1.0" encoding="UTF-8"?>
2<OpportunityInsightsSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3 <enableOpportunityInsights>true</enableOpportunityInsights>
4</OpportunityInsightsSettings>Example Package Manifest
The following is an example package manifest used to deploy or retrieve the OpportunityInsights settings metadata:
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>OpportunityInsights</members>
5 <name>Settings</name>
6 </types>
7 <version>29.0</version>
8</Package>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.