Versions Compared

Key

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

Back to Notifications Main Page

Excerpt
hiddentrue

Learn to configure Notification Run Definitions that will determine the overall behaviour of Notification Runs

Panel
nameblue

Table of Contents

Table of Contents
minLevel2

Navigating to Notification Run Definitions

Info

CRM > NOTIFICATIONS > PERFORM NOTIFICATION RUNS

What are Notification Run Definitions?

Notification Run Definitions are used to define the rules by which Notification Runs, responsible for creating Notifications will be executed. The two Classifications of Notification Run Definitions are 'Financial' and 'Customer Care'.  Each Classification supports separate Entities which result in the generation of different types of information.  The Classification also determines the conditions available to be set on/by? each Run Definition.

 

  • Financial Classification
    This is related to Financial information of the supported entities, such as balances and outstanding debts. 
    • Subscription
    • Bills
    • Wallets
    • Wallet Product Consumption
  • Customer Care Classification
    This is related to Customer Care information of the supported entities, such as confirmation of payments, award points earned, redeemed or expired and Goods and Services added to a Subscription.
    • Subscriptions
    • Jobs
    • Activities
    • Leads
    • Service Requests
    • Rewards Participants
    • Award Transactions
    • Spend Transactions
    • Award Expiration Transaction
    • Payment Gateway Cards
    • Payment Gateway Requests
    • Payments
    • Buy in Advance Request
  • Status
    colourBlue
    titleAvailable from CRM.COM R12.0.0
     Reward Offers Classification
    This is related to Reward Offers Information.
    • Reward Offers

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 executed, a Process Run is logged, and once 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).
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 Notification 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. 

  • Select a Classification ('Financial' or 'Customer Care') and use the Actions Menu to create a NEW Definition.

  • Use the Actions Menu to 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.

  • Click on the Audit Log button to view a log of changes performed on the displayed Notification Run Definition.

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

Notification Runs

Anchor
validations
validations
Validations & Restrictions

ActionValidationsRestrictionsAdditional Information
Create
  • Mandatory Fields must be defined
    • Notification Type
      • Customer Care Notifications:
        At least one Segment MUST be defined (in 'Included' or 'Excluded')
      • Financial Notifications:
        At least one of the available criteria MUST be defined
  • Name and Alternative Code must be unique
  • Selected Notifications Type
    should be associated to a Communication Template including  Tags of the following Types exclusively:
    • For Financial Notifications
      • Notification Tags
      • Contact Information Tags
      • Accounts Receivable Tags
    • For Customer Care Notifications
      • Notification Tags
      • Contact Information Tags
      • Entity Tags of the Entity that is included in the related Notification Item
    • Status
      colourBlue
      titleAvailable from CRM.COM R12.0.0
      For Reward Offers Notifications
      • Reward Offers Tags
  • On creating a new Notification Run, there is the option to select between two separate Classifications of Notification Run Definitions, depending on which different criteria are made available.
    • Financial
      • Accounts Receivable
      • Wallet
      • Subscription
      • Notification
      • Segment
      • Notification History
    • Customer Care
      • Segments
      • Notification History
    • Status
      colourBlue
      titleAvailable from CRM.COM R12.0.0
      Reward Offers
      • Reward Offers
Edit
  • Mandatory Fields must be defined
  • Name and Alternative Code must be unique
  • Selected Notifications Type
    should be associated to a Communication Template including Tags of the following Types exclusively:
    • For Financial Notifications
      • Notification Tags
      • Contact Information Tags
      • Accounts Receivable Tags
    • For Customer Care Notifications
      • Notification Tags
      • Contact Information Tags
      • Entity Tags of the Entity that is included in the related Notification Item
    • Status
      colourBlue
      titleAvailable from CRM.COM R12.0.0
      For Reward Offers Notifications
      • Reward Offers Tags
  • If there is one or more 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 Notification Run Definition.
Alternative CodeThe alternative code of the Notification Run Definition. Unless otherwise specified, the Alternative Codes for new entries default to the Name initials in capital letters.
DescriptionA description of the Notification Run Definition.
Life Cycle StateThe Life Cycle State of the Notification Run Definition. The supported values are 'Effective' and 'Not Effective'. Only 'Effective' Notification Run Definitions can be used to generate Notifications.
Unified CodeAn auto-generated code which is used to group the various instances of the Notification Run Definitions
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.

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

Scheduled DateThis is a Read-only field which is available once a Run is scheduled. The date provided shows the latest date that the Run is scheduled to be executed on.
Notification Type*

The Type of Notification that will be created when the Notification Run Definitions are used to generate Notifications.
The list of available Notification Types will be filtered according to the Classification selected on creating a new Notification Definition.

  • Customer Care Process
  • Financial Process

Status
colourBlue
titleAvailable from CRM.COM R12.0.0
Existing Notification Type can be selected but a new one can also be created through the Notification Run Definitions.

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

Note

Status
colourBlue
titleDEPRECATED FROM CRM.COM-R12.0.0 ONWARDS
From R12.0.0 onwards, the Criteria section is removed from Notification Run Definitions and moved to Notification Types.

 

Segment Criteria
Included in Segment

A list of Segments which are used to filter the Contact Information, Accounts Receivable or Notification Item that will be notified.

Note

Segments with one of the following main entities are available:

  • Contact Information
  • Accounts Receivable
  • An entity included in the related Notification Item, determined by the Notification Type.
Excluded from Segments

A list of Segments which are used to prevent Contact Information, Accounts Receivable or Notification Items from being notified.

Note

Available options are the same as those of "Included in Segments".

Notification History Criteria
Notified Previously

Defines a list of Notifications that should have already been generated for the criterion to be considered as met. It includes the following options:

  • Notification Typ
  • Life Cycle State
  • Created less than X UOT ago (measured in minutes, days, weeks, months or years)
  • Created more than X UOT ago (measured in minutes, days, weeks, months or years)
Not Notified Previously

Defines a list of Notifications that should not already exist; i.e. the customers have not been sent these Notifications previously.

Available options are the same as those of "Notified Previously".

Accounts Receivable Criteria

Note

Only available for Financial Notification Run Definitions

 

Accounts Receivable Balance

Filters the Accounts Receivable based on Balance. Two options are available, which can be used in tandem:

  • More than:checks for a value that is more than or equal to the one specified (≥).
  • Less than: checks for a value that is less than the one specified (<).
Accounts Receivable Outstanding Amount

Filters the Accounts Receivable based on Outstanding Amount and a specific due date. Two options are available, which can be used in tandem:

  • More than:checks for a value that is more than or equal to the one specified (≥).
  • Less than: checks for a value that is less than the one specified (<).

The due date can be specified in one of the following ways:

  • Due in X Days: The System checks for Accounts whose outstanding amount is due up to a date equal to the current date + X (a user-defined integer representing a number of days). For example, if the current date is the 23rd of the month and X is set as 5, the System retrieves accounts with outstanding amounts due up to the 28th.
  • Due X days ago: The System checks for Accounts whose outstanding amount was due up to a date equal to the current date - X (a user-defined integer representing a number of days). For example, if the current date is the 23rd of the month and X is set as 5, the System retrieves accounts that were due up to the 18th.
Accounts Receivable ClassificationFilters the Accounts Receivable based on a list of Accounts Receivable Classifications.

Status
colourYellow
titleDeprecated from CRM.COM-R11.0.0 onwards

Accounts Receivable Credit Rating

Filters the Accounts Receivable based on a list of Accounts Receivable Credit Ratings.

Notification Criteria

Note

Only available for Financial Notification Run Definitions

 

Total Outstanding Amount per Notification

Filters the Notifications to be created based on the total outstanding amount of each Notification, calculated using associated respective invoices. Two options are available, which can be used in tandem:

  • More than:checks for a value that is more than or equal to the one specified (≥).
  • Less than: checks for a value that is less than the one specified (<).

Wallet Criteria

Note

Only available for Financial Notification Run Definitions

 

Wallet Balance

Filters the Accounts Receivable based on the Balance of Wallets owned by that account.  Two options are available, which can be used in tandem:

  • More than:checks for a value that is more than or equal to the one specified (≥).
  • Less than: checks for a value that is less than the one specified (<).
Wallet Estimated Consumption Days

Filters the Accounts Receivable based on the estimated consumption days of Wallets owned by that account.  Two options are available, which can be used in tandem:

  • More than:checks for a value that is more than or equal to the one specified (≥).
  • Less than: checks for a value that is less than the one specified (<).
Wallet Product Estimated Consumption Days

Filters the Accounts Receivable based on the Product estimated consumption days of Wallets owned by that account.  Two options are available, which can be used in tandem:

  • More than:checks for a value that is more than or equal to the one specified (≥).
  • Less than: checks for a value that is less than the one specified (<).

Wallet Amount Expiration Up To Date

Status
colourYellow
titleAvailable from CRM.COM R11.1.0

Filters the Wallets based on the amount that will expire by a defined date.

  • Date

Optionally, an amount to be expired by the specified date which is greater than or equal to a specified minimum (amount) can be used to filter the Wallets.

  • Minimum Expiration Amount
Note

A minimum expiration amount cannot be provided without an expiration date.

Subscription Criteria

Note

Only available for Financial Notification Run Definition

 

Subscription Types

Filters the Accounts Receivable based on the Type of Subscriptions owned by the Accounts Receivable.

Billing Term SchemesFilters the Accounts Receivable based on the Billing Term Schemes of Subscriptions owned by the Accounts Receivable.

Status
colourYellow
titleDeprecated from CRM.COM-R11.0.0 onwards

Price Plans

Filters the Accounts Receivable based on the Price Plans of Subscriptions owned by the Accounts Receivable.
Status
colourYellow
titleDeprecated from CRM.COM-R11.0.0 onwards

Billing Frequencies
Filters the Accounts Receivable based on the Billing Frequencies of Subscriptions owned by the Accounts Receivable.
Status
colourYellow
titleDeprecated from CRM.COM-R11.0.0 onwards

Binding Periods
Filters the Accounts Receivable based on the Binding Periods of Subscriptions owned by the Accounts Receivable.
Status
colourYellow
titleDeprecated from CRM.COM-R11.0.0 onwards

Binding State
Filters the Accounts Receivable based on the Binding State of Subscriptions owned by the Accounts Receivable.
Scheduling Setting
Scheduling SettingsMethod - The following options are available:
  • Run Now
  • Run on Specific Date / Time
  • Run Repeatedly
  • Advanced Scheduling

Refer to Scheduler Task for configuration guidelines.

Throttling Settings
Throttling Settings

Determines the maximum number of processed entries that should be affected per Run and the interval between each Run. This is available only if the Repeat and Advanced Repeat options are selected. Throttling settings include:

  • Maximum Batch Size 
  • Start Again After X UOT (seconds, minutes, hours, days) 
Note

Throttling Settings can be configured only if Logging Method is set to 'Log Processed Successfully and Processed with Errors'.

Process Runs
Process RunsDisplays the Runs that were executed for the specific Definition. Each Run includes the Subscriptions that were processed. In case Incase of an error, the error code and description is descriptionis displayed.
Log Information
Log DetailsThe standard set of Log Details information available in all entities.
Note

View Understanding Notifications for business examples related to Notification Runs.

Panel
namegrey

Related Areas

Filter by label (Content by label)
showLabelsfalse
spacesV4Manual
showSpacefalse
labelsnotifications-basics-r7,notifications-advanced-r7,notifications-admin-r7

Panel
namegrey

Helpful Links

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