Skip to main content

Execute Rating using an Automation

The ‘Execute Rating’ process can be kicked off or scheduled to run at preset intervals using the ZAB Automated Processes module.

ZAB Versions before 2020.08.28.1:
Automated Processes allows you to submit specific records for the Execute Rating process, but must be based on a Saved Search of ZAB Subscription records. This allows you to configure custom filters on the Search for granular record selection.

Review the Automated Processes guide to configure the ZAB Automation and the ZAB Automation Property records.

 

zonebilling_execute_rating_automation.JPG

 

Manually Kick Off Automated Process

At any point the Automated Process can be kicked off manually, whether or not it is scheduled, by clicking the ‘Run Now’ button.

 

zonebilling_execute_rating_automation_run_now.JPG

 

Use Case

ZAB Automated Processes are used if you want to automatically schedule the Executing Rating process to run at preset intervals and/or want to select specific records to submit to the process. Depending on your use case, you may choose a Subscription or Subscription Item search.

Sample use cases and their corresponding configurations include:

  • Subscription-based Search:
    • You want to execute rating for a specific group of Subscriptions on a scheduled basis
    • The criteria to define the group of Subscriptions is more complex than can be defined on the Execute Rating Suitelet (i.e. is not just Customer, Master Contract, etc.)
    • You may want to evaluate Charges for those Subscriptions into the future
    • Charges on some Subscription Items are based on another Subscription Item
    • Prepaid Subscription (Amount) Charges are being evaluated and need to account for other Subscription Item Charges
    • Multiple Subscription Item’s Rating Priority needs to be evaluated during the Rating process
  • Subscription Item-based Search:
    • You want to execute rating for a specific group of Subscription Items on a scheduled basis (i.e. One-Time Charges only)
    • You do not want or need to evaluate the entire Subscription that the Subscription Item belongs to
    • You may want to evaluate Charges for those Subscription Items into the future
    • The Subscription Item’s Charges are not dependent on other Subscription Items and do not leverage Rating Priority

Using a Subscription Search to Execute Rating

Only the Subscriptions included in the Search are submitted to the Rating Process. The ‘Rate Through Date’ is automatically set to the current date - meaning that future charge periods will not be rated.

Note: If you need to rate future Charge Periods, visit Automated Properties for more details.

1. Create a Saved Search based off the ZAB Subscription record type

  • Define any filters that should be applied - i.e. Customer, Master Contract, etc.

2. Navigate to Setup > Zone Advanced Billing Setup > Automated Processes > New

3. Enter a name for the Process

4. Select ‘Execute Rating’ under the Process to run

5. Select the Saved Search

  • If you select a Saved Search that does not use the ZAB Subscription or ZAB Subscription Item, an error message will appear

6. Select ‘Delay Population Search’ if needed

7. Optionally set a schedule for the Process to run automatically

8. Click ‘Save’ once finished

9. Click ‘Run Now’ to submit the Automated Process for processing (or wait for the schedule to run, if applicable)
10. The Saved Search criteria will determine which Subscriptions are included for processing. Only Charges with the Charge Type of Usage are evaluated for those records, with the following caveats:

  • If the Charge Status is NOT ‘Not Started’, ‘Pending Billing’, or ‘Partially Rated’:
    • The Charge is NOT updated/evaluated
  • If the Charge Period Start and End Date are before the current date (i.e. the Charge Period is in the past) AND the Charge Status is ‘Not Started’, ‘Pending Billing’, or ‘Partially Rated’:
    • The Charge Status is updated to ‘Pending Billing’
    • The Rated Through Date is set to the last day of the Charge Period
    • The Rating Process runs, and updates the Charge Quantity, Rate, and Amount properly based on the Rate Plan and/or any Pricing Options that have been defined on the Subscription Item(s)
  • If the Charge Period Start Date is on or before the current date and the Charge Period End Date is after the current date (i.e. today is within a Charge Period):
    • The Charge Status is updated to ‘Partially Rated’
    • The Rated Through Date is set to the current date to indicate the period has only been partially evaluated
    • The Rating Process runs, and updates the Charge Quantity, Rate, and Amount properly based on the Rate Plan and/or any Pricing Options that have been defined on the Subscription Item(s)
  • If the Charge Period Start Date is after the current date (i.e. the Charge Period is in the future):
    The Charge Status remains ‘Not Started’ and is NOT updated/evaluated

 

Using a Subscription Item Search to Execute Rating

Only the Subscription Items included in the Search are submitted to the Rating Process. The ‘Rate Through Date’ is automatically set to the current date - meaning that future Charge Periods will not be rated.

1. Create a Saved Search based off the ZAB Subscription Item

  • Define any filters that should be applied - i.e.Customer, Subscription subset, etc.

2. Navigate to Setup > Zone Advanced Billing Setup > Automated Processes > New

3. Enter a name for the Process

4. Select ‘Execute Rating’ under the Process to run

5. Select the Saved Search

  • If you select a Saved Search that does not use the ZAB Subscription or ZAB Subscription Item, an error message will appear

6. Select ‘Delay Population Search’ if needed

7. Optionally set a schedule for the Process to run automatically

8. Click ‘Save’ once finished

9. Click ‘Run Now’ to submit the Automated Process for processing (or wait for the schedule to run, if applicable)

10. The Saved Search criteria will determine which Subscription Items are included for processing. Only Charges with the Charge Type of Usage are evaluated for those records, with the following caveats:

  • If the Charge Status is NOT ‘Not Started’, ‘Pending Billing’, or ‘Partially Rated’:
    • The Charge is NOT updated/evaluated
  • If the Charge Period Start and End Date are before the current date (i.e. the Charge Period is in the past) AND the Charge Status is ‘Not Started’, ‘Pending Billing’, or ‘Partially Rated’:
    • The Charge Status is updated to ‘Pending Billing’
    • The Rated Through Date is set to the last day of the Charge Period
    • The Rating Process runs, and updates the Charge Quantity, Rate, and Amount properly based on the Rate Plan and/or any Pricing Options that have been defined on the Subscription Item(s)
  • If the Charge Period Start Date is on or before the current date and the Charge Period End Date is after the current date (i.e. today is within a Charge Period):
    • The Charge Status is updated to ‘Partially Rated’
    • The Rated Through Date is set to the current date to indicate the period has only been partially evaluated
    • The Rating Process runs, and updates the Charge Quantity, Rate, and Amount properly based on the Rate Plan and/or any Pricing Options that have been defined on the Subscription Item(s)
  • If the Charge Period Start Date is after the current date (i.e. the Charge Period is in the future):
    • The Charge Status remains ‘Not Started’ and is NOT updated/evaluated

 

FAQs

Q: When using ZAB Automated Processes for Execute Rating, how do I decide which input search type to select?

A: Important questions to consider to determine which input search type to select include:

  • Are any of the Subscription Items you want to rate Prepaid Subscriptions or use Rate Plans that depend on another Subscription Item?
    • If so, select a Subscription-based Search
  • Do Subscription Items use Rating Priority to determine the order they must be evaluated in?
    • If so, select a Subscription-based Search
  • Do you only want to rate one Subscription Item or one type of Subscription Item (i.e. One-Time Charges)?
    • If so, select a Subscription Item-based Search

 

Q: Can I monitor the Rating Process progress to see when it’s complete/if there was an error?

A: To see if any errors occurred, navigate to Setup > Zone Advanced Billing Setup > Server Script Error Logs. Any errors will be listed here.

rating_automation_error_log.JPG

To view a specific Process while in progress:

  • If initiated from the ‘Rate Now’ button:
    • Navigate to Customization > Scripting > Script Execution Status
    • You will see the ‘Rate Now’ button leverages the Script ‘ZAB Helper Suitelet
    • To see more details, navigate to Customization > Scripting > Scripts > ‘ZAB Helper Suitelet’
    • Click the ‘Execution Log’ tab

rating_automation_script_execution_log.JPG

  • If initiated from the Execute Rating Suitelet:
    • Once you select a Subscription(s) and click Execute Selected, you’ll see the number of Subscriptions
    • ‘In Queue for Processing’ update
    • Click this link to see a ZAB Processes Search filtered to that specific process type and Processes actively in queue

rating_process_queue.JPG

    • Click the Process ID to see more details

rating_process_status.JPG

  • Once Completed, click the ‘View Results’ button to view a suitelet which parses the Response File and presents the information in a user friendly way
    • The columns on the Success(es) or Error(s) tabs are dynamic based off the Process Type and the record population that was processed

rating_process_status_complete.JPG

rating_process_status_results.JPG

 

  • If initiated from ZAB Automated Processes:
    • Once the Process Runs (either initiated by a user or on schedule) a Process record will appear in the sublist

rating_automation_process.JPG

    • Click the Process ID to see more details

rating_automation_process_results.JPG

    • Once Completed, click the ‘View Results’ button to view a suitelet which parses the Response File and presents the information in a user friendly way
      • The columns on the Success(es) or Error(s) tabs are dynamic based off the Process Type and the record population that was processed

rating_automation_process_results_page.JPG

Was this article helpful?