R9 - Configuring and Executing Rewards Runs Definitions

Owned by Persia Xenopoulou (Deactivated)
Jan 05, 2016
4 min read

What does this section cover?

What are Rewards Runs Definitions?

Reward run definitions are a set of business rules which are used by reward runs to evaluate rewards participants and their information against the reward offers provided by their participating reward scheme and award & spend reward transactions for each offer which is applicable. 

Reward runs can be applied only through an Effective Reward run definition. 

Once a Reward Run definition is created, in order to populate any results it will need to be executed. A created run can be executed multiple times as long as it is set as Effective, and all the runs that were performed based on each reward run definition can be viewed within the reward run definition. 

Each time a Reward Run definition is executed the system evaluates rewards participants and their information against the reward offers provided by their participating reward schemes and award & spend reward transactions for each offer which is applicable. Specifically the following are evaluated:

  1. The reward schemes that will be evaluated are retrieved, based on the reward schemes specified in the reward run definitions. 
  2. The reward offers that will be evaluated are retrieved, based on the reward offer types specified in the reward run definitions

  3. Customer events which are not of type spend request are evaluated to decide if they should be awarded
  4. Award Reward Transactions are created for each customer event that is awarded

  5. Rewards Participants are evaluated to decide if they should be awarded
    Reward Participants will be awarded if they belong in a Reward Scheme included in the Run.
    AVAILABLE FROM CRM.COM R9.0.0 - Additionally the system will check the period within which a participant is signed on a particular scheme, using the sign on and sign off dates from each included rewards scheme for each participant
  6. Award Reward Transactions are created for each rewards participant that is awarded

  7. Rewards Participants Contact Information are evaluated to decide if they should be awarded
  8. Award Reward Transactions are created for each rewards participant contact information that is awarded

  9. Subscriptions are evaluated to decide if they should be awarded
  10. Award Reward Transactions are created for each subscription that is awarded

  11. Customer events which are of type spend request a are evaluated to decide if the specified amount of money can be spend
  12. Spend Reward Transactions are created for each customer event that is valid

Creating, Editing & Deleting Validations & Restrictions

ActionValidationsRestrictions
General
  • Multiple Run Definitions can exist in the system, but each one should have a unique name and alternative code.
  • 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
  • Rewards run definitions cannot be deleted, if there is at least one scheduled or completed rewards processing run for that definition.

Rewards Runs Definitions attributes 

Name

Description

NumberAn auto generated number that uniquely identifies the accounts receivable definitions
Name*The name of the definition
Alternative code*An alternative code for the definition. On creating a new definition it defaults to the first letter of each word included in the name (in Capitals), if nothing else is specified
DescriptionA description for the definition
StateThe state of the definition which can be active or inactive. Only one active definition can exist at any point
VersionAn auto generated number which is used to specify the version of each reward run definition. New reward run definition versions are created each time they are edited, if they are already been used to generate reward transactions
Scheduled DayIt displays the date that the run is scheduled to be executed
Criteria
Reward SchemesIt defines the reward schemes that should be considered during the evaluation process
Reward Offer TypesIt defines the reward offer types that should be considered during the evaluation process
Scheduling Settings
Scheduling Settings*

Determines when the 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
      • Specific Date / Time
    • Repeat
      • Start at
      • End by Date / Time
      • Every X UOT
    •  Advanced Repeat
      • Start at
      • End Date
      • Recurrent Mode Settings
Process Runs
Reward Run InformationIt displays all the reward runs runs which were performed based on the specific run definition and displays all the run information as described in Reading Reward Runs Logs

Configuring a Rewards Runs Definitions tailored to your company's needs

  1. Navigate to REWARDS > REWARDS > PERFORM REWARDS OFFER RUNS 

  2. Either search for an existing one or from the Top Menu click on NEW

    PERFORM REWARDS RUN DEFINITIONS

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

       

  4. CRITERIA

    1. Provide the required information

      1. REWARD SCHEMES

        1. Click on ADD and search and select schemes using the Search Modal

      2. REWARD OFFER TYPES

        1. Click on ADD and search and select offer types using the Search Modal

           

  5. From the Top Menu click on SAVE

  6. SCHEDULING SETTINGS

    1. Select from the available options according to what you would like to achieve
      1. RUN NOW: Will be executed once, now 
      2. RUN ON SPECIFIC DATE/TIME: Will be executed once, at the date defined
      3. RUN REPEATEDLY: Will be executed, starting and ending at a defined date/time and will be repeated every X UOT where UOT can be from seconds to Years
      4. ADVANCED SCHEDULING: Will be executed, starting and ending at a defined date with powerful repetition options from daily to yearly

    2. Run Now

      SCHEDULING SETTINGS - RUN NOW
       

    3. Run On Specific Date / Time

      1. Start Process
        1. Click on the calendar select the date and time the run should start being executed. 
          DATE AND TIME SELECTION
        2. Once selected click on "DONE"
          RUN ON SPECIFIC DATE TIME

    4. Run Repeatedly

      1. Start Process - On a Specific Date
        1. Click on the calendar select the date and time the run should start being executed. 
        2. Once selected click on "DONE"
      2. OR Start process - After a period of time
        1. Provide how long after current date/time the process should begin
          START PROCESS - AFTER A PERIOD OF TIME 
      3. Repeat Process
        1. EVERY: Type a number (INTEGER)
        2. UOT: Select between
          1. Seconds
          2. Minutes
          3. Hours
          4. Days
          5. Weeks
          6. Months
          7. Years
            REPEAT - UOT
      4. End Process
        1. Select between
          1. Never End
          2. On a specific date (define the date)
          3. After a period of time (define period of time)
            END PROCESS 

    5. Advance Scheduling

      1. Start Process
        1. Click on the calendar select the date and time the run should start being executed. 
        2. Once selected click on "DONE"
          ADVANCED SCHEDULING 
      2. Repeat Process
        1. Select between
          1. Daily : Define every how many days 
          2. Weekly: Select specific days of the week 
          3. Monthly:Define every how many months or on a specific day of the month
          4. Yearly: Define a specific date/month or a specific day of a month, such as the 1st Sunday of every January
            ADVANCED SCHEDULING - REPEAT PROCESS
      3. End Process
        1. Select between
          1. Never End
          2. On a specific date (define the date)
            ADVANCED - END PROCESS 
     

  7. LOG INFORMATION

    Log information section keeps all the logging information related to the specific record

    • Basic set of information available in all entities
      • Created By User: The user that created the entity
      • Created By Unit: The unit of the user that created the entity
      • Updated By User: The user that last updated the entity
      • Updated by Unit: The unit of the user that last updated the entity
      • Date Created: The date the account was entity
      • Date Updated: The date the account was last entity
        LOG DETAILS

Executing a Rewards Runs Definitions

  1. Navigate to the definition
  2. Search for the definition you would like to execute
  3. Click on the number of the definition to go to the data entry page
  4. Confirm that SCHEDULING SETTINGS are correctly configured
  5. From the Actions Menu click on ACTIONS > "SUBMIT"
    RUNS - SUBMIT
  6. The job will be submitted to the scheduler and will become available under PROCESS RUNS
    1. Once completed the Life Cycle State will be changed from Draft to Completed
    2. If the Run fails then the Life Cycle State will be updated to Failed
      PROCESS RUN
    3. Check Process Successfully and Processed with Errors for a closer look of individual results 

 

Modifying a Rewards Runs Definitions

When you edit a definition that already has completed or scheduled runs then the system will automatically update the Version of the definition, by increasing its number by 1. Essentially, the system will create a new definition and will carry over all the information and configuration, apart from the Version number.

Accessing a definition with multiple versions, you will always see the latest version, while you have the option to View configuration and Runs of Previous versions by using th "VIEW PREVIOUS VERSIONS" link found in the Main Information tab

  1.  Click on the VIEW PREVIOUS VERSIONS link
    VERSIONING 
  2. Search from the modal for the version you would like to see
  3. Select the version
    1. The system will now show the configuration and the process runs of the version you have selected.
  4. To go back to the current version click on the CURRENT VERSION link under Main Information
    CURRENT VERSION 

 

Deleting a Rewards Runs Definitions

Deleting a scheduled job of the specific Run

If you have scheduled (submitted) a Run by mistake or you want to change the definition before execution, you have the option to delete the current job that was sent to the scheduler, given that it has not been executed yet. i.e., Life Cycle State is still Draft.

In order to delete the job follow the steps below:

  1. Navigate to the definition, for which you have scheduled a job
  2. Click on the number of the definition to move in the data entry page
  3. Go to Process Runs tab
  4. Find the job and check the left box next to the Run
  5. Click on "DELETE"


  6. A modal will open with the job information
  7. Click on "DELETE"
  8. Click "OK" on the confirmation message
  9. Close the modal
    The job will be removed from the Process Runs 

Changing the Life Cycle State of a Rewards Runs Definitions definition

Definitions Life Cycle State can be changed between Effective and Not Effective by following the steps below 

  1. Go to the data entry page of the definition'
  2. If the definition's Life Cycle State is set to "Effective"
    1. From the Actions Menu click ACTIONS > SET AS NOT EFFECTIVE
  3. If the definition's Life Cycle State is set to "Not Effective"
    1. From the Actions Menu click ACTIONS > SET AS EFFECTIVE
      RUN DEFINITIONS - LIFE CYCLE STATE ACTIONS 

 

Reading Rewards Runs Definitions Logs

The following information regarding the Process Runs is available:

  1. Number: An auto generated number that uniquely identifies each process run.
  2. Version: The version of the process run's related process run definition.
  3. Life Cycle State: The life cycle state of the process run which can be pending, in progress or completed.
  4. Start Date: The date that the process run started.
  5. End Date: The date that the process run ended.
  6. Process Successfully: Drill down including the entities processed successfully. 

  7. Processed With Errors: Drill down including the entities that were not successfully processed.

 

Visit Understanding Rewards Runs Definitions for business examples related to Rewards Runs Definitions

Related Areas

Popular Labels