Skip to end of banner
Go to start of banner

Configuring & 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

Version 1 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

ActionValidationsRestrictionsAdditional Information
General   
Create   
Edit   
Delete   

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
  • Less than
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
  • Less than

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

  • Due in X Days
  • Due X days ago
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
  • Less than
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
  • Less than
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
  • Less than
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
  • Less than
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
  
  
  

Configuring a Notification Run tailored to your company's needs

  1. Navigate to PATH
     
  2. Either search for an existing one or from the Top Menu click on NEW

  3. MAIN INFORMATION


    1.  

  4. CRITERIA

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

  6. LOG INFORMATION

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

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

The following information regarding the Process Runs is available:

  1. Number: An auto generated number that uniquely identifies each process run.
  2. Version: The version of the process run's related process run definition.
  3. Life Cycle State: The life cycle state of the process run which can be pending, in progress or completed.
  4. Start Date: The date that the process run started.
  5. End Date: The date that the process run ended.
  6. Process Successfully: Drill down including the entities processed successfully. 

  7. Processed With Errors: Drill down including the entities that were not successfully processed.

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


Related Areas

Filter by label

There are no items with the selected labels at this time.

Popular Labels

  • No labels