Summary
- The Incentive Engine at Annex Cloud allows for the creation and management of codes and vouchers within the client’s program. This management may be tied to a Loyalty or Refer-a-Friend program, or the codes/vouchers may simply track store credit and gift cards issued by the client.
- The benefits of these types of incentives could include a certain percentage off on the purchase or a specific amount discount. This type of incentive engine is used to attract and retain customers. This platform is an easy way to configure and manage everything at one location.
- There are two types of redemptions - Full and Partial redemptions.
- Full redemption yields the reward points on a comprehensive basis. The redeemed products can offer discounts as a percentage or in the form of a fixed-rate coupon. The format of the rewards can be provided as coupon codes and voucher codes.
- Partial redemption allows rewards to be redeemed in portions - leaving the rest available to be redeemed later. This includes redemption of rewards in the form of products such as gift cards and store cards.
Navigation: Product > Program Types > Incentive Engine > Groups
If the Dashboard page appears, select the Groups icon in the left-hand panel.
Groups
Incentive Engine Groups allow you to create rules around the advanced management of benefit codes for a given client or client partner. The codes may be generated within the Incentive Engine or loaded from an external source but still managed by the Incentive Engine.
You can also assign users to a group and track how benefit codes are being used. The Filter option allows you to reduce the list of existing groups by specific criteria.
The Groups page includes the following elements.
-
Group Details: Displays the details of the new group in tabular form. The configuration details of the group are described below:
- Group Name: Displays the name of the group.
- Group & Redemption type: Displays group type as Fixed or Dynamic and Redemption Type as Full or Partial.
- User Type: Displays the type of users as Predefined users or dynamic users.
- Source: Displays the functionality used for differentiating the defined group.
- Start Date: Displays the date codes become eligible for redemption as set by the administrator.
- Expiry Date: Displays the expiration date of the code group.
- Code Details: Code details are updated using assigned code details.
- Create Group: New group is created using this option.
- Filter: The Filter option allows you to search for code groups based on specific criteria. ie. Group Type, Expiration Date, etc. More about Filters.
Create a Group
To create a group,
- Click Create Group. The Create Group window appears.
Complete these configuration fields.
Group Type: Enter the group type as Fixed or Dynamic.
- Fixed: Benefits or code values are the same/fixed across the group.
- Dynamic: Code values are not defined at the start of the group. As per the requirement, the values are assigned and defined at the code level.
Group Name: Enter a name for the group.
Redemption Type: Enter the redemption type as Full or Partial.
- Full: Members must redeem all reward points/amounts on one transaction.
-
Partial: Members can redeem partial reward points on a transaction, and the remaining reward points can be used on a later transaction.
Redemption Type = Full
Code Redemption Limit: Enter a numeric value how for many times a reward code can be used or select Unlimited. You can set the Code Redemption Limit to 1 to indicate Unlimited. The member gets the benefit in terms of
- Discount Amount
- Discount Percentage
- Product
Benefits: Select the benefits type as:
- Discount Amount: The Currency Discount is applied on the full amount of a purchase.
- Discount Percentage: The Percentage Discount is applied on the full amount of a purchase.
- Free Product: Add a Product SKU to award members with a free product upon code redemption.
- Product Discount Amount: The Currency Discount is applied on a single product by SKU.
- Product Percent Amount: The Percentage Discount is applied on a single product by SKU.
Date Range: Enter the details of date and time:
- Start Date
- End Date
- Start Time
- End Time
Currency: Select the currency type from the drop-down menu.
Code Type: Select code type as Public or Private.
- Public: Codes in the group can be used by any member if the code is shared by one member with another.
- Private: A code can only be used by the member it is assigned to. Private codes are non-shareable codes.
Low Code Alert Count: Enter a numeric value for the threshold number of codes left for group use before an alert is generated to replenish the codes.
Alert Sent To: Enter the admin Mail ID to whom a low code alert is sent.
Users: Enter the user type.
- Predefined: Number of users are uploaded using a CSV file.
- Dynamic: Users are defined at the time of performing the activity.
Linked To: Select the linked type as:
Loyalty – Select this option to connect the group to a Loyalty reward.
- RAF – Select this option to connect the group to a RAF reward.
- Source: Enter the functionality for which rewards to be awarded for a group. Example: Campaign is a function for Loyalty.
Redemption Type = Partial
Partial Type: Select Store Credit or Gift Card.
- Store Credit: The store credit strengthens customer loyalty by offering a currency value in a stored voucher. Typically, they are loading dollars for returns, but it could be used in other ways too. The consumer can redeem their voucher in the form of discounts for future purchases as well. The code issuers, general store owners, and IEM admin users can create a code and assign a specific value to it. When the consumer places a new order, the store credit (if applicable) is applied while making the purchase.
- Gift Card: Annex Cloud gift cards allow clients to sell digital gift cards on their platform redeemable anywhere the customer has integrated our Incentive Engine processes. AC gift cards are a form of prepaid debit cards that contains a specific amount of money available for use for purchases on client websites. Gift cards are redeemable only for purchases and cannot be cashed out.
Values: The amount given to the member for the Store Credit or Gift Card. Values are defined according to the specified currency. If the user's option is set as Predefined Users (user data uploaded from a CSV file), the reward benefits are awarded to the predefined users. If the user's option is set as Dynamic, the reward benefits are awarded to the users as they are added.
When the Partial Type = Gift Card and Group Type = Fixed, you can enter multiple values for Gift Cards. Enter a numeric value in the Values field, then click the [+] icon to obtain another Values field. Complete as many Value amounts as necessary. To delete a Value amount, click the Delete icon for that value.
Custom Deduction: If the partial redemption type is set as Gift Card, the Custom Deduction section is available. This section allows clients to devalue a Gift Card after a specified period has passed. This limits overall outstanding liability.
This feature is available to all Incentive Engine administrators but may be prohibited by law/regulation/business policy. Clients should check with their legal team before adding any configurations here.
Enter details of Custom Deductions as listed below:
- Devaluate: Enter the amount. Deductions will be in the form of a percentage or amount.
- Intervals: Select the duration of consecutive deductions that will be made in terms of years, months, or days.
-
After: Define the duration after which the deductions will be made in terms of years, months, or days.
Date Range: Enter the details of date and time:
- Start Date
- End Date
- Start Time
- End Time
Entry of end date and time is optional for dynamic and gift cards.
Currency: Select the currency type from the drop-down menu.
Code Type: Select code type as Public or Private.
- Public: Codes in the group can be used by any member if the code is shared by one member with another.
- Private: A code can only be used by the member it is assigned to. Private codes are non-shareable codes.
Low Code Alert Count: Enter a numeric value for the threshold number of codes left for group use before an alert is generated to replenish the codes.
Alert Sent To: Enter the admin Mail ID to whom a low code alert is sent.
Users: Enter the user type.
- Predefined: Number of users are uploaded using a CSV file.
- Dynamic: Users are defined at the time of performing the activity.
Linked To: Select the linked type as:
- Loyalty – Select this option to connect the group to a Loyalty reward.
- RAF – Select this option to connect the group to a RAF reward.
Source: Enter the functionality for which rewards to be awarded for a group. Example: Campaign is a function for Loyalty.
Adding Codes
When you complete the form, click Create Group. A confirmation pop-up appears.
- If the Group Type is set to Fixed, the popup includes an Add Codes button.
- If the Group Type is set to Dynamic, the popup includes an Add Code Configuration button.
Click either button to continue.
The Add Incentive Codes window appears.
On the Add Incentive Codes page, complete the following fields.
| Field | Description |
| Create Codes/Upload Codes |
If the Group Type is Fixed, choose whether to create codes within the Incentive Engine (Create) or import codes through a csv file from the client (Upload). If the Group Type is Dynamic, these radio buttons do not appear. |
| Number of Codes |
If the Group Type is Fixed, enter the number of codes you want to generate. If the Group Type is Dynamic, this field is inactive and defaults to 0. The number of codes to be added is determined by the migration file from the client. |
| Code Length | Enter a numeric value to define the number of characters in each code. |
| Charset |
Select from the drop-down list.
|
| Prefix | Enter characters to appear at the beginning of each code as a static identifier for the code set. |
| Postfix | Enter characters to appear at the end of each code as a static identifier for the code set. |
| Code Preview | A dynamic field that displays what the codes will look like, including the number of characters, the character set, and any prefix or postfix. |
Click Add Codes.
If the Group Type is Fixed, the Incentive Engine generates codes based on your configuration options. On the Group Details page, click the View Code Details icon.
The Code Details page appears, and you can see the codes created for the group. More about Code Details
If the Group Type is Dynamic, a popup window appears with the message “Do you want to migrate codes in incentive engine?”
Click Yes, Migrate. The Migrate Codes window appears. This window allows you to upload a csv file with codes from the client. Click Browse to select the code file using a standard Windows file select window.
Click Submit, and the Incentive Engine imports the codes in the csv file. You can view these codes from the Group Details page.
Incorporating Codes within Actions
As codes are distributed, the total number of available codes decreases. When the number of remaining codes reaches the Low Codes Alert Count, an email notification is sent to the address specified in the Alert Sent To field. To add more codes to the group, click the + icon on the Group Details page.
On the Add Incentive Codes page, you have two options: Create Codes and Upload Codes.
Create Codes
If you select this option, enter the desired number of codes you wish to add in the Number of Codes field, and then click Add Codes.
Upload Codes
Click Add Codes, then select the Upload Codes option. In the File Upload, click Browse to upload the CSV file containing the codes. Once the upload is complete, click Add Codes.
Logs
To view the details of the codes log, click on Logs, as demonstrated in the image below. Once you click, you’ll see all the relevant information, including:
- Site ID: The site to which the incentive codes were uploaded.
- Upload Date Time: The date and time when the incentive codes were uploaded.
- File Name: The name of the CSV file used to upload the incentive codes, applicable if the codes were uploaded via the Upload Codes option.
- Record Count: The total number of codes that were uploaded.
- Admin Email: The email address of the person who uploaded the codes.
-
Status: The status of the code upload, which can be Processing, Completed, or Failed.
Adding Users
- If the user's option is set as Dynamic, the reward benefits are awarded to the users as they are added.
- If the user's option is set as Predefined Users (user data uploaded from a CSV file), the reward benefits are awarded to the predefined users. The confirmation pop-up includes an Add User button. Click Add User to continue.
In the Add Users pop-up, click Browse to select a User file using a standard Windows Select File window. Once you select a file, click Generate to upload the users to the Group. Click Download csv format to obtain a template in csv format that you can use to build a User file.
Code Details
On the Group Details page, click the View Code Details icon for a group.
The Code Details page appears, and you can see the codes created for the group.
This page includes the following buttons.
- Active - If a code is Disabled, select the code using the check box at the left, and the code is returned to Active status. A confirmation prompt appears.
- Disable - If a code is Active, select a code using the check box at the left, and the code is set to Disabled status. A confirmation prompt appears. Disabled codes that are not assigned to a loyalty member sort to the end of the list.
- Filter - Limit the list to specific codes based on several criteria. More about Filtering.
- Export - Send the code list to a file. More about Exporting.
The Code Details data grid includes the following fields.
| Field | Description |
| Incentive Code | The ID for the code. |
|
Benefits Benefits($) Benefits(%) |
|
| Redemption Limit | The number of times the code can be used by the member. |
| No of Times Code Redeemed | The number of times the code has been redeemed by the member. |
| Balance($) | If the Redemption Type is Discount Amount or Product Discount Amount, and the Redemption Type is Partial, this field contains the remaining balance on the code for the user. |
| Assigned to | The User ID of the user the code is assigned to. |
| Status |
The Status of the code.
|
| Action |
Two available actions you can take at the code level.
|
Redemption and Unredemption Details
This popup window contains the following fields.
| Field | Description |
| Reference ID | An internal ID for a transaction using the selected code. There can be multiple transactions for codes with the Redemption Type of Partial. |
| Order ID | An ID for the transaction sent from the client when the code was used. |
| Benefit Used | The description of the benefit attached to the code. |
| Status |
|
| Date | The Date of the transaction in the Status field. |
Audit Records
This popup window contains the following fields.
| Field | Description |
| Previous Status | The status of the code before the change was made. If the Status is N/A, this is the first audit record for this code. |
| Previous Balance | The balance associated with the code before the change was made. |
| New Code Status | The status of the code after the change was made. |
| New Balance | The balance associated with the code before the change was made. |
| Old No. of Times Redeemed | The number of times the code had been redeemed before the change. |
| New No. of Times Redeemed | The number of times the code had been redeemed after the change. |
| Action Performed | The action taken during this transaction. This field indicates which set of Old/New fields pertain to the current record. |
| Order ID | An ID for the purchase sent from the client when the code was used. If this field is blank, there is not a purchase associated with this record. |
| Transaction ID | An internal identifier for a transaction other than a purchase sent from the client when the code was used. |
| Reference ID | An internal ID for a transaction using the selected code. |
| Mode of Change | The feature used to make the change to the code. |
| Remark | The text a user entered when making a change to a code to indicate why the code was changed. |
| Source | The IP address for the machine at which the change was made. |
| Add Date | A date/time stamp for when an Add transaction was made. |
| Update Date | A date/time stamp for when an Update transaction was made. |
Filtering
You can use the filter option to limit the list of Groups according to the following criteria. You can use the filter criteria in combination to find Groups that share your selection criteria.
| Field | Description |
| Group Name | Enter the name of the Group you want to filter on. |
| Start Date | Use the calendar tool to select Groups with the selected Start Date. |
| Expiry Date | Use the calendar tool to select Groups with the selected Expiration Date. |
| Group Type |
Select from the drop-down list.
|
| Benefit Type |
Select from the drop-down list.
|
| Group Status |
Select from the drop-down list.
|
| Code Details |
Select any of the check boxes to include
|
|
For each of these fields, select an operation from the drop-down list (>, >, =>, =<, ) and enter a numeric value for the codes you want to filter on. |
Once you have entered the filter options, click Search to get all the related results.
Filter Codes
Navigation: Products > Incentive Engine > Actions >View Codes > Filter
You have the following options under the filter page:
| Field | Description |
| Code | Enter a value for the Code you want to filter on. |
| UID | Enter a value for the User ID you want to filter on. |
| Status |
Select any of the check boxes to include
|
|
Benefits Value Benefits Percentage Balance |
For each of these fields, select an operation from the drop-down list (>, >, =>, =<, ) and enter a numeric value for the codes you want to filter on. |
Once you have entered the filter options, click Search to get all the related results.
Export
Click Export, and a drop-down appears with several options.
When you select Excel, CSV, or PDF, a popup window appears allowing you to choose With Redemptions or Without Redemptions. Click Export, and a file for your code list appears in the Downloads folder on your local machine.
When you select Make an Excel Request, a popup window appears allowing you to choose With Redemptions or Without Redemptions. In addition, enter an email address for the person you want to receive the output file. Click Export, and a file for your code list is attached to an email and sent to the address in the Email Address field.
