Newer Version Available

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

ProductSettings

Represents organization preferences for quantity schedules, revenue schedules, and active flag interaction with prices. This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

ProductSettings values are stored in a single file named Product.settings in the settings directory of the corresponding package directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

Version

ProductSettings is available in API version 28.0 and later.

Fields

Field Name Field Type Description
enableCascadeActivateToRelatedPrices boolean When changing active flag on a product record, automatically updates active flag on related prices.
enableMySettings boolean Moves users’ personal settings pages from Setup to a separate My Settings pane (true) or not (false). When set to (true), Salesforce makes a reorganized Setup pane accessible to admins via one click in the header. This setting affects all users in your organization. The default is true. Available in API version 47.0 and later.
enableQuantitySchedule boolean Enables quantity schedules for products.
enableRevenueSchedule boolean Enables revenue schedules for products.

Declarative Metadata Sample Definition

The following is an example of the package file.

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

The package file references the following Product.settings file.

1<?xml version="1.0" encoding="UTF-8"?>
2<ProductSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <enableCascadeActivateToRelatedPrices>true</enableCascadeActivateToRelatedPrices>
4    <enableQuantitySchedule>false</enableQuantitySchedule>
5    <enableRevenueSchedule>false</enableRevenueSchedule>
6</ProductSettings>

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.