Versions Compared

Key

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

Back to Wallets Main Page

Excerpt
hiddentrue

Learn to configure Wallet Balance Expiration Run Definitions that will determine the overall behaviour of Wallet Balance Expiration Runs

Status
colourGreen
titleAvailable from CRM.COM R10.0.0

Panel
nameblue

Table of Contents

Table of Contents
minLevel2

Navigating to Wallet Balance Expiration Run Definitions

Info

FINANCE > WALLETS > PERFORM WALLET BALANCE EXPIRATION RUNS

What are Wallet Balance Expiration Run Definitions?

Wallet Balance Expiration Run Definitions are used to define the rules by which Runs will be performed, to identify the Wallet amount that should be expired and debit the Wallet for the unspent amount of money (the identification process is performed based on the specified Expiration Date and the amount already spent). The resulting debit that reflects the expired amount is directly allocated against the expired credit amount.
The Expiration Date is specified either manually or automatically, as part of a Reward Offer Award that has a specific Expiration Date and it is available on Credit and Transfer Wallet Transactions.

Tip

It is recommended that Wallet Balance Expiration Runs are configured to be executed on a daily basis.

Run Definitions, must be submitted once created and will be executed once or on a recurring basis, based on the defined scheduling settings. Once a Definition is performed, a Process Run is logged, and when the Run is completed, the log information is available in the respective section.
The user has the option to delete the specific run as long as it is not yet executed (still in 'Draft' state).
For a Definition to be submitted it must have an 'Effective' Life Cycle State. The Life Cycle State can be changed between 'Effective' and 'Not Effective' using the dedicated action.

  • Navigate to Wallet Balance Expiration Run Definitions and explore existing entries via the Summary page
  • Click on the link (Name or Number) of the entry 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 Wallet Balance Expiration Runs, including each Action's related validations, restrictions and additional information. View the Attributes Table for a comprehensive description of the Wallet Balance Expiration Run fields.

Wallet Balance Expiration Run Definition

Anchor
validations
validations
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 be unique.
  • 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 exists at least one scheduled or completed Run for that Definition.
  • Not Applicable

 

Anchor
attributes
attributes
Attributes

An * indicates a field is mandatory.

Name

Description

Main Information
Name *The name of the Wallet Balance Expiration Run Definition.
Alternative Code*The alternative code of the Wallet Balance Expiration Run Definition. Unless otherwise specified, the Alternative Codes for new entries default to the Name initials in capital letters.
DescriptionA description of the Wallet Balance Expiration Run Definition.
Life Cycle State *The Life Cycle State of the Wallet Balance Expiration Run Definition which can be:
  • 'Effective'
  • 'Not effective'
Unified Code An auto-generated code which is used to group the various instances of the Wallet Balance Expiration Run Definition.
VersionAn auto-generated number which is used to specify the version of each Run Definition. If the version number is already used by a Run, a new Run Definition Version is created when the Definition is edited.

The VIEW PREVIOUS VERSIONS link allows the user to search and view previous versions of the Definition.

Scheduled DateA Read-only field which is available once a Run is scheduled and designates the latest date that the Run is scheduled to be executed or has been executed.

Logging Method

Status
colourBlue
titleAvailable 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
Defines the criteria that will be used to identify the Wallet Allotments that will be expired.
Wallet Allotments Expired X Days Ago *

Determines the Wallet Allotment Expiration Date in relation to the date of execution, measured in days.

Note

The process will retrieve Wallet Allotments having an Expiration Date which is equal to or before the execution date minus the specified number of days.

By default this is set to 0, so the process will retrieve Wallet Allotments having an Expiration Date which is equal to or before the date of execution.

Process Runs
Process RunsDisplays the Runs that were executed for this Definition. Each Run includes the Bills that were processed. In case of an error, the error code and description are displayed.
Scheduling Settings
Determines when the Definition will be executed after being submitted.
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 Settings can be configured.

Log Information
Log DetailsThe standard set of Log Details information available in all entities.
Panel
namegrey

Related Areas

Filter by label (Content by label)
showLabelsfalse
spacesV4Manual
showSpacefalse
labelswallets-basics-r7,wallets-advanced-r7,wallets-admin-r7

Panel
namegrey

Helpful Links

Filter by label (Content by label)
showLabelsfalse
spacesV4Manual
showSpacefalse
labelsglobal