Custom Report - Billing Progress

Owned by Mahnoor Khan (Deactivated)
Last updated: Nov 24, 2023 by Micah Gallant
3 min read

Summary

This custom report displays the top 1000 records related to billing module activity from the Event Log report, detailing the billing process history and billing progress.

Configuration

There are basically two steps when creating a custom report:

  1. Create a SQL view in Microsoft SQL Server Management Studio

  2. Call the view from EngageIP Billing to display the custom report

Progress Report Usage:

To use the report effectively, sort by the ID descending. You can then see all the Start and Finish processes that are occuring, this report does not explicitly define when a bill run has finished. To confirm, review the event log to see that no billing records are being added. This report may show a 'Finished Bill run' entry however it may not mean the complete billing process is complete.

You can also estimate the process time for each process, i.e. the delivery process, by checking the date / time difference between the start and finish records.

This report will contain the following columns:

  • EventID

  • Date

  • Action

  • Module

  • Result

Creating The SQL View

  1. Open Microsoft SQL Server Management Studio

  2. Connect to and open the BOSS database

  3. Right Click on the VIEW directory and select the New View... option

  4. Close the Add Table window

  5. Copy the following query in to the view:

    SELECT TOP (1000) DATE, Action, Module, RESULT FROM dbo.EventLog WHERE (RESULT LIKE '%Running%' OR RESULT LIKE '%Starting%' OR RESULT LIKE '%finish%' OR RESULT LIKE '%bill run%') AND (Module = 'Billing') AND RESULT NOT LIKE '%thread%' ORDER BY ID DESC

  6. Click the Execute SQL button [ ! ] or [CTRL]+R, to run the query

  7. Save the View (no special characters or spaces, under scores can be used in place of spaces). Remember the name of the view as you will need to enter this value in EngageIP Billing

EngageIP Configuration

  1. Log in to EngageIP Billing

  2. Click the Setup tab

  3. Select the Custom Reports option under the Configuration section

  4. Click the Add button

  5. Enter a Name (no special characters or spaces, under scores can be used in place of spaces) for the report. The value entered here will become a role permission enabling only accounts within that role to view the custom report. It is recommended that you name all your custom reports with a common prefix so that they will be easy to locate within the role permission list

  6. Enter the following Connection String; replacing User ID and Password (XYZ) with the correct values:

    server=localhost;Trusted_Connection=false;database=boss;uid=XYZ;pwd=XYZEnter the name of the view you created in SQL in the Table field

  7. Enter the name of the view you created in SQL in the Table field

  8. Click Save

  9. Logout and then back in to EngageIP Billing. This will reset the role permission set and allow you to grant access to the report

  10. Click on the Setup tab

  11. Select the Roles option under the Account and Roles section

  12. Select the role from the list to grant view permissions for this report

  13. Scroll down to the Role Permissions section and locate the name of the report within the list

  14. Select the LIST check box next to that permission

  15. Scroll to the bottom of the permission set and click the Save button

  16. Repeat steps 11-15 above until all applicable roles have been granted permission to view the report

  17. Click the Reports tab

  18. Scroll to the bottom of the screen where you will see a new section entitled; Custom Reports

  19. Click on the Name of your Custom Report to view the output

Like all other lists within the application, custom reports can be filtered, printed, and/or exported using the appropriate list icons.