Versions Compared

Old Version 14

changes.mady.by.user Persia Xenopoulou (Deactivated)

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 Notifications Main Page

Excerpt
hiddentrue

Learn how you can configure and execute Notification Runs

What does this section cover?

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

Panel
nameblue

Table of Contents

Table of Contents
minLevel2

What are Notification Runs?

Notification Runs are used to log the execution of notification run definitions, that were performed in order to generate notifications and all the information that the notification is referring to.

Notification Runs can be performed only within an effective notification run definition.

A new Notification Run is created each time a recurring Notification Run Definitions is submitted. Whenever a run has been submitted, the notification run added to the scheduler to be executed based on the specified run definition scheduling.

In order to modify the scheduling information of a submitted Notification Run you can Edit the definition. 

Creating, Editing & Deleting

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

Anchor
validations
validations
Validations & Restrictions

ActionValidationsRestrictionsAdditional Information
General
  • Multiple Notification Run Definitions can exist in the system, but each one should have a unique name and alternative code.
N/A
CreateN/A
  • The information that can be specified on notification run definitions depends on the classification of the selected notification type.
  • Notifications Type selected should be related with a Communication Template with the following types of tags:
    • On communicating financial notifications
      • Notification, Contact Information and Accounts Receivable tags
    • On communicating customer care notifications
      • Notification,  Contact Information and the entity tags of the entity that is included in the related notification item
EditN/A
  • If there is at least one scheduled or completed notification run using the notification run definition latest instance then a new notification run definition instance is created
Delete
  • Notification run definitions cannot be deleted if there at least one scheduled or completed notification run for that definition.
N/A
Save
  • Mandatory Fields:
    • Name
    • Notification Type
    • Scheduling Settings
 

Notification Run attributes 

Description

Name

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 

Binding States

Notification

Outstanding Amount Per Notification

Segment

  • Included in Segments
    • Excluded in Segments

    Notification History

  • Notified Previously
    • Not Notified Previously

    SCHEDULING SETTINGS

    Include PageScheduler Task - GlobalScheduler Task - Global 

    THROTTLING SETTINGS

    Provide the required information
  • Maximum batch size
    • Start again after
    Criteria - Criteria - Criteria - Criteria - Notification CriteriaCriteria -

    Name

    Description

    Main Information
     Name*The name of the notification run definitionNotification Run Definition.
    Alternative CodeThe alternative code of the notification run definitionNotification 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 definitionNotification Run Definition.
    Life Cycle StateThe life cycle state Life Cycle State of the notification run definitionNotification Run Definition. The supported values are effective and not effective. Only effective notification run definitions 'Effective' and 'Not Effective'. Only 'Effective' Notification Run Definitions can be used to generate notificationsNotifications.
    Unified CodeAn auto-generated code which is used to group the various instances of the notification run definitionsNotification Run Definitions
    Version

    An auto-generated number which is used to specify the version of each

    notification run definition. New notification run definition versions are created each time they are edited, if they are already been used to generate notifications

    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

    Type of

    notification

    Notification that will be created

    whenever the notification run definitions

    when the Notification Run Definitions are used to generate

    notifications
    Scheduling Settings*

    Determines when the process run definition should be applied. Process 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
      • Repeat
      • Advanced Repeat
    Criteria

    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 Segments which are used to filter in the contact information or the accounts receivable the Contact Information, Accounts Receivable or Notification Item that will be notified, and optionally the notification information. The criteria consist .

    Note

    Segments with one of the following main entities are available:

    • Filtered entity: A select box displaying the main notification entity (i.e. contact information or Accounts receivable) and the entity which is selected in the notification information. The specified entity will be filtered while evaluating the results
    • Segment: A select box with all the segments having the selected filtered entity as the segment entity
    Not Included in Segment

    A list of segments which are used to excluded the contact information or the accounts receivable that will be notified, and optionally the notification information. Its criteria consist the same as in "Included in Segment"

    • 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 Notifications that should have already be been generated in the pastfor the criterion to be considered as met. It consist of includes the following valuesoptions:

    • Notification Type: The type of the notificationTyp
    • Life Cycle State: The life cycle state of the notification. The default value is the completed.
    • Created less than X UOT ago : measured (measured in minutes, days, weeks, months or years)
    • Created more than X UOT ago : measured (measured in minutes, days, weeks, months or years)
    Not Notified Previously

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

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

    Accounts Receivable Criteria

    Note

    Only available for Financial Notification Run Definitions

     

    Accounts Receivable Balance

    It filters the accounts receivable Filters the Accounts Receivable based on their balanceBalance. Two options are available, which can be used combinedin tandem:

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

    It filters the accounts receivable based on their outstanding amount Filters the Accounts Receivable based on Outstanding Amount and a specific due date. Two options are available, which can be used combinedin tandem:

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

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

    • Due in X Days: Checks for accounts that are due in up to the date that equals to (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 you specify X =is set as 5, then it checks for accounts the System retrieves accounts with outstanding amounts due up to the 28th.
    • Due X days ago: Checks for accounts that were The System checks for Accounts whose outstanding amount was due up to the a date that equals equal to (the current date - X(a user-defined integer representing a number of days). For example, if the current date is the 23rd and you specify X=5, then it of the month and X is set as 5, the System retrieves accounts that were due up to the 18th.
    Accounts Receivable ClassificationIt filters the accounts receivable Filters the Accounts Receivable based on a list of accounts receivable classificationsAccounts Receivable Classifications.

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

    Accounts Receivable Credit Rating

    		It filters the accounts receivable Filters the Accounts Receivable based on a list of accounts receivable credit ratingsAccounts Receivable Credit Ratings.

    Notification Criteria

    Note

    Only available for Financial Notification Run Definitions

     

    Total Outstanding Amount per Notification

    It filters the notifications that will Filters the Notifications to be created based on the total outstanding amount of each notificationNotification, as calculated based on the related calculated using associated respective invoices. Two options are available, which can be used combinedin tandem:

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

    Wallet Criteria

    Note

    Only available for Financial Notification Run Definitions

     

    Wallet Balance

    It filters the accounts receivable Filters the Accounts Receivable based on the wallet balance Balance of wallets Wallets owned by that account.  Two options are available, which can be used combinedin tandem:

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

    It filters the accounts receivable Filters the Accounts Receivable based on the wallet estimated consumption days of wallets Wallets owned by that account.  Two options are available, which can be used combinedin tandem:

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

    It filters the accounts receivable Filters the Accounts Receivable based on the wallet product Product estimated consumption days of wallets Wallets owned by that account.  Two options are available, which can be used combinedin tandem:

    • More than:checks for a value that is more is more than or equal to equal to the one specified (≥).
    • Less than:  checks checks for a value that is less is less than  to the one specified (<)
    Criteria - Subscription Criteria
    Subscription TypesIt filters the accounts receivable based on the type of subscriptions owned by the accounts receivable. Multiple subscription types can be defined. 
    • .

    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 SchemesIt filters the accounts receivable Filters the Accounts Receivable based on the billing term schemes of subscriptions owned by the accounts receivable. Multiple billing term schemes can be defined.Billing Term Schemes of Subscriptions owned by the Accounts Receivable.

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

    Price Plans

    		It filters the accounts receivable Filters the Accounts Receivable based on the price plans Price Plans of subscriptions Subscriptions owned by the accounts receivable. Multiple price plans can be defined.Accounts Receivable.
    Status
    colourYellow
    titleDeprecated from CRM.COM-R11.0.0 onwards

    Billing Frequencies    		It filters the accounts receivable Filters the Accounts Receivable based on the billing frequencies Billing Frequencies of subscriptions Subscriptions owned by the accounts receivable. Multiple billing frequencies can be defined.
    Binding PeriodsIt filters the accounts receivable based on the binding periods of subscriptions owned by the accounts receivable. Multiple binding periods can be defined.
    Binding StateIt filters the accounts receivable based on the binding state of subscriptions owned by the accounts receivable.
    Notification Runs
    Notification Run informationIt displays all the notification runs which were performed based on the specific notification run definition and displays all the notification run information as described in Configuring and Executing Notification Runs

    Configuring a Notification Run tailored to your company's needs

  • Navigate to CRM > NOTIFICATIONS > PERFORM NOTIFICATION RUNS 
  • Either search for an existing one or from the Top Menu click on "NEW"

  • MAIN INFORMATION

    1. Provide the required information

      1. Name

      2. Alternative Code

      3. Notification Type

      4. Life Cycle State: Is automatically set

      5. Version: Is automatically set to 1 (for new notification runs)

      6. Description

        Notification Runs - Main InformationImage Removed 

    • CRITERIA

  • Provide the required information

    • Accounts Receivable

  • Outstanding Amount

  • Balance
  • Classifications: Click on Add and search and select classifications using the Search Modal
    • Credit Ratings

    Wallet

  • Balance
  • Estimated Consumption Days
    • Product Estimated Consumption Days

    Subscription

  • Subscription Types: Click on Add and search and select subscription types using the Search Modal
  • Billing Term Schemes: Click on Add and search and select billing term schemes using the Search Modal
  • Price Plans: Click on Add and search and select price plans using the Search Modal
  • Billing Frequencies
  • Binding Periods
    • 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) 

    LOG INFORMATION

    Include PageWIP:Log Information - GlobalWIP:Log Information - Global
  • From the top menu click on "Save"

    • Executing a Notification Run

    Include PageExecuting Runs - GlobalExecuting Runs - Global

    Modifying a Notification Run

    Include PageVersioningVersioning

    Deleting a Notification Run

    Deleting a scheduled job of the specific Run

    Include PageDeleting a run- GlobalDeleting a run- Global

    Changing the Life Cycle State of a Notification Run definition

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

    Reading Notification Run Logs

  • Navigate to CRM > NOTIFICATIONS > PERFORM NOTIFICATION RUNS 
  • Search for an existing Notification Run that has been executed

    • Process Runs

    The following information is available regarding the Notification Run
  • Number: The number of the notification run
  • Version: The Notification Run Definition's version
  • Life Cycle State: The Life Cycle State of the Notification Run
  • Start Date: The date when the Run started
  • End Date: The date when the Run ended
  • Process Successfully: Drill down including the notifications created successfully. 

    • Processed With Errors: Drill down including the entities that were not successfully processed thus no notifications were created for the specified entities

    Info

    Visit Creating Notifications to find out more information regarding created Notifications.

    Notification Runs - Creating NotificationsImage Removed

     

    NoteVisit /wiki/spaces/WIP/pages/10010220
    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. Incase of an error, the error code and 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
    excerpttrue
    labelsnotifications-basics-r7,notifications-advanced-r7,notifications-admin-r7

    Popular Labels

    heatmap
    Panel
    namegrey
    Popular Labels
    spaceKeyV4Manual
    style

    Helpful Links

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