Versions Compared

Key

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

Learn how you can configure and execute Notification Runs

What does this section cover?

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 Validations & Restrictions

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

Notification Run attributes 

Name

Description

 Name*The name of the notification run definition
Alternative CodeThe alternative code of the notification run definition
DescriptionA description of the notification run definition
Life Cycle State*The 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 Code*An 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 notification run definition. New notification run definition versions are created each time they are edited, if they are already been used to generate notifications
Notification Type*The type of notification that will be created whenever 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
      • Specific Date / Time
    • Repeat
      • Start at
      • End by Date / Time
      • Every X UOT
    • Advanced Repeat
      • Start at
      • End Date
      • Recurrent Mode Settings
  • Start at: It determines the date and time that the process run definition should be applied. If the run now option is selected then the date / time is read only and set to 30 seconds after saving the record. Two options are available
    • Specific Date / Time
    • After X UOT: measured in seconds, minutes, hours, days, weeks or months
  • End by Date / Time: It determines the latest date and time that the process run definition should be applied. This is available only if the repeat option is selected. Three options are available
    • No End Date
    • Specific Date / Time
    • After X UOT: measured in seconds, minutes, hours, days, weeks or months
  • Every X UOT: It determines how often the process should be generated. The process run definitions can be scheduled to be applied per seconds, minutes, hours, days, weeks or months. This is available only if the repeat option is selected.
  • Recurrent Mode Settings: It determines specific recurrence settings that can be applied per day, week, month or year. This is available only if the advanced repeat option is selected
  • Throttling:  It determines the maximum number of processed records that should be affected per each run and the interval between each iteration. This is available only if the repeat and advanced repeat options are selected. Throttling settings include the following
    • Maximum batch size
    • Start again after X UOT (seconds, minutes,hours, days)
Criteria - Segment Criteria
Included in Segment

A list of segments which are used to filter in the contact information or the accounts receivable that will be notified, and optionally the notification information. The criteria consist of the following:

  • 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"

Criteria - Notification History Criteria
Notified Previously

Defines a list of notifications that should already be generated in the past. It consist of the following values:

  • Notification Type: The type of the notification
  • Life Cycle State: The life cycle state of the notification. The default value is the completed.
  • 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. Its values are the same as in "Notified Previously"

Criteria - Accounts Receivable Criteria
Accounts Receivable Balance

It filters the accounts receivable based on their balance. Two options are available, which can be used combined:

  • 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 to the one specified (<)
Accounts Receivable Outstanding Amount

It filters the accounts receivable based on their outstanding amount and a specific due date. Two options are available, which can be used combined:

  • 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 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 (current date + X). For example, if the current date is the 23rd and you specify X=5, then it checks for accounts due up to the 28th.
  • Due X days ago: Checks for accounts that were due up to the date that equals to (current date - X). For example, if the current date is the 23rd and you specify X=5, then it retrieves accounts that were due up to the 18th.
Accounts Receivable ClassificationIt filters the accounts receivable based on a list of accounts receivable classifications
Accounts Receivable Credit RatingIt filters the accounts receivable based on a list of accounts receivable credit ratings
Criteria - Notification Criteria
Total Outstanding Amount per Notification

It filters the notifications that will be created based on the total outstanding amount of each notification, as calculated based on the related invoices. Two options are available, which can be used combined:

  • 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 to the one specified (<)
Criteria - Wallet Criteria
Wallet Balance

It filters the accounts receivable based on the wallet balance of wallets owned by that account.  Two options are available, which can be used combined:

  • 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 to the one specified (<)
Wallet Estimated Consumption Days

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

  • 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 to the one specified (<)
Wallet Product Estimated Consumption Days

It filters the accounts receivable based on the wallet product estimated consumption days of wallets owned by that account.  Two options are available, which can be used combined:

  • 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 to the one specified (<)
Criteria - Subscription Criteria
Subscription Types

It filters the accounts receivable based on the type of subscriptions owned by the accounts receivable. Multiple subscription types can be defined. 

Billing Term SchemesIt filters the accounts receivable based on the billing term schemes of subscriptions owned by the accounts receivable. Multiple billing term schemes can be defined.
Price PlansIt filters the accounts receivable based on the price plans of subscriptions owned by the accounts receivable. Multiple price plans can be defined.
Billing FrequenciesIt filters the accounts receivable based on the billing frequencies of 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 & Executing Notification Runs

Configuring a Notification Run tailored to your company's needs

  1. Navigate to CRM > Notifications > Perform Notification Runs 
  2. Either search for an existing one or from the Top Menu click on NEW
  3. 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 Information 

  4. CRITERIA

    1. Provide the required information
    2. ACCOUNTS RECEIVABLE

      1. Outstanding Amount

      2. Balance
      3. Classifications: Click on Add and search and select classifications using the Search Modal
      4. Credit Ratings

    3. WALLET

      1. Balance
      2. Estimated Consumption Days
      3. Product Estimated Consumption Days

    4. SUBSCRIPTION

      1. Subscription Types: Click on Add and search and select subscription types using the Search Modal
      2. Billing Term Schemes: Click on Add and search and select billing term schemes using the Search Modal
      3. Price Plans: Click on Add and search and select price plans using the Search Modal
      4. Billing Frequencies
      5. Binding Periods
      6. Binding States

    5. NOTIFICATION

      1. Outstanding Amount Per Notification

    6. SEGMENT

      1. Included in Segments
      2. Excluded in Segments

    7. NOTIFICATION HISTORY

      1. Notified Previously
      2. Not Notified Previously

  5. SCHEDULING SETTINGS

    Include Page
    Scheduler Task - Global
    Scheduler Task - Global
     

  6. THROTTLING SETTINGS

    It determines the maximum number of notifications that should be generated per each run and the interval between each iteration. This is available only if the repeat and advanced repeat options are selected.
    1. Provide the required information
      1. Maximum Batch Sizebatch size
      2. Start Again AfterUOTagain after X UOT (seconds, minutes, days)

  7. LOG INFORMATION

    Include Page
    WIP:Log Information - Global
    WIP:Log Information - Global

  8. From the Top Menu click on Save

Executing a Notification Run

Include Page
Executing Runs - Global
Executing Runs - Global

Modifying a Notification Run

Include Page
Versioning
Versioning

Deleting a Notification Run

Deleting a scheduled job of the specific Run

Include Page
Deleting a run- Global
Deleting a run- Global

Changing the Life Cycle State of a Notification Run definition

Include Page
Change Life Cycle State of a Run definition - Global
Change Life Cycle State of a Run definition - Global

Reading Notification Run Logs

  1. Navigate to CRM > Notifications > Perform Notification Runs 
  2. Search for an existing Notification Run that has been executed
  3. PROCESS RUNS

    1. The following information is available regarding the Notification Run
      1. Number: The number of the notification run
      2. Version: The Notification Run Definition's version
      3. Life Cycle State: The Life Cycle State of the Notification Run
      4. Start Date: The date when the Run started
      5. End Date: The date when the Run ended
      6. Process Successfully: Drill down including the notifications created successfully. 
      7. 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 Notifications

 

Note

Visit /wiki/spaces/WIP/pages/10010220 Notification Run for business examples related to Notification Run

Panel
namegrey

Related Areas

Filter by label (Content by label)
showLabelsfalse
spacesV4Manual
showSpacefalse
excerpttrue
labelsmodulename-basics-r7,$modulename-advanced-r7,modulename-admin-r7

Panel
namegrey

Popular Labels

Popular Labels
spaceKeyV4Manual
styleheatmap