ProductConfiguratorSettings

Represents the settings for Product Configurator.

Parent Type and Manifest Access

This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all the settings metadata types for the org are accessed using the “Settings” name. See Settings for more details.

File Suffix and Directory Location

ProductConfiguratorSettings values are stored in the ProductConfiguratorSettings.settings file in the settings folder. The .settings files are different from other named components, because there is only one settings file for each settings component.

Version

ProductConfiguratorSettings components are available in API version 60.0 and later.

Fields

Field Name	Field Type	Description
`enableProductConfigurator`	boolean	Indicates whether to enable Product Configurator at run time to customize product components and attributes during the sales process (`true`) or not (`false`). The default value is `false`.

Declarative Metadata Sample Definition

Here’s an example of a ProductConfiguratorSettings component.

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

Here’s an example package.xml that references the previous definition.

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