Skip to end of banner
Go to start of banner

Configuring and Executing Notification Runs

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Next »

What does this section cover?

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
  • On creating a new Notification Run, you can select between, 2 different type of Notification Runs and according to the selected Run then different criteria will be made  available
    • Financial Notification Process Definition
      • Accounts Receivable
      • Wallet
      • Subscription
      • Notification
      • Segment
      • Notification History
    • Customer Care Notification Process Definition
      • Segments
      • Notification History

For more information on criteria check out the Notification Run Attributes table below

  • 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
      • Customer Care Notifications :
        At least one segment MUST be specified (Either in Included or Excluded)
    • Financial Notifications
      At least one criterion MUST be specified (from any of the available criteria)
    • Scheduling Settings
 

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 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
VersionAn 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
Scheduled DateThis is a read only field which is available once you schedule a Run. The date provided shows the latest date that the run is scheduled to be executed.
Notification Type*

The type of notification that will be created whenever the notification run definitions are used to generate notifications.
The list of available Notification Types will be filtered according to the Type of Run selected

  • Customer Care Process Notification Run
  • Financial Process Notification Run
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
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 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" 
    Notification Runs

  • MAIN INFORMATION

    • Provide the required information

      • Name

      • Alternative Code

      • Notification Type

      • Life Cycle State: Is automatically set

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

      • Description

  • 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
      • Binding States

    • Notification

      • Outstanding Amount Per Notification

    • Segment

      • Included in Segments
      • Excluded in Segments

    • Notification History

      • Notified Previously
      • Not Notified Previously

  • SCHEDULING SETTINGS

    1. Select from the available options according to what you would like to achieve
      1. RUN NOW: Will be executed once, now 
      2. RUN ON SPECIFIC DATE/TIME: Will be executed once, at the date defined
      3. RUN REPEATEDLY: Will be executed, starting and ending at a defined date/time and will be repeated every X UOT where UOT can be from seconds to Years
      4. ADVANCED SCHEDULING: Will be executed, starting and ending at a defined date with powerful repetition options from daily to yearly

    2. Run Now

      SCHEDULING SETTINGS - RUN NOW
       

    3. Run On Specific Date / Time

      1. Start Process
        1. Click on the calendar select the date and time the run should start being executed. 
          DATE AND TIME SELECTION
        2. Once selected click on "DONE"
          RUN ON SPECIFIC DATE TIME

    4. Run Repeatedly

      1. Start Process - On a Specific Date
        1. Click on the calendar select the date and time the run should start being executed. 
        2. Once selected click on "DONE"
      2. OR Start process - After a period of time
        1. Provide how long after current date/time the process should begin
          START PROCESS - AFTER A PERIOD OF TIME 
      3. Repeat Process
        1. EVERY: Type a number (INTEGER)
        2. UOT: Select between
          1. Seconds
          2. Minutes
          3. Hours
          4. Days
          5. Weeks
          6. Months
          7. Years
            REPEAT - UOT
      4. End Process
        1. Select between
          1. Never End
          2. On a specific date (define the date)
          3. After a period of time (define period of time)
            END PROCESS 

    5. Advance Scheduling

      1. Start Process
        1. Click on the calendar select the date and time the run should start being executed. 
        2. Once selected click on "DONE"
          ADVANCED SCHEDULING 
      2. Repeat Process
        1. Select between
          1. Daily : Define every how many days 
          2. Weekly: Select specific days of the week 
          3. Monthly:Define every how many months or on a specific day of the month
          4. Yearly: Define a specific date/month or a specific day of a month, such as the 1st Sunday of every January
            ADVANCED SCHEDULING - REPEAT PROCESS
      3. End Process
        1. Select between
          1. Never End
          2. On a specific date (define the date)
            ADVANCED - END PROCESS 

  • THROTTLING SETTINGS

    • Provide the required information
      • Maximum batch size
      • Start again after X UOT (seconds, minutes, days)

  • LOG INFORMATION

    Unable to render {include} The included page could not be found.

  • From the top menu click on "Save"

  • Executing a Notification Run

  1. Navigate to the definition
  2. Search for the definition you would like to execute
  3. Click on the number of the definition to go to the data entry page
  4. Confirm that SCHEDULING SETTINGS are correctly configured
  5. From the Actions Menu click on ACTIONS > "SUBMIT"
    RUNS - SUBMIT
  6. The job will be submitted to the scheduler and will become available under PROCESS RUNS
    1. Once completed the Life Cycle State will be changed from Draft to Completed
    2. If the Run fails then the Life Cycle State will be updated to Failed
      PROCESS RUN
    3. Check Process Successfully and Processed with Errors for a closer look of individual results 

 

  • Modifying a Notification Run

When you edit a definition that already has completed or scheduled runs then the system will automatically update the Version of the definition, by increasing its number by 1. Essentially, the system will create a new definition and will carry over all the information and configuration, apart from the Version number.

Accessing a definition with multiple versions, you will always see the latest version, while you have the option to View configuration and Runs of Previous versions by using th "VIEW PREVIOUS VERSIONS" link found in the Main Information tab

  1.  Click on the VIEW PREVIOUS VERSIONS link
    VERSIONING 
  2. Search from the modal for the version you would like to see
  3. Select the version
    1. The system will now show the configuration and the process runs of the version you have selected.
  4. To go back to the current version click on the CURRENT VERSION link under Main Information
    CURRENT VERSION 

 

  • Deleting a Notification Run

  • Deleting a scheduled job of the specific Run

If you have scheduled (submitted) a Run by mistake or you want to change the definition before execution, you have the option to delete the current job that was sent to the scheduler, given that it has not been executed yet. i.e., Life Cycle State is still Draft.

In order to delete the job follow the steps below:

  1. Navigate to the definition, for which you have scheduled a job
  2. Click on the number of the definition to move in the data entry page
  3. Go to Process Runs tab
  4. Find the job and check the left box next to the Run
  5. Click on "DELETE"


  6. A modal will open with the job information
  7. Click on "DELETE"
  8. Click "OK" on the confirmation message
  9. Close the modal
    The job will be removed from the Process Runs 

  • Changing the Life Cycle State of a Notification Run definition

Definitions Life Cycle State can be changed between Effective and Not Effective by following the steps below 

  1. Go to the data entry page of the definition'
  2. If the definition's Life Cycle State is set to "Effective"
    1. From the Actions Menu click ACTIONS > SET AS NOT EFFECTIVE
  3. If the definition's Life Cycle State is set to "Not Effective"
    1. From the Actions Menu click ACTIONS > SET AS EFFECTIVE
      RUN DEFINITIONS - LIFE CYCLE STATE ACTIONS 

 

  • 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

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


        Notification Runs - Creating Notifications

 

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

Related Areas

Popular Labels

  • No labels