Summary

• Action Rules enable marketers to create activities that loyalty members can complete to earn points for their Loyalty program.
• Action Rules offers several predefined standard actions, as well as the capability to define new custom actions according to the design of a Loyalty program.
• Action Group functionality helps two or more actions be combined together to form a single group. Click here for more information about Action Groups.

Navigation: Products > Actions > Action Rules

Capabilities

Action Rules configure and manage Actions associated with a Loyalty program. The administrator can view, in table form, all available Actions within the platform.

An annotated screenshot of the capabilities within Action Rules and their functions is below:

• Create New Action: Configure an Action for use in a client Loyalty program. Details on how to configure Action Rules are described below.
• Search: Search the configured Actions in the platform. More about Search
• Export: Export configured Actions as an Excel or a CSV file. More about Export
• Status: Enable or disable configured Actions.
• Actions: This column provides two functionalities.
  1. Edit: Modify a configured Action.
  2. Audit: Show all changes made to an Action by administrators.

Configure a Standard Action

Several predefined and commonly used actions are available for use by configuring a Standard Action.

• Standard Actions are starting points for commonly used Actions.
• Some Standard Actions are basic functionality that only needs to be activated for the Loyalty program. However, many Actions offer the flexibility to adjust points, limitations, UI, and other additional settings based on the Loyalty program.

To configure a Standard Action,

1. Click Add New Action from the Action Rules page.
2. Under Choose from Standard Action, select an Action from the drop-down list.
3. Click Proceed. 
   

Fields and Functionality

General Information

Field	Explanation
Action Name	The internal system name for the action. This field is read-only.
Action ID	A unique identifier for the Standard Action automatically assigned by the system. This field is read-only.
Action Status	Set the Action to Enabled (ON) or Disabled (OFF). If you set the toggle to OFF, the following message appears. “The Action works only if it is set to active. Are you sure you want to disable the Action?” Some Actions cannot be disabled. If you try to set the toggle to OFF, the following message appears. “This Action cannot be disabled as it is used for internal application logic.”
Points*	Define the number of Points to award once the Action has been completed. Some Actions are based on amounts or ratios rather than points like Purchase action. For these Actions, the Points field is disabled.
Auto Assign Points to Referrer	If this flag is enabled, the referrer code will only need to be entered at the time the loyalty member is created using the User API. The code will not need to be included in the Order API when the referee goes to make a purchase. Once the referee makes their first valid purchase, the system will automatically retrieve the necessary information, and the points will be credited to the referrer based on the criteria set by the administrator.   NOTE: This option is only applicable for Action ID 125.
Ratio	For Actions based on ratios, specify the points multiplier a loyalty member will earn for completing this Action. For example: Enter ‘2’ to award double points for the spend for this Action.
Purchase Point Type	If the selected Action is Purchase, this field defines what type of points should be applied for the products. Ratio and/or Flat Points Only Ratio Only Flat Points
Points Limitation

 

Field	Explanation
Minimum Spend Amount	Enter the minimum amount which a referee must spend in order for the referrer to receive reward points. For example, if the Minimum Spend Amount is set to $50, then the referrer will earn the reward points designated by the administrator only if the referee spends at least $50.   NOTE: This option is only applicable for Action ID 125.
Hold Points	In the drop-down list, select an option for when the Hold Points number of days will begin. Options include: Order Placed Date Order Item Ship Date All Items From Order Ship Date Specify the number of days you want to hold the action points. The points will be awarded to the member after the defined number of days. If you leave this field blank, action points are released as soon as a member performs the action.
Maximum Point Limit	The maximum number of Points earned by the member by performing the action. If this field is left blank, there is no maximum point limit.
Maximum Point Limit Duration	Select Rolling or Calendar from the drop-down. If you select Rolling, enter the number of Days for a Rolling Threshold to enforce the Maximum Point Limit. For example, select Rolling, and enter 30 days. If the loyalty member earns points for this action on April 10th, the Maximum Point Limit Duration expires on May 10th, 30 days after they were earned. If the user selects Calendar, enter an option to enforce the Maximum Point Limit. Week, (Mon-Sun) Month Year Once the defined duration has lapsed, the maximum point earning window resets.  The duration begins at the time of the first action.
Order level Limit Type	Specify a limit for the number of points that can be awarded for an order. In the drop-down list, select Percentage or Points. If the number of points to be awarded exceeds the Points or Percentage of the order value defined here, then no points will be awarded on that Order. If the points to be awarded are less than the defined value, then those points will be awarded for that Order. If you select Percentage, enter a value in the Maximum Order Limit field for the percentage of an order to serve as a limit to the number of points that can be awarded for an order. If you select Points, enter a value in the Maximum Order Limit field for the number of points to serve as a limit that can be awarded for an order.
Action Interval Limit	Enter an Interval in Days or Hours that must pass between when a member takes this action and when they can take the action again. If this field is left blank, there is no interval restriction. For example, if this field is set to one day, the member can perform this action after one day passes from the previous action performed date.
Points Expiration	Select Rolling or Calendar from the drop-down. If you select Rolling, enter the number of Days for a Rolling Threshold for Points earned by performing the Action to expire. For example, select Rolling, and enter 30 days. If the loyalty member earns points for this Action on April 10th, the points expire on May 10th, 30 days after they were earned. If you select Calendar, select an option from the drop-down list. If you select Week (Mon - Sun), enter a numeric value for the number of weeks for the points to remain valid. Enter 1 in the numeric field, and if a member earns points on a Wednesday for example, those points expire on the following Sunday of the same week. Enter 2 in the number field, and if a member earns points on a Wednesday, those points expire on the second Sunday following the day they were earned. If you select Month, enter a numeric value for the number of months for the points to remain valid. Enter 1 in the numeric field, and if a member earns points on a Wednesday May 5th, for example, those points expire on June 30th. Enter 2 in the number field, and if a member earns points on a Wednesday, May 5th, those points expire on July 31st. If you select Year, select a value from 1 Year to 10 Years from the drop-down list. If you select 1 Year, and the member earns point on this action on May 10, 2023, the points expire on Dec 31, 2023. If you select 2 Years, and the member earns points on this action on May 10, 2023, the points expire on Dec 31, 2024. Points Expiration options are available in Action Rules, Action Series, Tiers, and Campaigns.
Apply Expiration Date defined in Tier	When this option is enabled, and a tier member performs this action, the points expiration date set within the member’s current tier is applied.

Display Settings

Advanced Settings
Multi Bucket Settings
Fields	Explanations
Bucket Name	Shows the Bucket name.
Points	Specify the number of points which will be awarded upon action completion against this bucket.
Ratio	Specify the points multiplier a loyalty member will earn for completing this action.
Hold Points	In the drop-down list, select an option for when the Hold Points number of days will begin. Options include    Order Placed Date    Order Item Ship Date    All Items From Order Ship Date Specify the number of days you want to hold the action points against this bucket. The points will be awarded to the member after the defined number of days. If you leave this field blank, Action points are released as soon as a member performs it.
Maximum Point Limit	Specify the maximum number of points a member can earn for this action against this bucket. If this field is left blank, there is no limit.
Points Expiration	Select Rolling or Calendar from the drop-down. If you select Rolling, enter the number of Days for a Rolling Threshold for Points earned by performing the Action to expire. For example, select Rolling, and enter 30 days. If the loyalty member earns points for this Action on April 10th, the points expire on May 10th, 30 days after they were earned. If you select Calendar, select an option from the drop-down list. If you select Week (Mon - Sun), enter a numeric value for the number of weeks for the points to remain valid. Enter 1 in the numeric field, and if a member earns points on a Wednesday for example, those points expire on the following Sunday of the same week. Enter 2 in the number field, and if a member earns points on a Wednesday, those points expire on the second Sunday following the day they were earned. If you select Month, enter a numeric value for the number of months for the points to remain valid. Enter 1 in the numeric field, and if a member earns points on a Wednesday May 5th, for example, those points expire on June 30th. Enter 2 in the number field, and if a member earns points on a Wednesday, May 5th, those points expire on July 31st. If you select Year, select a value from 1 Year to 10 Years from the drop-down list. If you select 1 Year, and the member earns point on this action on May 10, 2023, the points expire on Dec 31, 2023. If you select 2 Years, and the member earns points on this action on May 10, 2023, the points expire on Dec 31, 2024. Points Expiration options are available in Action Rules, Action Series, Tiers, and Campaigns.
Transaction Type Settings
Fields	Explanations
Purchase Ratio based on Transaction Type	Set this toggle to ON to enable functionality to define purchase ratios for different transaction types.
Add Transaction Type	Click Add Transaction Type to create a new value to which to apply a purchase ratio. A pop-up window appears.   In the Transaction Type field, enter a name for the transaction type. In the Ratio field, enter a value for a multiplier for the points awarded for completing purchase that use this transaction type against any product. In the Points Expiration field, select an option. If you select No Expiration, points will not expire. If you select Rolling, enter a value for the number of days after which the points will expire. If you select Calendar, a new drop-down appears. Select Week (Mon-Sun) and enter a value for the number of weeks. Select Month and enter a value for the number of months. Select Year and select the number of years from the drop-list. 4. Click Save to create the new transaction type. This option is applicable only for the Purchase action.
Data Grid	The data grid in the center of the page includes the following elements. Transaction Type: The name of the type of transaction. Ratio: The current ratio value. If the field is blank, no ratio is assigned. Points Expiration: The current settings for how points will expire for the transaction type. If the field is blank, points do not expire. Actions: Includes two options Edit: Edit the details for the transaction type. Delete: Delete the transaction type in the row.
Additional Settings
Fields	Explanations
Spend based Points Allocation	Set this toggle to ON to enable functionality to set different Points or Ratio values based on the amount spent bracket on a purchase. The data grid in this section describes ranges of spend amounts and the number of points or a ratio that is applied for purchases that fall within that spend range.   To add a row to the table of ranges: Enter minimum and maximum amounts. Select an option in the Points Type field. Enter a value for the points or ratio in the Value field. Click add. This option is applicable only for the Purchase action.
Enable Secondary Key for Product	If this toggle is set to ON, the Product ID and Secondary Key together act as a composite key to uniquely identify a product. This value should be passed against the secondaryKey parameter in the Order API. Once it is enabled, the secondaryKey parameter becomes mandatory in the Order API. This option is applicable only for the Purchase action.
Enable Auto Ship and Release Points	If this toggle is set to ON, after the configured Hold period has passed (from the Order placed date), the Order status will be marked as shipped automatically and the points will be awarded to the member. This option is applicable only for the Purchase action.
Limit Action using Custom Parameter	If this toggle is set to ON, you can restrict the number of times an Action can be performed by associating it with a unique custom value. This value will be passed against the customId parameter in the Points API. The Repeat same Custom Value field allows you to specify how many times the same Custom value can be used for an Action.
Enable Large Value Order	This option enables you to flag the orders which lie within the defined Order value range.

Click Create Action to add the Action to your program. A pop-up confirmation message appears.

Configure a Custom Action

Actions that are not currently included in the list of Standard Actions can be added to loyalty programs as Custom Actions. Custom Actions offer flexibility to adjust Points, Maximum Point Limits, Hold Points, and other settings based on the requirements of a Loyalty Program.

To create a Custom Action,

1. Click Add New Action from the Action Rules page.
2. Click Create new Custom Action.
3. Click Proceed.
   

Configuring a Custom Action requires providing an Action Name and ID, but otherwise the steps match those for a Standard Action.

General Information
Field	Explanation
Action Name	A unique identifier for a specific Action. Enter a string value that describes the Action so that others can select it.
Action ID	A unique identifier for a specific Action. Enter a whole number value for the Custom Action. If that number is already assigned to an existing Action, an error message appears.
Action Status	Enable (ON) or disable (OFF) the Action.
Points	Define the number of Points to award once the Action has been completed.

Search

Click Search, and the Search Options window appears. Complete the Search Options fields as necessary to find specific Actions.

Click Search, and a confirmation prompt appears. The Actions list includes records that meet your search criteria.

To view the entire list again, click the X in the Search field.

Export

1. Click Export.
2. Select Excel format or CSV format.
3. Your export file is generated in the Downloads folder on your local machine in your selected format.
   

Action Attributes and Points Differentiation

Option for Hiding Action Attributes Validations:

• To conceal/display Action Attributes validations according to the specified requirements, adhere to the steps outlined below:

1. Conditions for Unhiding Action Attributes Validations:

• To reveal these hidden validations, the "Enable Points Differentiation by Extended Attribute Values" flag must be turned on.
• Additionally, the "Validate Extended Attribute Values" flag can be set to either ON or OFF.

2. Flag Configuration for Hiding:

• The first flag, "Enable Points Differentiation by Extended Attribute Values," serves as a prerequisite for revealing hidden validations. To hide the validations, the “Enable Points Differentiation by Extended Attribute Values” flag must be turned off.
• The second flag, "Validate Extended Attribute Values," offers flexibility and can be configured to either ON or OFF based on user preferences.

3. Visibility of Points field from the Action Attributes Validations tab:

• If the Enable Points Differentiation by Extended Attribute Values flag is set to ON, the points column is visible in the Action Attributes Validations screen; otherwise, the points column is hidden.
• The combination of the flag settings determines whether the validations are displayed or concealed.

In summary, this update provides users with the ability to control the visibility of Action Attributes validations through a thoughtful configuration of the specified flags in the platform's user interface. Users can tailor these settings to align with their specific needs and preferences regarding the display of points in the Action Attributes Validations screen.

Scenario 1:

• When the flags, specifically "Enable Points Differentiation by Extended Attribute Values," are turned ON, an additional "Points" column is displayed in the Action Attributes Validations screen.
• This "Points" column provides visibility and differentiation of points based on the configured settings of the flags.
  

Scenario 2:

• Conversely, when the flags are not enabled or turned OFF, the "Points" column is not visible in the Action Attributes Validations screen.
• The absence of the "Points" column indicates that the differentiation of points based on extended attribute values is not being applied.
  

Download List Functionality:

• The display in the downloaded Excel file mirrors the scenario visible in the Action Attributes Validations screen.
• If the "Enable Points Differentiation by Extended Attribute Values" flag is ON, the downloaded Excel file will include the "Points" column, showcasing the differentiation of points.
  
• If the flags are OFF, the downloaded Excel file will not include the "Points" column, reflecting the absence of point differentiation.
  

In summary, the visibility of the "Points" column in both the Action Attributes Validations screen and the downloaded Excel file is directly influenced by the configuration of the flags. When the flags are turned ON, the "Points" column is visible, providing users with a clear representation of points differentiation based on extended attribute values. When the flags are turned OFF, the "Points" column is not visible, indicating that point differentiation is not being applied.

The MPB points can be seen in the excel file as well. The excel sheet will display values dynamically to suit the MPB names and values for an attribute value. If multiple buckets are there the data is displayed as shown in the image below.

There have been additions in the UI to display bucket points about the attribute value and they can be configured with the help of Add Action Attribute Value.

• An "Attribute Value Name" refers to the specific designation or label assigned to a particular attribute value within a system, database, or context where attributes are used. In various domains such as database management, programming, or e-commerce, entities often have attributes that can take on specific values. Each distinct value of an attribute is identified by its Attribute Value Name.
• A "Bucket Name" commonly refers to the unique identifier or label given to a storage container or repository within a storage system, particularly in the context of cloud storage services. Buckets are a fundamental organizational concept used by cloud storage providers to manage and store data.

The configured points can be looked at by clicking the points section in the attribute list.

The new additional attributes thus generated are displayed in the Reward Report as well. An illustration of the rewards report is shown below.

It is crucial to periodically review and manage them, ensuring that only relevant and valuable values are retained. Unused or obsolete attribute values can be deleted to maintain a clean and efficient system. An illustration of how to view deletion details in the audit log report is shown below.

There is a set limit of 200 for attribute values, and once this limit is reached, users receive a popup message indicating that new attribute values cannot be added.

When importing values for the action attribute, there is a comparable restriction in place.

If you exceed the allowable limit, the system not only signals that the limit has been surpassed but also provides information about the remaining number of attribute values that can still be added. This feature ensures transparency and assists users in understanding how many more attribute values they can import without violating the constraints.

In the Audit Report and Action Rules log, any modifications or changes made to attribute values, points, bucket names, or bucket points are recorded and displayed for transparency and auditing purposes. This log provides a comprehensive history of alterations, allowing administrators to track and understand adjustments made within the Action Rules.

A similar log can be seen in the Action Rules log by clicking the log icon.