Punch Card Details: Definition

Overview

The Definition tab is used to configure the properties and details of this Punch Card.    

Features

The features available on the Definition tab are described below. 

Prize Rules

For many Punch Card use cases, the Member earns a Prize when they complete the Punch Card. The Prize can be another Loyalty asset, or it can be a set number of points in the selected point metric. A Punch Card can optionally grant multiple Prizes, either at completion, or along the way toward completion. For example, you could have a Punch Card that requires ten punches to complete, but grant the Member a smaller Prize when the Punch Card is half complete at five punches.  

The configuration options available in the Prize Rules section are described below. 

Note: The Prize Rules section is displayed only for Standard and External Punch Card types. 

 Define the Punch Card Prize

Click hereClick here

A Punch Card can have one or more prizes assigned to it. To define a Punch Card prize:

  1. Click add prize. The "Add Prize" pop-up window is displayed.

  2. Next to "Punches Reached," select either:

  • Static: Enter the number of punches required to earn this Prize (or leave the field blank to use a default maximum number of punches defined for the Punch Card type).

  • Member Attribute: Select a Member Attribute where the number of required punches will be stored.

  1. Check has reward to use a Loyalty asset as a Prize. From the drop-down menu, select the asset type (Offer, Reward, or Gift Card). Please note that a Reward is used as an "Award," meaning no points are deducted from the Member's accumulated points when they win the Prize. From the second drop-down menu, select the desired asset of the selected type.

  2. Check metrics to use points as a Prize. In the text field, enter the number of points the Member will earn. From the drop-down menu, select the desired metric.

  3. Click add.  

  4. Repeat the above steps as needed to define additional Prizes for this Punch Card.

 

 Edit Prize Properties

Click hereClick here

To edit an existing Punch Card Prize:

  1. In the Action column next to the desired Prize, click the Edit icon. The "Edit Punch Card Prize" pop-up window is displayed.

  2. Make any necessary changes to the Prize properties.

  3. Click save.  

 

 Delete a Prize

Click hereClick here

To edit an existing Punch Card Prize:

  1. In the Action column next to the desired Prize, click the Delete icon.  A confirmation dialog box is displayed.

  2. Click confirm.

Punch Limits

The Punch Limits section is used to configure additional business rules for how Members earn punches. The configuration options available in the Punch Limits section are described below.

 Configure Punch Limits

Click hereClick here

To configure the punch limits for this Punch Card:

  1. You can optionally set a maximum number of punches that can be earned within a time frame, such as "two per week." In the "Punch Rate Limit per Card" field, enter the maximum number. From the "Per" drop-down menu, select the time period. If you prefer not to set a limit, check no limit

  2. To enforce the Punch Card limit across all Punch Cards in a Category, select the desired Punch Card Category from the "Limit Across Same Category" drop-down menu. 

  3. Optionally, you can require the Member to earn punches within a specific time frame, such as "one per day." Next to "Require a punch at least every," enter the minimum required number, and select a time period. 

  4. Click save

Choices

A Choices type Punch Card is intended for clients using externally-generated Punch Cards, and who want to allow the Member to choose which Punch Card to activate. From the Choices section, you can configure which Punch Cards are available to the Member. 

Note: The Choices section is displayed only for Choice Punch Card types. 

 Configure Choices

Click hereClick here

To configure the available Punch Cards for this Choice Punch Card:

  1. Click add choices. The "Add Choices" pop-up window is displayed and populated with all External Punch Cards defined in your account. 

  2. Optionally filter the list of External Punch Cards by entering a text string, or defining a "published date" date range. Press Enter, or click the search button (magnifying glass icon). The list is refreshed to show only the Punch Cards that meet your search criteria. 

Note: If you click the name of the Punch Card, the Punch Card Details screen is displayed. 

  1. In the Select column, check the check box next to the desired Punch Card. Repeat this step as needed. 

  2. Click add selected

 

 Remove a Punch Card

Click hereClick here

To remove an External Punch Card:

  1. In the Remove column next to the desired Punch Card, click the Delete icon.  A confirmation dialog box is displayed.

  2. Click confirm.

Note: Optionally, click remove all to remove all External Punch Cards. 

Extra JSON

The configuration options available in the Extra JSON section are described below. 

 Define Custom JSON

Click hereClick here

The "Extra JSON" section allows you to extend the standard API to include additional metadata relevant for external processing.

To assign custom JSON code:

  1. Next to "Extra JSON," click edit. The "Edit" pop-up window is displayed.

  2. Enter your custom JSON code.

  3. Click save.


Effectivity

All Punch Cards are governed by an effectivity period. 

 Define Punch Card Effectivity

Click hereClick here

Punch Cards are governed by an overall Effectivity Period that controls when a Punch Card is considered active and available for use. In addition to the overall Effectivity Period for the Punch Card, the platform allows you to set more granular schedules that control when a Member can respond to the Punch Card (called the Response Period), and when the platform considers responses to be usable for reporting and analytics (called the Usage Period). Optionally, you can click the Recurring checkbox to define a new recurring schedule for an item's effectivity when the Select Period Type is Fixed.

Note: Depending on the Punch Card type, the effectivity period options may vary slightly. You may see some, or all, of the options described below.

Response Period

To define the response period:

  1. Click on the Select Period Type drop down and choose:

  • Same: Uses the same effectivity period as defined for the Punch Card.
  • Relative
    1. Select the interval and a unit of time for the beginning of the date range. Ex. 1 hour.
    2. Select the interval and unit of time for the end of the date range. Ex. 2 weeks.
  • Fixed
    1. Enter a date range relative to the publish date. 
    2. Select the time zone you want the effectivity period to be effective.
    3. Optionally, check Recurring to use a recurring schedule. Select the desired schedule from the Recurring Schedule drop down menu, or define a new recurring schedule. See below for details on creating a new recurring schedule.
  1. Click save.

Usage Period

To define the usage period:

  1. Click on the Select Period Type drop down and choose:

  • Always: Punch Card does not expire.
  • Same: Uses the same effectivity period as defined for the Punch Card.
  • Relative
    1. Select the interval and a unit of time for the beginning of the date range. Ex. 1 hour.
    2. Select the interval and unit of time for the end of the date range. Ex. 2 weeks.
  • Fixed
    1. Enter a date range relative to the publish date. 
    2. Select the time zone you want the effectivity period to be effective.
    3. Optionally, check Recurring to use a recurring schedule. Select the desired schedule from the Recurring Schedule drop down menu, or define a new recurring schedule. See below for details on creating a new recurring schedule.
  1. Click save.

Define Recurring ScheduleDefine Recurring Schedule


Back to Punch Card Details