IndustriesLoyaltySettings | Metadata API Developer Guide

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
enableAutomaticVoucherCodeGeneration	boolean	Indicates whether the capability to automatically generate voucher codes is enabled (`true`) or not (`false`). This field is available in API version 57.0 and later.
enableNQPRealTimePointBalance	boolean	Indicates whether the capability to update the non-qualifying point balance of members in real time is enabled (`true`) or disabled (`false`) for your org. The default value is `true`.
enableFixedTypeNQPAggregation	boolean	Indicates whether the capability to aggregate and expire fixed type non-qualifying points in batches is enabled (`true`) or disabled (`false`) for your org. The default value is `true`. This field is available in API version 54.0 or later.
enableNonQualifyingPointsConsolidation	boolean	Indicates whether the capability to aggregate and expire fixed type non-qualifying points in real time is enabled (`true`) or disabled (`false`) for your org. The default value is `true`. This field is available in API version 58.0 or later.
enableQPRealTimePointBalance	boolean	Indicates whether the real time qualifying points balance update capability is enabled (`true`) or disabled (`false`) for your org. The default value is `true`. This field is available in API version 55.0 or later.
enableLoyaltyRulesVerifyCdpMemberSegment	boolean	Indicates whether the capability that allows: Loyalty program process rules to process transaction journals only when the loyalty program member is part of a Data Cloud segment associated with the rule's promotion is enabled (`true`) or disabled (`false`) for your org. The Promotion Eligibility component on Loyalty Program Member record page to categorize promotions based on whether the member belongs to the promotion’s campaign or Data Cloud segment is enabled (`true`) or disabled (`false`) for your org. The default value is `false`. This field is available in API version 55.0 or later.
enableLoyaltyRedeemedPointsExpirationInfoPref	boolean	Indicates whether the capability that automatically calculates and adds the expiration date of points credited back to members for canceled redemptions is enabled (`true`) or disabled (`false`) for your org. The default value is `true`. This field is available in API version 55.0 or later.
enableLoyaltyServiceExcellence	boolean	Indicates whether Service Console for Loyalty Management is enabled (`true`) or disabled (`false`) for your org. The default value is `false`. This field is available in API version 57.0 or later.
enableLoyaltyApiAccessForExternalSiteUsers	boolean	Indicates whether the capability that allows customers to join and leave loyalty programs and allows members to join and opt out of promotions from Experience Cloud sites is enabled (`true`) or disabled (`false`) for your org. The default value is `false`. This field is available in API version 58.0 or later.
enableAutomaticMemberTierAssessmentSelection	boolean	Indicates whether the capability that automatically selects members as eligible for tier assessment when members’ qualifying points balance changes is enabled (`true`) or disabled (`false`) for your org. The default value is `false`. This field is available in API version 58.0 or later.
enableNegativePointBalance	boolean	Indicates whether the capability that lets loyalty program members to hold negative point balances for non-qualifying currencies is enabled (`true`) or disabled (`false`) for your org. The default value is `false`. This field is available in API version 61.0 or later.

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>true</enableNQPRealTimePointBalance>
4    <enableFixedTypeNQPAggregation>true</enableFixedTypeNQPAggregation>
5    <enableQPRealTimePointBalance>true</enableQPRealTimePointBalance>
6    <enableLoyaltyRulesVerifyCdpMemberSegment>false</enableLoyaltyRulesVerifyCdpMemberSegment>
7    <enableLoyaltyRedeemedPointsExpirationInfoPref>true</enableLoyaltyRedeemedPointsExpirationInfoPref>
8    <enableLoyaltyServiceExcellence>true</enableLoyaltyServiceExcellence>
9    <enableAutomaticVoucherCodeGeneration>true</enableAutomaticVoucherCodeGeneration>
10    <enableLoyaltyApiAccessForExternalSiteUsers>false</enableLoyaltyApiAccessForExternalSiteUsers>
11    <enableAutomaticMemberTierAssessmentSelection>false</enableAutomaticMemberTierAssessmentSelection>
12    <enableNonQualifyingPointsConsolidation>false</enableNonQualifyingPointsConsolidation>
13    <enablePointsLifecycleTracking>false</enablePointsLifecycleTracking>
14    <enableNegativePointBalance>false</enableNegativePointBalance>
15</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.