Skip to end of banner
Go to start of banner

Using Award Expiration Run Definitions

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

AVAILABLE ONLY FOR CRM.COM R9.0.0

As of CRM.COM R10 and onwards Award Expiration Run Definitions are no longer available. The Expiration process is handled by the Wallet Balance Expiration Run Definitions

Table of Contents

Navigating to Award Expiration Run Definitions

REWARDS > REWARDS > PERFORM Reward EXPIRATION RUN DEFINITIONS

What are Award Expiration Run Definitions?

Award Expiration Run Definitions are a set of business rules which are used by Award Expiration Runs to evaluate the validity of Awards provided to Rewards Participants and to debit the participants' Wallets whenever unspent awarded amounts expire.

Run Definitions must be submitted once created and are executed once or on a recurring basis, depending on the defined Scheduling Settings. Each time a Definition is executed, a Process Run is logged, and once the Run is completed, the information is available in the /wiki/spaces/WIP/pages/10008606.
The user has the option to delete the specific run provided it has not been executed (still in 'Draft' state).
A Definition must be in an 'Effective' Life Cycle State to be submitted.  The state can be changed between 'Effective' and 'Not Effective' using a dedicated action.

  • Navigate to Award Expiration Run Definitions and explore existing records via the Summary page. 

  • Click on the link (name or number) of the record of your interest to access the Data Entry page and see more detail, or submit the Definition. 

  • Use the Actions Menu to create a NEW Definition, modify (EDIT), or DELETE an existing one.  

  • Use BACK to return to the Summary page and CANCEL to revert any unwanted changes made to the Definition. 

Check the Validations & Restrictions Table below for a list of available Actions when working with Award Expiration Run, including each Action's related validations, restrictions and additional information.  View the Attributes Table for a comprehensive description of the Award Expiration Run fields.

AWARD EXPIRATION RUN DEFINITIONS

Validations & Restrictions

ActionValidationsRestrictionsAdditional Information
General
  • Multiple Award Expiration Run Definitions can exist in the system, but each one should have a unique Name and Alternative Code
  • Not Applicable
 
  • Not Applicable
Create
  • Mandatory Fields must be defined
  • Name and Alternative Code must beunique
  • Not Applicable
 
  • Not Applicable
Edit
  • Mandatory Fields must be defined
  • Name and Alternative Code must beunique
  • Not Applicable
  • If there are one or more scheduled Runs using the same Definition, then a new Run Definition instance is created.  The new Definition will have the same values and Unified Code as the first one, an augmented version number and all the modified information.
Delete
  • Not Applicable
  • Run Definitions cannot be deleted if there is at least one scheduled or completed run for that Definition
 
  • Not Applicable
Submit
  • Not Applicable
  • Not Applicable

 

Attributes

An * indicates a field is mandatory 

Name

Description

Main Information
Name*The name of the Award Expiration Run Definition
Alternative code*The alternative code of the Award Expiration Run Definition
DescriptionA description of the Award Expiration Run Definition
Life Cycle StateThe Life Cycle State of the Award Expiration Run Definition. The supported values are 'Effective' and 'Not Effective'. Only 'Effective' Award Expiration Run Definition can be used to generate Award Expiration Transactions
Unified CodeAn auto-generated code which is used to group the various instances of the Award Expiration Run Definitions
VersionAn auto-generated number which is used to specify the version of each Run Definition. If the version is already in use by a Run, a new Run Definition Version is created each time the Definition is edited.

"VIEW PREVIOUS VERSIONS" link allows you to search and view any previous versions of the Definition

Criteria
Award Expiration (optional criterion)
Award Transaction Expired X Days Ago

Determines the Award Transaction's expiration date in relation to the date of execution, measured in days. If specified, then the process will retrieve Award Transactions having an expiration date between the date of execution and the specified number of days before the execution.

Reward Offers
Reward OffersDefines a list of Reward Offers through which expired Award Transactions were generated. The Award Expiration process considers only Award Transactions related to the specific Reward Offers. Of no Reward Offers are specified, then Award Transactions will be retrieved regardless of their related Reward Offer.
Segment Criteria
Included In Segment

A list of segments which are used to filter the expired Award Transactions. The criteria consist of the following:

  • Segment: A select box with all the segments having Award Transactions as the segment entity

Not Included In Segment

A list of segments which are used to exclude expired Award Transactions. The criteria consist of the following:

  • Segment: A select box with all the segments having Award Transactions as the segment entity

Scheduling Settings

Determines when the Definition will be executed after being submitted

Scheduling Settings*

Method - The following options are available:

  • Run Now
  • Run on Specific Date / Time
  • Run Repeatedly
  • Advanced Scheduling

Refer to Scheduler Task - Global to find out how the options can be configured

Process Runs
Process RunsDisplays all the Award Expiration Runs which were performed based on the specific Run Definition, as well as all the Run Information
Log Information
Log Details The standard set of Log Details information available in all entities  

View Understanding Rewards for business examples related to Award Expiration Run

Related Areas

Helpful Links

  • No labels