Newer Version Available

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

IndustriesRatingSettings

Represents the settings for Rate Management.

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

The IndustriesRatingSettings values are stored in the IndustriesRating.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

IndustriesRatingSettings components are available in API version 62.0 and later.

Special Access Rules

This metadata type is available with Rate Management.

Fields

Field Name Description
enableRating
Field Type
boolean
Description
Indicates whether to enable Rate Management (true) or not (false). The default value is false.
enableRatingWaterfall
Field Type
boolean
Description
Indicates whether to enable Rating Waterfall (true) or not (false). The default value is false. Rating Waterfall provides insights into the rating data, which you can synchronize with your rating lookup tables.
enableRatingWaterfallPersistence
Field Type
boolean
Description
Indicates whether to enable Rating Waterfall Persistence (true) or not (false). The default value is false. Rating Waterfall Persistence stores rating data, which you can use to enhance the internal processes and increase efficiency.

Declarative Metadata Sample Definition

The following is an example of an IndustriesRatingSettings component.

1<IndustriesRatingSettings xmlns="http://soap.sforce.com/2006/04/metadata">
2     <enableRating>true</enableRating>
3     <enableRatingWaterfall>true</enableRatingWaterfall> 
4     <enableRatingWaterfallPersistence>true</enableRatingWaterfallPersistence>
5</IndustriesRatingSettings>

The following is 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>IndustriesRating</members>
5        <name>Settings</name>
6    </types>
7    <version>64.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.