Badges

Overview

Badges are a type of Reward, allowing you to recognize and incentivize your Members. Members can view and share their Badges with friends and other Members. The Badges screen is used to create and manage your Badges.

Access

To access the Badges screen, select Rewards from the Main Navigation Menu, then select Badges from the Sub-Category menu.

Multilingual Support

With multilingual support, badge content may be presented in various languages across multiple platforms, such as mobile apps, web-based platforms, or any other platforms that utilize Loyalty Badges APIs. 

By default, multilingual support on content objects is disabled. To enable this new feature, users should contact their CSM to have multilingual support enabled. Once enabled, users can then request to add Badge content.

Note: Currently, this feature does not include localized image support for Badges.

Features

Manage Badges

The Badges screen provides the following features:

Searching and Sorting

Search

The search feature allows you to search for a specified text string anywhere within the following fields: Badge display name, internal name, Category label, Category name, or Tag.  

  1. Optionally, in the search field near the top of the Badges screen, enter the desired text string.

  2. Optionally, from the "Type" drop-down menu, select a Badge type (or "Any type").  

  3. Press Enter, or click the search button (magnifying glass icon).

  4. The Badges screen is refreshed to show only the Badges that meet your search criteria. Please note that if you enter multiple search conditions, the platform displays only the Badges that meet ALL criteria.

  5. To remove all search criteria, click the remove button ("X" icon).

Sort

The "Sort" drop-down menu allows you to sort the Badges on a variety of different fields. To sort the list of Badges, select the desired sort option from this menu.

  • Name (default option)

  • Created Date

  • Updated Date

Navigation

Once you've found the desired Badge, you can navigate to the following other screens:

  • Click the Badge record to navigate to the Badge Details screen for that Badge.

Create a New Badge

To create a new Badge:

  1. In the "Enter Display Name" field, enter the name of the new Badge.

  2. From the Type drop-down menu, select the Badge type:

  • Status: Give a Status Badge to Members based on their expertise in specific products or related skills. Typically, Status badges have levels to show gradation of expertise.

  • Collector: Give a Collector Badge to Members who accomplish a milestone. Members can collect multiple instances of these Collector Badges and may be able to exchange them for Rewards or more prestigious Badges.

  • Membership: Give a Membership Badge as a way to track paid memberships. Members earn the Badge when they enroll, and you can use the Badge as a way to track the membership expiration period. 

  • Benefit: Give a Benefit Badge as a way to track a membership benefit managed in some other external system. The details of the benefit itself are managed in the external system, but the Badge allows you to track which Members have earned it, and then present this information to other systems. 

  1. Click create. The "Edit Badge" pop-up window is displayed.

  2. The "Display Name" field is populated with the value you entered above in step 1; optionally edit this value.

  3. The "Internal Name" is automatically populated based on the "Display Name" value. This field is disabled by default. To edit the Internal Name, check the "Edit Internal Name" check box. A confirmation dialog box is displayed; click ok. Edit the Internal Name value.

  4. In the "Description" field, enter a description of the Badge.

  5. The "Type" drop-down menu is populated with the value you entered above; optionally select a different value.

  6. To assign the Badge to a Reward, begin typing the name of the Reward in the "Reward" field. Select the desired Reward from the drop-down menu.

  7. For Status type Badges only, select how many Badge levels this Badge supports. 

  8. In the "Categories" field, assign one or more Categories to this Reward. Categories are used to organize Loyalty assets into groups. See Badge Categories for more details.

  9. To define an expiration period for this Badge, enter the interval in the "Expiration interval" field. Then, from the "Expiration interval period," select a period of time.

  10. In the "Tags" field, assign one or more Tags to this Reward. Tags are used to help search, filter, and organize Loyalty assets within the platform (Tags are never visible to Members).

  11. Click save.  

Export Badges

The Badges screen provides the following features related to exporting Badge records.

Create Export Definition

Export definitions can optionally be saved and reused, when you need to download Badges from the Loyalty platform. 

From the "Actions" drop-down menu in the top-right corner of the screen, select "Export Badges." The "Create New Export - Badges" pop-up window is displayed.

  1. Select when you want to execute the export:

  • Asynchronous -- check this option if you want to execute the export manually on an ad hoc basis.

  • Execute now -- check this option if you want to execute the export immediately.

  • Create schedule -- check this option if you want to define a schedule (either a one-off execution, or a recurring schedule).

  1. If you checked "Create schedule" above, the schedule options are displayed.

Define export schedule

To define the export schedule:

  1. From the "Recurrence" drop-down menu, select an option:

  • Repeat-- Execute the export based on the defined schedule; see below for more details.

  • Once-- Execute the export once. In the "Execute once on" field, enter the date and time. Select the time zone from the "Time Zone" drop-down menu.

  • On demand-- Execute the export when specified by a user. In the "Execute once on" field, enter the date and time. From the "Time Zone" drop-down menu, select the time zone to use.

Define a repeating schedule

  1. From the "Schedule Composer" drop-down menu, select a unit of time -- every minute, hour, day, week, month, or year.

  2. Optionally, check "Advanced" to enable the "CRON expression" text field, and enter a custom CRON expression.

  3. In the "From" and "To" field, enter the start date and time, and the end date and time, for the repeating schedule.

  4. From the "Time Zone" drop-down menu, select the time zone to use.

If you checked "Asynchronous" above, this section is displayed.

  1. To send email notifications when the import process is successful, enter one or more email addresses in the "Success Email Recipients" text field. 

  2. To send email notifications if the import encounters an error, enter one or more email addresses in the "Error Email Recipients" text field. 



This section allows you to optionally include (or exclude) specific columns in the export file.

  1. From the "Inclusion" drop-down menu, select an option:

  • All -- include all columns in the export file.

  • Only Included -- in the "Fields" field, select one or more columns you want to include in the export file.

  • Except selected -- in the "Fields" field, select one or more columns you want to exclude from the export file.

This section allows you to create custom business rules to define which Segments are included in the export file.

  1. Click the Add icon, then select Add Rule. The platform adds a new blank row for defining the Rule Condition. 

  2. From the first drop-down menu, select the desired Attributes. This menu is populated with all of the different Attributes for building a condition.

  3. Select a mathematical operator. The available operators will vary based on the data type of the selected Attribute. 

  4. Enter or select a value. 

  5. Some attribute types allow you to define additional criteria, such as a date range, or a channel type, for example. Select or enter the additional criteria. 

  6. Repeat the above steps as needed to define more Rule Conditions. If you need to delete a Rule Condition, click the Delete icon to it. 

  7. Once you define more than one Rule Condition, select the logical operator. From the "Include customers that meet" drop-down menu, select either: 

  • All of the following: The conditions are processed with a logical 'AND' operator such that all conditions must be true for an individual to be selected by this Segment. 

  • Some of the following: The conditions are processed with a logical 'OR' operator such that at least one of the conditions must be true for an individual to be selected by this Segment. 

You can also group rules by selecting Add Rule Group from the Add icon. Rule Groups have their own internal logical operator.

To export associated records:

  1. Click add. A new row is displayed.

  2. Check Enabled. 

  3. From the "Association" drop-down menu, select the type of associated record.

  4. From the "Inclusion" drop-down menu, select an option:

  • All -- include all columns in the export file.

  • Only Included -- in the "Fields" field, select one or more columns you want to include in the export file.

  • Except selected -- in the "Fields" field, select one or more columns you want to exclude from the export file.

  1. Repeat the above steps needed to include more associated records. To remove an association, click the delete icon next to it.

To export child records joined to the main record:

  1. Click add. A new row is displayed.

  2. Check "Enabled."

  3. From the "Child" drop-down menu, select a child record type.

  4. From the "Inclusion" drop-down menu, select an option:

  • All-- include all columns in the export file.

  • Only Included-- in the "Fields" field, select one or more columns you want to include in the export file.

  • Except selected-- in the "Fields" field, select one or more columns you want to exclude from the export file.

  1. Repeat the above steps needed to include more associated records. To remove an association, click the delete icon next to it.

When finished creating the Export Definition, click save.

 View or Edit an Export Definition

To view or edit a Badge Export Definition:

  1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Badge Exports." The "Badge Export Definitions" pop-up window is displayed and populated with a list of all Badge Export Definitions.

  2. From the "Action" column of the desired Export Definition, click the Edit icon. The "Edit Export" pop-up window is displayed.

  3. Make any necessary changes to the Export Definition properties.

  4. When finished, click save.

Manually Execute an Export Definition

To manually execute a Badge Export Definition:

  1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Badges Exports." The "Badges Export Definitions" pop-up window is displayed and populated with a list of all Badge Export Definitions.

  2. From the "Action" column of the desired Export Definition, click the Enqueue this Export icon. A confirmation dialog box is displayed.

  3. Click confirm.

 Download an Export Definition

To download the last execution of a Badge Export Definition:

  1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Badges Exports." The "Badges Export Definitions" pop-up window is displayed and populated with a list of all Badge Export Definitions.

  2. In the "Action" column of the desired Export Definition, click the Download File icon. The platform downloads the file to your PC.

Delete an Export Definition

To delete a Badge Export Definition:

  1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Badges Exports." The "Badges Export Definitions" pop-up window is displayed and populated with a list of all Badge Export Definitions.

  2. From the "Action" column of the desired Export Definition, click the Delete icon. A confirmation dialog box is displayed.

  3. Click confirm.

Import Badges

The Badges screen provides the following features related to importing Badge records.

 Import Badges

From the "Actions" drop-down menu in the top-right corner of the screen, select "Import Badges." The "Create New Import - Badges" pop-up window is displayed.

Basic properties

  1. From the "Import Method" drop-down menu, identify how you want the platform to handle the import records, such as create new records only, update existing records only, or both create and update records.

  2. In the "File Options" field, select one or more fields used to identify existing records in the database.

  3. By default, the platform will create an Activity record associated with this import. Optionally select the "Yes" radio button next to "Skip Publish Activity" to omit this process.

  4. If you want to import blank values, select the "Yes" radio button next to "Include Blank Values."

  5. The platform supports email and phone number syntax validation on the appropriate import fields. To run this validation, select the "Yes" radio button next to "Validate Records."

  6. If you account is configured with business units, select the desired Business Unit from the "Business Unit" drop-down menu.

  7. To send email notifications following the import process, enter one or more recipient email addresses in the "Recipients" field.

  8. To send email notifications following a failed import process, enter one or more recipient email addresses in the "Failed Import Email Recipients" field.

  9. To select the import file, clickchoose file, then browse to and select the desired file.

  10. Select a column separator: Comma or Semicolon.

Import options

To configure additional import options:

  1. Clickadd options.

  2. To use a lookup table, select the desired table from the "Lookup table" drop-down menu.

  3. From the "Lookup column" drop-down menu, select the desired column on the lookup table.

  4. Enter a value in the "Rename as" field.

  5. In the "Find by columns" field, select one or more columns used to identify existing records in the database.

  6. If the lookup table is required, select the "Yes" radio button next to "Required."

  7. If you want to stop the import process if a duplicate record is found, select the "Yes" radio button next to "Abort on Duplicate Record."

  8. Optionally enter any additional conditions as Groovy expressions in the "Condition" field. 

  9. Optionally, click delete to remove the additional import options.

Finish

  1. When finished, click submit.

 View Badge Imports

To view a list of previous Badge imports:

  1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Badges Import List." The "Badges Import List" pop-up window is displayed and populated with a list of all previous Badge imports. For each import, the screen displays the following:

  • Imported by

  • Filename

  • Result (i.e., the number of records successfully imported, the number of failed records, and the number of skipped records)

  • Created at

  • Duration

  • Status