Newer Version Available

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

OpportunityScoreSettings

Represents an org’s Einstein Opportunity Scoring settings, such as whether or not Einstein Opportunity Scoring is enabled. Einstein Opportunity Scoring helps determine the likelihood of an opportunity being won. 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

OpportunityScoreSettings values are stored in the OpportunityScore.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

OpportunityScoreSettings is available in API versions 49.0 and later.

Fields

Field Name Field Type Description
enableOpportunityScoring boolean Indicates whether Einstein Opportunity Scoring is enabled (true) or not (false). The default value is false.

Declarative Metadata Sample Definition

The following is an example of the OpportunityScore.settings file:

1<?xml version="1.0" encoding="UTF-8"?>
2<OpportunityScoreSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3	<enableOpportunityScoring>true</enableOpportunityScoring>
4</OpportunityScoreSettings>

Example Package Manifest

The following is an example package manifest used to deploy or retrieve the OpportunityScore settings metadata:

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3	<types>
4		<members>OpportunityScore</members>
5		<name>Settings</name>
6	</types>
7	<version>49.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.