PredictionBuilderSettings

Represents the settings that determine how a user can interact with Einstein Prediction Builder. 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

PredictionBuilderSettings values are stored in the PredictionBuilder.settings file in the settings directory. The .settings files are different from other named components in that each settings component has only one settings file.

Version

PredictionBuilderSettings components are available in API version 47.0 and later.

Special Access Rules

This type is available only if the CRM Analytics Plus or Einstein Predictions license is enabled in your org.

Fields

Field Name	Field Type	Description
enablePredictionBuilder	boolean	Indicates whether Einstein Prediction Builder is enabled (`true`) or not (`false`).
isPredictionBuilderStarted	boolean	Indicates whether to display the predictions list view to the user (`true`) or not (`false`).

Declarative Metadata Sample Definition

This is a sample Prediction Builder settings file.

1<?xml version="1.0" encoding="UTF-8"?>
2<PredictionBuilderSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <isPredictionBuilderStarted>false</isPredictionBuilderStarted>
4    <enablePredictionBuilder>false</enablePredictionBuilder>
5</PredictionBuilderSettings>

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.

Metadata API Developer Guide