Loyalty Management Developer Guide

Loyalty Management Standard Objects
Apex Reference
Loyalty Management Business APIs
Loyalty Management Standard Invocable Actions
Loyalty Management Metadata API Types
BenefitAction
Settings
IndustriesLoyaltySettings
Loyalty Management Tooling API Objects
Data Processing Engine, Batch Management, and Monitor Workflow Services
Decision Table
PDF

Newer Version Available

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

IndustriesLoyaltySettings

Represents the settings to enable a feature that updates the non-qualifying currency points balance of loyalty program members automatically when points are credited to members. 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 more details.

File Suffix and Directory Location

IndustriesLoyaltySettings values are stored in a single file named IndustriesLoyalty.settings 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

IndustriesLoyaltySettings components are available in API version 53.0 and later.

Fields

Field Name Field Type Description
enableNQPRealTimePointBalance boolean Indicates whether the real time non-qualifying points balance update feature is enabled (true) or disabled (false) for your org. The default value is false.

Declarative Metadata Sample Definition

The following is an example of a IndustriesLoyaltySettings component.

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

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>IndustriesLoyalty</members>
5    <name>Settings</name>
6  </types>
7  <version>53.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.