Offer Details: Certificates

Overview

The Certificates tab is used to create, view, and manage Certificate Codes for this Offer.

Certificate Codes are an optional feature within Offers that allow you to send unique, single-use codes to your Members or to other customers. Certificate Codes are stored within the platform as an Offer Certificate asset type. These Codes are often (but not always) associated to an Offer. The platform does allow you to create "unassigned" Certificate Codes that aren't associated to an Offer (see Offer Certificates for more details on that process).

Note: If the Offer Action Type is Certificate, you can manage the Certificate Codes from the Definition tab.

Features

The features available on the Certificates tab are described below.  

Managing Certificate Codes

Enable Certificate Codes

"Certificate on Responses" Flag

The Certificate on Responses Flag is used in multiple operations to determine the following:

  1. Offer APIs: Determine if certificate details will be displayed in an offer for the API response.

  2. Issuing of Offers: This flag is checked before assigning unused certificates via API, Marketing Console/ CSR Actions, and via Triggered Actions.

To enable Certificates Code in this Offer:

  1. Within the "Certificates on Responses" section, click Edit. The Edit Offer pop-up window is displayed.

  2. Check "Certificates on Responses."

  3. Click save.

Searching and Sorting

On the Offer 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 Offer Details 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 Offer 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

  • Offer Name

 Create a Certificate Code

To manually create a Certificate Code:

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

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

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

To generate one or more Certificates:

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

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

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

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

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

Note: The recommended best practice is to exclude the following characters: 0,O,o,1,I,i,l,6,A,E,I,U,G,g,Q,q,5,S,s,a,b,c,d,e,f,h,j,k,m,n,p,r,t,u,v,w,x,y,z

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.

  1. Check "Use Offer Effectivity" if you want the Certificate Codes to "inherit" the overall Effectivity Period defined for the Offer. If you don't check this option, you'll need to define the Effectivity Period for each Code.

  2. Check "Unique in all Offers" if you want the Certificate Code values to be unique across all Offers in your Loyalty account.

  3. If you want the platform to generate Certificate Codes in batches, enter the number of records in a batch within the "Batch Size" field

  4. Click generate.   

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

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. 

Add Extra JSON

Beneath the list of Codes, the "Extra Definition for Certificate" section allows you to define custom JSON code for this Offer. To assign custom JSON code:

  1. Next to "Extra Definition for Certificate," click edit. The "Edit Offer" pop-up window is displayed.

  2. Enter Certificate Code display text. 

  3. Enter your custom JSON code.

  4. Click save.

Export Offer Certificate Data

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

 Create Export Definition

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 Offer Certificates." The "Create New Export - Offer 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 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. Clickadd. 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, clicksave. 

 View or Edit an Export Definition

To view or edit an Offer Certificate Export Definition:

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

To manually execute an Offer Certificate Export Definition:

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

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 "Offer Certificates Exports." The "Offer Certificates Export Definitions" pop-up window is displayed and populated with a list of all Offer 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

To delete an Offer Certificate Export Definition:

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

 Import Offer Certificates

From the "Actions" drop-down menu in the top-right corner of the screen, select "Import Offer Certificates." The "Create New Import - Offer 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, clickchoose 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. 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, clicksubmit.

 View Offer Certificate Imports

To view a list of previous Offer Certificate imports:

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