Using Reward Settlement Run Definitions

 Back to Rewards Main Page

Table of Contents

Navigating to Reward Settlement Run Definitions

REWARDS> REWARDS > PERFORM REWARD SETTLEMENT RUNS

What are Reward Settlement Run Definitions?

Reward Settlement Run Definitions are used to execute runs that will evaluate Customer Events and /wiki/spaces/WIP/pages/10008604, to debit or credit the Merchant's accounts, based on the Awards provided or redeemed, using Contribution Rules defined for each Merchant. For example, when an Award is given via a Customer Event that was created by Unit C, then Unit's C account will be debited with the Award amount. When a Spend Request Customer Event is created by Unit C, then Unit's C account will be credited with the spent amount. The debiting amount is calculated based on the Contribution rules set on the Rewards Participating Merchants 

  • The account which will be debited and credited will be the one related to the Unit of the Rewards Participating Merchant AVAILABLE FROM CRM.COM R10.0.0

 

Run Definitions, must be submitted once created and will be executed once or on a recurring basis, based on the defined Scheduling Settings. Each time a Definition is executed, a Process Run is logged.  When the Run is completed, the information is available on the Financial Transaction screen, since the run results in the creation of Credit Notes and Invoices.

The user has the option to delete the specific run as long as it is not yet 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 Reward Settlement 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 Reward Settlement Run, including each Action's related validations, restrictions and additional information. View the Attributes Table for a comprehensive description of the Reward Settlement Run fields.

Note that only Awards from the Reward Offer Classifications below are taken into consideration for Settlements.
These are Reward Offer Types related to Purchase Customer Events and are not Additive. i.e. The Award is not dependent on multiple purchases (as different units may perform each purchase)

REWARD SETTLEMENT RUN

Validations & Restrictions

ActionValidationsRestrictionsAdditional Information
Create
  • Mandatory Fields must be defined
  • Name and Alternative Code must be unique
  • Not Applicable
  • Not Applicable
Edit
  • Mandatory Fields must be defined
  • Name and Alternative Code must beunique
  • Not Applicable
  • If there is at least one scheduled Run 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
  • The result is the generation of Credit Notes and Invoices (Financial Transactions)

 

Attributes

An * indicates a field is mandatory 

Name

Description

Main Information
 Name*The name of the Reward Settlement Run Definition
Alternative code*The alternative code of the Reward Settlement Run Definition
DescriptionA description of the Reward Settlement Run Definition
Life Cycle StateThe Life Cycle State of the Reward Settlement Run Definition.The supported values are 'Effective' and 'Not Effective'. Only 'Effective' Reward Settlement Run Definition can be used to debit or credit Accounts Receivable
Unified CodeAn auto-generated code which is used to group the various instances of the Reward Settlement Run Definition
Version

An 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

Logging Method

AVAILABLE FROM CRM.COM R12.0.0

Defines the method to be used for logging process run's results. Two options are available:

  • Log Processed Successfully and Processed with Errors: If selected, both entities successfully processed and failed ones will be logged in the Process Run Log.
  • Log Only Processed with Errors: If selected then only entities which failed to be processed will be logged in the Process Run Log.
Criteria
Reward Schemes
Reward Schemes

Defines a list of Reward Schemes used to apply Awards and spend the Awards. The Reward Settlement process will consider only the Reward Schemes in the list, to settle the Accounts Receivable of their Allowed Organisational Unit.

Customer Events
Process Customer Events Performed X Days Ago

Defines how many days must have passed after the Customer Event's Performed Date in order for Customer Events to be processed by the Run.
If not specified, then Customer Events will be processed regardless of their performed date.

Rewards Participating Merchants
AVAILABLE FROM CRM.COM R11.0.0 
Rewards Participating Merchants

It defines the Rewards Participating Merchants that should be considered during the Settlement Process. If no Rewards Participating Merchants are defined then all Rewards Participating Merchants are taken into account.

  • Number: The number of the selected Rewards Participating Merchant
  • Unit: The unit name of the selected Rewards Participating Merchant
  • Description: The description of the selected Rewards Participating Merchant
Input Settings
Reward Settlement Type*

Defines how the Organisation Unit's Accounts Receivable will be settled. Available options are:

  • Both Debit and Credit (default value)
  • Debit only
  • Credit only

Invoice Financial Transaction Type*

APPLICABLE UP TO CRM.COM R9.0.0

Defines the Type of the Invoice Financial Transaction that will be generated by the process run to debit the Organisational Unit's Accounts Receivable.

As of CRM.COM R10.0.0, this field is moved under Settlement Automation Section of Rewards Definition.

Product Included in Debit Financial Transaction*

APPLICABLE UP TO CRM.COM R9.0.0

Defines the product that will be included in the Invoice which will debit the Accounts Receivable of the Organisational Unit.

As of CRM.COM R10.0.0, this field is moved under Settlement Automation Section of Rewards Definition.

Credit Note Financial Transaction Type*

APPLICABLE UP TO CRM.COM R9.0.0

Defines the Type of the Credit Note Financial Transaction that will be generated by the process run to credit the Organisational Unit's Accounts Receivable.

As of CRM.COM R10.0.0, this field is moved under Settlement Automation Section of Rewards Definition.

Product Included in Credit Financial Transaction*

APPLICABLE UP TO CRM.COM R9.0.0

Defines the product that will be included in the Invoice which will debit the Accounts Receivable of the Organisational Unit.

As of CRM.COM R10.0.0, this field is moved under Settlement Automation Section of Rewards Definition.

Scheduling Settings

Determines when the Definition will be executed after being submitted

Scheduling Settings*

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 Settlement Runs which were performed based on the specific Run Definition, as well as all the Run Information
Log Information
Log DetailsThe standard set of Log Details information available in all entities  

View Understanding Rewards for business examples related to Award Settlement Run