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 and Deleting Validations and Restrictions
Action | Validations | Additional Information |
---|---|---|
General |
| N/A |
Create | N/A |
|
Edit | N/A |
|
Delete |
| N/A |
Save |
|
Notification Run attributes
Name | Description |
---|---|
Name* | The name of the notification run definition |
Alternative Code | The alternative code of the notification run definition |
Description | A 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:
|
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:
|
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:
|
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:
|
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:
The due date can be specified in one of the following ways:
|
Accounts Receivable Classification | It filters the accounts receivable based on a list of accounts receivable classifications |
Accounts Receivable Credit Rating | It 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:
|
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:
|
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:
|
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:
|
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 Schemes | It 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 Plans | It filters the accounts receivable based on the price plans of subscriptions owned by the accounts receivable. Multiple price plans can be defined. |
Billing Frequencies | It filters the accounts receivable based on the billing frequencies of subscriptions owned by the accounts receivable. Multiple billing frequencies can be defined. |
Binding Periods | It filters the accounts receivable based on the binding periods of subscriptions owned by the accounts receivable. Multiple binding periods can be defined. |
Binding State | It filters the accounts receivable based on the binding state of subscriptions owned by the accounts receivable. |
Notification Runs | |
Notification Run information | It 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
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
- Outstanding Amount Per Notification
Segment
- Included in Segments
- Excluded in Segments
Notification History
- Notified Previously
- Not Notified Previously
Scheduling Settings
- Select from the available options according to what you would like to achieve
- RUN NOW: Will be executed once, now
- RUN ON SPECIFIC DATE/TIME: Will be executed once, at the date defined
- 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
- ADVANCED SCHEDULING: Will be executed, starting and ending at a defined date with powerful repetition options from daily to yearly
Run Now
Run On Specific Date / Time
- Start Process
- Click on the calendar select the date and time the run should start being executed.
- Once selected click on "DONE"
- Click on the calendar select the date and time the run should start being executed.
- Start Process
Run Repeatedly
- Start Process - On a Specific Date
- Click on the calendar select the date and time the run should start being executed.
- Once selected click on "DONE"
- OR Start process - After a period of time
- Provide how long after current date/time the process should begin
- Provide how long after current date/time the process should begin
- Repeat Process
- EVERY: Type a number (INTEGER)
- UOT: Select between
- Seconds
- Minutes
- Hours
- Days
- Weeks
- Months
- Years
- End Process
- Select between
- Never End
- On a specific date (define the date)
- After a period of time (define period of time)
- Select between
- Start Process - On a Specific Date
Advance Scheduling
- Start Process
- Click on the calendar select the date and time the run should start being executed.
- Once selected click on "DONE"
- Repeat Process
- Select between
- Daily : Define every how many days
- Weekly: Select specific days of the week
- Monthly:Define every how many months or on a specific day of the month
- Yearly: Define a specific date/month or a specific day of a month, such as the 1st Sunday of every January
- Select between
- End Process
- Select between
- Never End
- On a specific date (define the date)
- Select between
- Start Process
- Select from the available options according to what you would like to achieve
Throttling Settings
- Provide the required information
- Maximum batch size
- Start again after X UOT (seconds, minutes, days)
- Provide the required information
Log Information
Unable to render {include} The included page could not be found.- From the top menu click on "Save"
Executing a Notification Run
- Navigate to the definition
- Search for the definition you would like to execute
- Click on the number of the definition to go to the data entry page
- Confirm that SCHEDULING SETTINGS are correctly configured
- From the Actions Menu click on ACTIONS > "SUBMIT"
- The job will be submitted to the scheduler and will become available under PROCESS RUNS
- Once completed the Life Cycle State will be changed from Draft to Completed
- If the Run fails then the Life Cycle State will be updated to Failed
- 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
- Click on the VIEW PREVIOUS VERSIONS link
- Search from the modal for the version you would like to see
- Select the version
- The system will now show the configuration and the process runs of the version you have selected.
- To go back to the current version click on the CURRENT VERSION link under Main Information
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:
- Navigate to the definition, for which you have scheduled a job
- Click on the number of the definition to move in the data entry page
- Go to Process Runs tab
- Find the job and check the left box next to the Run
- Click on "DELETE"
- A modal will open with the job information
- Click on "DELETE"
- Click "OK" on the confirmation message
- 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
- Go to the data entry page of the definition'
- If the definition's Life Cycle State is set to "Effective"
- From the Actions Menu click ACTIONS > SET AS NOT EFFECTIVE
- If the definition's Life Cycle State is set to "Not Effective"
- From the Actions Menu click ACTIONS > SET AS EFFECTIVE
- From the Actions Menu click ACTIONS > SET AS EFFECTIVE
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.
- The following information is available regarding the Notification Run
Visit /wiki/spaces/WIP/pages/10010220 Notifications for business examples related to Notification Runs
Related Areas
Filter by label
There are no items with the selected labels at this time.
Popular Labels
- accounts-receivable
- accounts-receivable-admin
- accounts-receivable-advanced
- accounts-receivable-advanced-r7
- accounts-receivable-basics
- activities
- activities-admin
- activities-admin-r7
- activities-basics
- activities-basics-r7
- additive-discounts-admin
- additive-discounts-advanced
- additive-discounts-basics
- billing-application
- billing-engine
- communication-centre
- communications-admin-r7
- communications-advanced-r7
- conax-web-services
- conax-web-services-advanced
- contact-information-admin
- contact-information-admin-r7
- crm-application
- crm-application-r7
- customer-events-basics-r7
- dashboards
- dashboards-advanced
- finance-application
- financial-transactions-admin
- financial-transactions-admin-r7
- financial-transactions-advanced
- financial-transactions-advanced-r7
- foundation-application
- foundation-application-r7
- global
- inventory-management-advanced
- inventory-management-basics
- inventory-management-basics-r7
- jobs
- jobs-admin
- jobs-admin-r7
- jobs-advanced
- jobs-basics
- jobs-basics-r7
- leads
- leads-admin
- leads-admin-r7
- leads-advanced
- network-management-basics
- network-management-basics-r7
- normal-billing-admin-r7
- normal-billing-r7
- normal-billing-run-admin
- normal-billing-run-basics
- notifications
- notifications-basics
- panaccess_advanced
- platform-basics
- prepaid-billing-basics
- prepaid-billing-r7
- products-admin-r7
- rated-billing-items-advanced
- rated-billing-items-basics
- reports-basics
- resource-scheduling
- resource-scheduling-advanced
- rewards-admin
- rewards-admin-r7
- rewards-advanced
- rewards-advanced-r7
- rewards-basics
- rewards-basics-r7
- security-management-advanced
- segmentation-basics
- service-requests
- service-requests-admin
- service-requests-admin-r7
- service-requests-advanced
- service-requests-advanced-r7
- stripe
- subscription-actions-r7
- subscriptions
- subscriptions-advanced
- subscriptions-advanced-r7
- subscriptions-basics
- subscriptions-basics-r7
- udrs-admin-r7
- usage-service-r7
- user-management
- user-management-basics
- vouchers-advanced
- vouchers-basics
- wallets
- wallets-advanced
- wallets-basics
- warranty-policies-advanced-r7
- workflows-admin-r7
- workflows-advanced-r7
- workflows-r7
- zapier-basics-r7