Versions Compared

Old Version 4

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 Back to Rewards Main Page

Excerpt
hiddentrue

Learn how you can to configure and execute Award Expiration Run Definitions - that dictate the overall behaviour of the Award Expiration Run

Note

Status
colourRed
titleAVAILABLE FROM Available only for CRM.COM R9

Status
colourRed
titleAVAILABLE FROM CRM.COM R9

What does this section cover?

.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

Panel
nameblue

Table of Contents

Table of Contents
minLevel2

What are Award Expiration Run Definitions

Navigating to Award Expiration Run Definitions

Info

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 Reward participants Rewards Participants and to debit the participants' Wallets whenever the awarded amount expires before being spent.All Award Expiration Runs that were performed based on each Award Expiration Run Definition can be viewed within the reward run definition.

Award Expiration Runs can be applied only through an effective Award expiration Run Definition and the result is the creation of Award Expiration Transactions

Creating, Editing & Deleting

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 Image Added

Anchor
validations
validations
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.Name and Alternative Code
  • Not Applicable
  •  Not Applicable
Create
  • All mandatory fields must be provided
  • Active Rewards Definition exist in the system
Edit
  • All mandatory fields must be provided
  • If there is at least one scheduled or completed run using the rewards run definition latest instance then a new rewards run definition instance is created
  • Not Applicable
Delete
  • Not Applicable
  • Award Expiration run definitions cannot be deleted, 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 rewards processing run for that definition.
Award Expiration Run Definitions attributes 
  • Definition
  •  Not Applicable
Submit
  • Not Applicable
  • Not Applicable

 

Anchor
attributes
attributes
Attributes

An * indicates a field is mandatory 

Award Transaction expired X days agoScheduling Settings* definition should be applied in order to create Rewards. Rewards Run Definitions can be applied ad hoc or on a recurring basis. Scheduling settings hold the following information:Method: It provides the following options. For each option different settings are provided:
  • Run now
    • Run on specific Date / Time

    Name

    Description

     Name
    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 stateCycle StateThe life cycle state Life Cycle State of the Award Expiration Run Definition. The supported values are effective and not effective. Only effective 'Effective' and 'Not Effective'. Only 'Effective' Award Expiration Run Definition can be used to generate award expiration transactionsAward Expiration Transactions
    Unified CodeAn auto-generated code which is used to group the various instances of the Award Expiration Run DefinitionDefinitions
    VersionAn auto-generated number which is used to specify the version of each Award Expiration each Run Definition. New Award Expiration Run Definition versions are If the version is already in use by a Run, a new Run Definition Version is created each time they are edited, if they are already been used to perform award expiration settlements
    Rewards Criteria
    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

    within

    between the date of execution and

    date of execution minus

    the specified number of days

    . This criterion is optional.

    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
    ncluded in 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 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:

    		Award Expiration Run informationIt displays
    • Run Now
    • Run on Specific Date / TimeRepeat
    • Run Repeatedly
    • Start at
    • End by Date / Time
    • Every X UOT
    •  Advanced Repeat
      • Start at
      • End Date
      • Recurrent Mode Settings
    Award Expiration Runs
    • 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 and displays all the run information as described in the section below

    Configuring a Award Expiration Run Definitions tailored to your company's needs

  • Navigate to REWARDS > REWARDS > PERFORM AWARD EXPIRATION RUN DEFINITIONS 
  • Either search for an existing one or from the Top Menu click on NEW
    AWARD EXPIRATION RUN DEFINITIONS Image Removed

  • MAIN INFORMATION

    1. Provide the required information:

      1. Name

      2. Alternative Code

      3. Description 

    2. View information regarding the following

      1. Scheduled Date

      2. Version

      3. Life Cycle State

  • CRITERIA

    1. Rewards Criteria
      1. Provide the required information

        1. Award Transaction expired X days ago

        2. Reward Offers

          1. Click on ADD and select a reward offer from the drill-down

    2. Segment Criteria
      1. Provide the required information

        1. Included in Segment

          1. Click on ADD and select a segment from the drill-down

        2. Not included in Segment

          1. Click on ADD and select a segment from the drill-down

    • SCHEDULING SETTINGS

    Include PageScheduler Task - GlobalScheduler Task - Global 

    LOG INFORMATION

    Include PageLog Information - GlobalLog Information - Global
  • From the Top Menu click on Save

    • Executing a Award Expiration Run Definitions

    Include PageExecuting Runs - GlobalExecuting Runs - Global

    Modifying a Award Expiration Run Definitions

     

    Include PageVersioningVersioning

    Deleting a Award Expiration Run Definitions

    Deleting a scheduled job of the specific Run

    Include PageDeleting a run- GlobalDeleting a run- Global

    Changing the Life Cycle State of a Award Expiration Run Definitions definition

    Include PageChange Life Cycle State of a Run definition - GlobalChange Life Cycle State of a Run definition - Global

    Reading Award Expiration Run Definitions Logs

    Include PageReading Run Logs - GlobalReading Run Logs - Global

     

    Run Definition, as well as all the Run Information
    Log Information
    Log Details The standard set of Log Details information available in all entities  
    Note

    View Understanding Rewards for business examples related to Award Expiration Run

    Panel
    namegrey

    Related Areas

    Filter by label (Content by label)
    showLabelsfalse
    spacesV4Manual
    showSpacefalse
    excerpttrue
    labelsrewards-basics-r7,rewards-advanced-r7,rewards-admin-r7

    spaceKey

    Helpful Links

    Panel
    namegrey

    Popular Labels

    Popular Labels
    Filter by label (Content by label)
    heatmap
    showLabelsfalse
    spacesV4Manualstyle
    showSpacefalse
    labelsglobal