LoyaltyProgramSetup | Metadata API Developer Guide

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

File Suffix and Directory Location

LoyaltyProgramSetup components have the suffix loyaltyProgramSetup and are stored in the loyaltyProgramSetups folder.

Version

LoyaltyProgramSetup components are available in API version 54.0 and later.

Special Access Rules

To use this metadata type, your org must have either B2C - Loyalty, B2C - Loyalty Plus, Loyalty Management - Growth, or Loyalty Management - Advanced license enabled.

Fields

Field Name	Description
label	Field Type string Description Name of the loyalty program that the program process is associated with. If a loyalty program with the specified name doesn't exist, a new LoyaltyProgram record is created. The name of a loyalty program must contain at least one alphanumeric character.
programProcesses	Field Type LoyaltyProgramProcess[] Description Collection of loyalty program processes associated with a loyalty program.

LoyaltyProgramProcess

Represents a collection of fields relating to a loyalty program process.

Field Name	Description
description	Field Type string Description The description of the loyalty program process.
executionType	Field Type LoyaltyPgmProcExecutionType (enumeration of type string) Description The mode of processing transaction journals by the loyalty program process. Values are: `Batch` `BatchAndRealTime` `RealTime`
journalSubType	Field Type string Description The subtype of transaction journals processed by the loyalty program process.
journalType	Field Type string Description The type of transaction journal processed by the loyalty program process. You can enter either Accrual or Redemption as the journal type.
loyaltyTierGroup	Field Type string Description The tier group of a loyalty program. This field is available in API version 56.0 and later.
parameters	Field Type LoyaltyProgramProcessParameter[] Description The parameters associated with the loyalty program process.
processName	Field Type string Description Required. The name of the loyalty program process.
processType	Field Type string Description Required. The type of records processed by the loyalty program process.
rules	Field Type LoyaltyProgramProcessRule[] Description The rules associated with the loyalty program process.
status	Field Type LoyaltyPgmProcStatus (enumeration of type string) Description The status of the loyalty program process. Values are: `Active` `Draft` `Inactive` Only active program processes can process transaction journals. Note

LoyaltyProgramProcessParameter

Represents a collection of fields relating to a parameter that's associated with the program process. Parameters are dynamic or fixed values that are used in rule. You can define the value of a parameter based on its type and data type.

Field Name	Description
condition	Field Type LoyaltyProgramProcessCondition Description The filter condition that decides which records are stored in the parameter.
dataType	Field Type LoyaltyPgmProcParmDataType (enumeration of type string) Description The data type of the parameter. Determines the type of value that can be stored in the parameter. Values are: `Boolean` `Date` `DateTime` `Numeric` `Sobject` `Text`
decimalPlaces	Field Type int Description The number of decimal places supported by the parameter when it is of the type Variable and data type Numeric.
description	Field Type string Description The description of the parameter.
isCollection	Field Type boolean Description Indicates whether the parameter can store multiple values when it is of the type Variable.
isInput	Field Type boolean Description Indicates whether a parameter can be used as an input outside the loyalty program process.
isOutput	Field Type boolean Description Indicates whether a parameter can be used as an output outside the loyalty program process.
objectName	Field Type string Description Name of the object whose records are stored by the parameter when it is of the type Variable and data type sObject.
parameterName	Field Type string Description Required. The name of the parameter.
parameterType	Field Type LoyaltyPgmProcParmType (enumeration of type string) Description The type of value the parameter can store. Values are: `Constant` `Formula` `Variable`
value	Field Type string Description The value of the parameter when it is of the type Variable or Formula and isn't of the data type sObject.

LoyaltyProgramProcessCondition

Represents a collection of fields relating to a condition. Conditions filter records that parameters store or check whether child actions must be triggered for a transaction journal.

Field Name	Description
conditionCriteria	Field Type string Description Required. The criteria that determines when the condition is met by a record or by a transaction journal.
conditionFilterCriteria	Field Type LoyaltyProgramProcessConditionFilterCriteria[] Description The filter criteria that determines which records or transaction journals are filtered.
conditionName	Field Type string Description Required. The name of the condition.

LoyaltyProgramProcessConditionFilterCriteria

Represents a collection of fields relating to a filter criteria that's part of a condition. Multiple filter criteria can be added for a condition. Filter criteria determine which records are filtered by related condition.

Field Name	Description
operator	Field Type LoyaltyPgmProcCondOperator (enumeration of type string) Description Required. The operator of the filter criteria. Values are: `Contains` `DoesNotContain` `EndsWith` `Equals` `GreaterThan` `GreaterThanOrEquals` `IsNotNull` `IsNull` `LessThan` `LessThanOrEquals` `NotEquals` `StartsWith`
sequence	Field Type int Description Required. The sequence number of the filter criteria within a condition.
sourceFieldName	Field Type string Description Required. The name of the field used in the filter criteria.
value	Field Type string Description The value of the filter criteria.
valueType	Field Type LoyaltyPgmProcCondType (enumeration of type string) Description Required. The type of value specified in the filter criteria. Values are: `Formula` `Literal` `Lookup` `Parameter`

LoyaltyProgramProcessRule

Represents a collection of fields relating to a rule. A rule consists of a set of conditions and actions.

Field Name	Description
actions	Field Type LoyaltyProgramProcessAction[] Description The actions associated with the rule.
conditions	Field Type LoyaltyProgramProcessCondition[] Description The conditions associated with the rule.
description	Field Type string Description The description of the rule.
endDate	Field Type date Description The date until which the rule processes transaction journals.
previousRule	Field Type string Description The rule that processes new transaction journals before the current rule. The current rule is triggered when the previous rule completes processing transaction journals.
promotion	Field Type string Description The promotion associated with the rule. When a promotion is associated with a rule, the start date, end date, and status of the promotion determines the corresponding fields of the rule.
ruleName	Field Type string Description Required. The name of the rule.
startDate	Field Type date Description The date from which the rule starts processing transaction journals.
status	Field Type LoyaltyPgmProcRuleStatus (enumeration of type string) Description The status of the rule. Values are: `Active` `Draft` `Inactive`
stepMappings	Field Type LoyaltyProgramProcessRuleStepMapping[] Description The list of step mappings associated with rule.

LoyaltyProgramProcessAction

Represents a collection of fields relating to an action.

Field Name	Description
actionName	Field Type string Description Required. The name of the action.
actionParameters	Field Type LoyaltyProgramProcessActionParameter[] Description The parameters of the action.
actionType	Field Type LoyaltyPgmProcActionType (enumeration of type string) Description Required. The type of action. Possible values are: `AssignParameterValues`—Assigns values to parameters. `AssignBadgeToMember`—Assigns a badge to a loyalty program member. This value is available in API version 56.0 and later. `Crud`—Creates or updates records in the target object. This value is available in API version 56.0 and later. `CheckMemberBadgeAssignment`—Checks whether a badge is assigned to a loyalty program member. This value is available in API version 56.0 and later. `ChangeMemberTier`—Changes the tier of a loyalty program member. This value is available in API version 56.0 and later. `CreditPoints`—Credits points to the loyalty program member associated with the transaction journal that's processed by the rule. `DebitPoints`—Debits points from the points balance of the loyalty program member associated with the transaction journal that's processed by the rule. `GetMemberAttributesValues`—Gets the details of the loyalty program member's attribute value for the selected engagement attribute. This value is available in API version 55.0 and later. `GetMemberPointBalance`—Gets the points balance of a loyalty program member. `GetMemberPromotions`—Get promotions of a loyalty program member. This value is available in API version 56.0 and later. `GetMemberTier`—Gets the tier details of a loyalty program member. `GetOutputsFromDecisionTable`—Gets outputs provided by a decision table. This value is available in API version 56.0 and later. `IncrementMemberPromotion`—Adds the specified value to the loyalty program member's usage towards achieving a cumulative promotion by a specified value. `IncreaseUsageForCumulativePromotion`—Increases a loyalty program member’s usage for a cumulative promotion. `IssueVoucher`—Issues a voucher to the loyalty program member associated with the transaction journal that's processed by the rule. `ResetMemberPromotion`—Updates the loyalty program member's usage towards achieving a cumulative promotion by a specified value. `RunFlow`—Runs a flow. `RunProgramProcess`—Runs an active loyalty program process as a subprocess. This value is available in API version 56.0 and later. `UpdateCurrentValueForMemberAttribute`—Updates the loyalty program member's current attribute value for the selected engagement attribute. This value is available in API version 55.0 and later. `UpdatePointBalance`—Updates the points balance of the loyalty program member associated with the transaction journal that's processed by the rule. `UpdateUsageForCumulativePromotion`—Updates a loyalty program member’s usage for a cumulative promotion.
crudActionType	Field Type LoyaltyPgmProcCrudActType (enumeration of type string) Description The type of operation to perform on target object records by the action. This field is available from API version 56.0 and later. This field is required when the actionType field value is `CRUD`. Note Possible values are: `create` `update`
decisionTable	Field Type string Description The decision that's invoked by the action for the transaction journal that's processed by the rule.
decisionTableDatasetLink	Field Type string Description The dataset link associated with the selected decision table.
entityApiName	Field Type string Description The API name of the target object. This field is available from API version 56.0 and later. This field is required when the actionType field value is `CRUD`. Note
flowDefinition	Field Type string Description The flow that's run by the action for the transaction journal that's processed by the rule. The selected flow must be of the type LoyaltyManagementFlow.
loyaltyProgramProcess	Field Type string Description The subprogram processes that’s run by the action. This field is available from API version 56.0 and later. This field is required when the actionType field value is `RunProgramProcess`. Note

LoyaltyProgramProcessActionParameter

Represents a collection of fields relating to an action parameter. A parameter is either an input or an output for the action. Input parameters store the values used by the action. Output parameters store the result of the action.

Field Name	Description
operator	Field Type LoyaltyPgmProcActParamOper (enumeration of type string) Description The type of operator used in the action. This field is available in API version 56.0 and later. Possible value is: `Equals`
parameterName	Field Type string Description Required. The name of parameter. The parameter name must be the same as the input or the output field that's supported depending on the associated action's type.
sequenceNumber	Field Type int Description The sequence number of the parameter in the action. This field is available in API version 56.0 and later.
value	Field Type string Description Required. The value of the parameter.
valueType	Field Type LoyaltyPgmProcActParamType (enumeration of type string) Description The type of value to provide in the parameter. This field is available in API version 56.0 and later. Possible values are: `Literal`—A constant value. `Parameter`—A runtime value passed using a parameter.

LoyaltyProgramProcessRuleStepMapping

Represents a collection of fields relating to a step mapping. Map conditions with child actions or map an action without a parent step.

Field Name	Description
associatedStep	Field Type string Description Required. The action that's associated with the mapping.
parentStep	Field Type string Description The condition that contains one or more child actions.
sequence	Field Type int Description Required. The sequence number of the mapping within a rule.

Declarative Metadata Sample Definition

The following is an example of a LoyaltyProgramSetup component.

1<?xml version="1.0" encoding="UTF-8"?>
2<LoyaltyProgramSetup xmlns="http://soap.sforce.com/2006/04/metadata">
3    <label>Cloud Kicks Inner Circle</label>
4    <programProcesses>
5        <executionType>RealTime</executionType>
6        <parameters>
7            <dataType>Numeric</dataType>
8            <decimalPlaces>0</decimalPlaces>
9            <isCollection>false</isCollection>
10            <isInput>false</isInput>
11            <isOutput>false</isOutput>
12            <parameterName>VoucherValue</parameterName>
13            <parameterType>Constant</parameterType>
14            <value>50</value>
15        </parameters>
16        <processName>Issue Vouchers</processName>
17        <processType>Transaction Journal</processType>
18        <rules>
19            <actions>
20                <actionName>Issue High Transaction Value Voucher</actionName>
21                <actionParameters>
22                    <operator>Equals</operator>
23                    <parameterName>VoucherDefinitionName</parameterName>
24                    <sequenceNumber>1</sequenceNumber>
25                    <value>Voucher for High Value Transactions</value>
26                    <valueType>Literal</valueType>
27                </actionParameters>
28                <actionParameters>
29                    <operator>Equals</operator>
30                    <parameterName>VoucherCode</parameterName>
31                    <sequenceNumber>2</sequenceNumber>
32                    <value>{!TransactionJournal.Order.Id}</value>
33                </actionParameters>
34                <actionParameters>
35                    <operator>Equals</operator>
36                    <parameterName>VoucherEffectiveDate</parameterName>
37                    <sequenceNumber>3</sequenceNumber>
38                    <value>DATEVALUE(&quot;2021-11-21 00:00:00&quot;)</value>
39                </actionParameters>
40                <actionParameters>
41                    <operator>Equals</operator>
42                    <parameterName>VoucherExpirationDate</parameterName>
43                    <sequenceNumber>4</sequenceNumber>
44                    <value>DATEVALUE(&quot;2022-01-01 00:00:00&quot;)</value>
45                </actionParameters>
46                <actionParameters>
47                    <operator>Equals</operator>
48                    <parameterName>VoucherFaceValue</parameterName>
49                    <sequenceNumber>5</sequenceNumber>
50                    <value>{!VoucherValue}</value>
51                </actionParameters>
52                <actionType>IssueVoucher</actionType>
53            </actions>
54            <conditions>
55                <conditionCriteria>1</conditionCriteria>
56                <conditionFilterCriteria>
57                    <operator>GreaterThanOrEquals</operator>
58                    <sequence>1</sequence>
59                    <sourceFieldName>TransactionJournal.TransactionAmount</sourceFieldName>
60                    <value>100</value>
61                    <valueType>Literal</valueType>
62                </conditionFilterCriteria>
63                <conditionName>New Condition</conditionName>
64                <conditionType>Condition</conditionType>
65            </conditions>
66            <endDate>2022-01-01</endDate>
67            <ruleName>Issue Voucher for Transactions Above $100</ruleName>
68            <startDate>2021-11-21</startDate>
69            <status>Draft</status>
70            <stepMappings>
71                <associatedStep>New Condition</associatedStep>
72                <sequence>1</sequence>
73            </stepMappings>
74            <stepMappings>
75                <associatedStep>Issue High Transaction Value Voucher</associatedStep>
76                <parentStep>New Condition</parentStep>
77                <sequence>1</sequence>
78            </stepMappings>
79        </rules>
80        <status>Draft</status>
81    </programProcesses>
82</LoyaltyProgramSetup>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3   ~ Copyright 2020 Salesforce, Inc.
4   ~ All Rights Reserved
5   ~ Company Confidential
6-->
7<Package xmlns="http://soap.sforce.com/2006/04/metadata">
8   <types>
9      <members>*</members>
10      <name>LoyaltyProgramSetup</name>
11   </types>
12   <version>54.0</version>
13</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.