--- schema_version: "1" id: d4c1e807a18e776289a7587173cbf7500c9a63f87c6c25fe248f84ffbee6597f title: LoyaltyProgramSetup collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_loyaltyprogramsetup.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_loyaltyprogramsetup.htm source_site: developer.salesforce.com content_type: documentation content_hash: 9539f85fe32bfa75b7c2c18784e14ebef5b11d9375d1afd54e3c70d3967696fd description: Represents the configuration of a loyalty program process including its parameters and rules. Program processes determine how new transaction journals are processed. When new transaction journals meet the criteria and conditions for a program process, actions that are set up in the process are triggered for the transaction journals. --- # LoyaltyProgramSetup Represents the configuration of a loyalty program process including its parameters and rules. Program processes determine how new transaction journals are processed. When new transaction journals meet the criteria and conditions for a program process, actions that are set up in the process are triggered for the transaction journals. ![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png) #### Important 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. ## Parent Type This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field. ## 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 for Loyalty Management and in API version 59.0 and later for Referral Marketing. ## Special Access Rules To use this metadata type, your org must have either B2C - Loyalty, B2C - Loyalty Plus, Loyalty Management - Growth, Loyalty Management - Advanced, or Referral Marketing 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 or referral program with the specified name doesn't exist, a new LoyaltyProgram record is created. The name of a program must contain at least one alphanumeric character. | | programProcesses | Field Type [LoyaltyProgramProcess\[\]](#subtype_LoyaltyProgramProcess) Description Collection of loyalty program processes associated with a loyalty program or a referral 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. Possible 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. Possible values for loyalty program: - Accrual - Redemption Possible value for referral program: - Referral | | loyaltyTierGroup | Field Type string Description The tier group of a loyalty program. This field is available in API version 56.0 and later. This field isn’t applicable for referral programs. | | parameters | Field Type [LoyaltyProgramProcessParameter\[\]](#subtype_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. For referral programs, the process type is TransactionJournal. | | rules | Field Type [LoyaltyProgramProcessRule\[\]](#subtype_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. Possible values are: - Active - Draft - Inactive ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png) #### Note Only active program processes can process transaction journals. | ## 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](#subtype_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. Possible 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. Possible 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 determine when the condition is met by a record or by a transaction journal. | | conditionFilterCriteria | Field Type [LoyaltyProgramProcessConditionFilterCriteria\[\]](#subtype_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. | | conditionType | Field Type LoyaltyPgmProcRuleType (enumeration of type string) Description Specifies the type of condition in the loyalty program process. Values Values are: - Condition - Action - ConditionGroup - DefaultPath | ## 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. Possible values are: - Contains - DoesNotContain - Equals - GreaterThan - GreaterThanOrEquals - IsNotNull - IsNull - LessThan - LessThanOrEquals - NotEquals | | 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. Possible 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\[\]](#subtype_LoyaltyProgramProcessAction) Description The actions associated with the rule. | | conditions | Field Type [LoyaltyProgramProcessCondition\[\]](#subtype_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. | | isProcessEligibilityRule | Field Type boolean Description Indicates whether the rule is used to determine eligibility for processing the loyalty program process (true) or not (false). When set to true, the rule is evaluated as a process eligibility rule. When set to false, the rule is evaluated as a standard program process rule. | | 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. Possible values are: - Active - Draft - Inactive | | stepMappings | Field Type [LoyaltyProgramProcessRuleStepMapping\[\]](#subtype_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\[\]](#subtype_LoyaltyProgramProcessActionParameter) Description The parameters of the action. | | actionType | Field Type LoyaltyPgmProcActionType (enumeration of type string) Description Required. The type of action. Possible values are: - These values are used in Loyalty Management: - 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 a loyalty program member’s attribute value for the selected engagement attribute. This value is available in API version 55.0 and later. - GetMemberPartnerLinkageStatus—Gets the partner linkage status of the loyalty program member associated with the transaction journal that's processed by the rule. - 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. - 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. - RedeemVoucher—Redeems a voucher for the loyalty program member associated with the transaction journal that's processed by the rule. This value is available in API version 58.0 and later. - —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. - SendMail—Sends emails to the loyalty program member for whom the process is run. This value is available in API version 59.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. - These values are used in Referral Marketing: - AssignParameterValues—Assigns values to parameters. - Crud—Creates or updates records in the target object. - GetMemberAttributesValues—Gets the details of an advocate's attribute value for the selected engagement attribute. - GetMemberPromotions—Gets the promotions of an advocate. - GetOutputsFromDecisionTable—Gets outputs provided by a decision table. - IssueExtendedReward—Issues an extended reward to an advocate or a referred friend. This value is available in API version 64.0 and later. - IssueVoucher—Issues a voucher to an advocate or a referred friend. - RedeemVoucher—Redeems a voucher for an advocate or a friend. - SendMail—Sends emails to a referral program’s advocates and referrals. - UpdateCurrentValueForMemberAttribute—Updates an advocate’s current attribute value for the selected engagement attribute. - These values are reserved for internal use: - GetCustomerPromotionAttrValue—This value is available in API version 64.0 and later. - UpdateCustomerPromotionAttrValue—This value is available in API version 64.0 and later. | | 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png) #### Note This field is required when the actionType field value is CRUD. 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png) #### Note This field is required when the actionType field value is CRUD. | | 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png) #### Note This field is required when the actionType field value is RunProgramProcess. | ## 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. Cloud Kicks Inner Circle RealTime Numeric 0 false false false VoucherValue Constant 50 Issue Vouchers Transaction Journal false Issue High Transaction Value Voucher Equals VoucherDefinitionName 1 Voucher for High Value Transactions Literal Equals VoucherCode 2 {!TransactionJournal.Order.Id} Equals VoucherEffectiveDate 3 DATEVALUE("2021-11-21 00:00:00") Equals VoucherExpirationDate 4 DATEVALUE("2022-01-01 00:00:00") Equals VoucherFaceValue 5 {!VoucherValue} IssueVoucher 1 GreaterThanOrEquals 1 TransactionJournal.TransactionAmount 100 Literal New Condition Condition 2022-01-01 Issue Voucher for Transactions Above $100 2021-11-21 Draft New Condition 1 Issue High Transaction Value Voucher New Condition 1 Draft The following is an example package.xml that references the previous definition. \* LoyaltyProgramSetup 54.0 ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png) #### Note To retrieve metadata specific to any loyalty program, mention the loyalty program name in the tag. The generated file contains all the information regarding that loyalty program. ## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").