Definition Tab: Certificate

Features

The Definition tab for a Certificate displays high-level information about the Certificate codes, including the external site, display text, and any custom JSON code.

Managing Certificate Codes

 Edit Certificate Reward Properties

Click hereClick here

Note: Some fields on this screen (marked by a globe icon) allow you to enter localized content in different languages. See Enter Localized Content below for more details on this process. 

To edit a the details of a Certificate Reward:

  1. Within the "Definition for Certificate " section, click edit. The "Edit Reward" pop-up window is displayed.

  2. In the "External Site Name" field, enter the name of the external web site.

  3. In the "External URL" field, enter the URL.

  4. In the "Display Text" field, enter the display text for the certificate codes.

  5. Optionally, make any changes to the JSON code for this Reward.

  6. Click save.  

 

  Enter Localized Content

Click hereClick here

Certain fields on this screen (marked with a globe icon) allow you to enter localized content in different languages. 

Note: The localization feature is an optional feature that must be enabled in your account. Please speak to your Client Services Representative for more details.

To use the localization feature, you must first define the locales that you support. Please see Program Settings for more details on this process. 

To enter localized content:

  1. Click edit (being sure to click the edit button within the desired section that you want to modify). A pop-up window is displayed.

  2. Within the pop-up window, the platform displays a tab for each supported locale; the default language is marked with an asterisk (*). Select the tab for the language you want to enter.

  3. Enter the localized content in the selected language.

  4. Repeat the above steps as needed to select a different locale and enter content in a different language.

  5. Click save.

 

  Searching and Sorting

Click hereClick here

On the Reward Details screen, existing Certificate Codes are displayed in a spreadsheet-style grid. Each row in the grid represents a single Certificate code, and displays such information as the status, the Member who redeemed the code, etc.  

Search

The search feature allows you to search for a specified text string anywhere within the following Certificate fields: label, code, secondary code, or coupon URL. .  

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

  2. Optionally, from the "Status" drop-down menu, select a Certificate status (or "Any status").  

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

  4. The Reward Details screen is refreshed to show only the Certificate Codes that meet your search criteria. Please note that if you enter multiple search conditions, the platform displays only the Certificate Codes 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 Certificate Codes on a variety of different fields. To sort the list of Certificate Codes, select the desired sort option from this menu.

  • Created Date (the default option)

  • Updated Date

  • Reward Name

 

  Create a Certificate Code

Click hereClick here

To manually create a Certificate Code:

  1. Click create. The "Create Reward Certificate" pop-up window is displayed.

  2. In the "Code" field, enter the Code value.

  3. Each Certificate Code can have up to ten secondary Codes. For example, you could use the Code for the primary discount code, and use a secondary code for a free shipping code. Optionally enter the desired secondary Codes.

  4. Define the Certificate Code's effectivity. The effectivity designates the time frame during which Members can redeem the Certificate Code:

  • Always: This Certificate Code doesn't expire.

  • Schedule: Enter a start date / time and the end date / time, and pick the Time Zone.  

  1. Click save.   

 

 Generate Certificate Codes

Click hereClick here

To create one or more Certificate Codes:

  1. Click auto-generate. The "Generate Certificates" pop-up window is displayed.

  2. From the "Reward" drop-down menu, select the Reward for which Members can redeem this Certificate.

  3. In the "No. of Certificates" field, enter how many Certificates you want to generate.

  4. In the "Length of Code" field, enter the character length for the Certificate Code.

  5. In the "Code Prefix" field, optionally enter a prefix to be inserted before the Code (the Prefix doesn't count towards the length entered above in Step 4).

  6. From the "Excluded Characters" drop-down menu, optionally select a letter or number to be excluded from the Code. Repeat this step as needed to exclude additional characters. 

You may save the above settings of length of code, code prefix, and excluded characters as your default data by clicking on the Save as Default button. Note that doing so will also update the program setting Certificate Generation Defaults.

       7.      If you want to use the effectivity assigned to the Reward, check the

                "Use Reward Effectivity" check box.

       8.      Optionally check the "Unique in all Rewards" check box.

       9.      In the "Batch Size" field, enter the size of a Certificate "batch."

     10.      Click generate. Or, to close the window without creating any

                Certificates, click close.  

Note: It may take a few moments for the platform to generate the Certificates; refresh the screen periodically until the Certificates are displayed. During this process, the auto-generate button label changes to read certificates generation on-going. You can't generate new Certificates until the process is finished. The platform will send you an email notification when the process is complete.

 

 

 Edit Certificate Code Details

Click here Click here

To edit a Certificate Code:

  1. Click the Edit icon next to the desired Code. The "Edit Certificate" pop-up window is displayed.

  2. Make any necessary changes to the Certificate Code properties. 

  3. Click save

Export Offer Certificate Data

The Definition tab provides the following features related to exporting Certificate code records.

 Create Export Definition

Click hereClick here

Export definitions can optionally be saved and reused, when you need to download Certificate Codes from the Loyalty platform:

From the "Actions" drop-down menu, select "Export Reward Certificates." The "Create New Export - Reward Certificates" pop-up window is displayed.

 

Timing 

  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 ScheduleDefine 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.

 

Notification and Transport 

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. 

 

Fields 

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.

 

Rules 

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.

 

Associations

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.

 

Children 

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.

 

Finish

When finished creating the Export Definition, click save

 

 View or Edit an Export Definition

Click hereClick here

To view or edit a Reward Certificate Export Definition:

  1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Reward Certificates Exports." The "Reward Certificates Export Definitions" pop-up window is displayed and populated with a list of all Reward Certificate 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

Click hereClick here

To manually execute a Reward Certificate Export Definition:

  1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Reward Certificates Exports." The "Reward Certificates Export Definitions" pop-up window is displayed and populated with a list of all Reward Certificate 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

Click hereClick here

To download the last execution of an Export Definition:

  1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Reward Certificates Exports." The "Reward Certificates Export Definitions" pop-up window is displayed and populated with a list of all Reward Certificate 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

Click hereClick here

To delete a Reward Certificate Export Definition:

  1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Reward Certificates Exports." The "Reward Certificates Export Definitions" pop-up window is displayed and populated with a list of all Reward Certificate 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 Offer Certificate Data

The Rewards screen provides the following features related to importing Offer Certificate records.

 Import Reward Certificates

Click hereClick here

From the "Actions" drop-down menu in the top-right corner of the screen, select "Import Reward Certificates." The "Create New Import -Reward Certificates" 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. If you want to import blank values, select the "Yes" radio button next to "Include Blank Values."

  4. 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."

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

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

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

  8. To select the import file, click choose file, then browse to and select the desired file.

  9. Select a column separator: Comma or Semicolon.

 

Import Options

To configure additional import options:

  1. Click add 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 Reward Certificate Imports

Click hereClick here

To view a list of previous Reward Certificate imports:

  1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Reward Certificates Import List." The "Reward Certificates Import List" pop-up window is displayed and populated with a list of all previous Reward Certificate 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

 

Back to Reward Details