A user guide about the Event Log Dashboard
Required User Rights
To be able to use these operations, you’ll need at least the following user right: 4500 Menu – Event Log.
The Event Log Dashboard
The Logs menu contains dashboards that show the system logs. The Event Log dashboard can be found under the Logs menu: Logs > Event Log.
The Event Log contains information about billing task runs and potential errors in invoice generation.
Note! In on-premises installations, the Event Log has many more, and different types of system events logged. These are not covered in this document
The most common use of the Event Log is to monitor Billing Task runs. You can see the duration of the runs and see possible errors in billing tasks that may prevent the creation of charges.
As billing tasks are typically run daily, and charges are generated on a daily basis, it is recommended for the key users to occasionally check the log to see potential issues during the month to be able to mitigate issues before month’s end or other scheduled invoicing. It is especially recommended to check the Event Log the next day if billing tasks have been changed.
Figure 1: Event Log Dashboard
Tip: By filtering the grid by Notifications, you can easily see if the same issue has happened before, or, for instance, how the execution time of a billing task has changed over time
Tip: We recommend that you create templates for specific subjects you wish to follow
Dashboard columns
- Event ID – ID for the specific entry in the event log
- Event date – The date and time of the event
- Server name – The server where the error has occurred
- Module name – The specific module of the Good Sign software that the event concerns
- Notification – Explains the event in question
- Status ID – Not relevant in the event log
- Category – Not relevant in the event log
Interpretation of the Billing Task Events
The module name “BILLINGPHONENUMBERRULE” is as the Module Name in billing task runs.
Note: Only scheduled daily runs log events into the Event Log. If you manually command billing tasks from the Billing Task editor, those events will not be logged into the Event Log
The typical execution of billing tasks logs billing task specific events for each billing task into the Event Log first. This type of entry is always written first:
“TASK_ID 999999: ExecutionTime 2027ms.”
This means that billing task #999999 has gone through the data it utilizes and processed the required charges to be generated, and it took 2027ms, so ~2 seconds.
Once all the tasks of the daily run have been executed, the following entry to the Event log will be written:
“Daily Tasks Executed (Rule).”
This means that all the billing tasks were executed.
After all tasks have been executed, the process continues to generate the charges that are to be invoiced. Once that process is ready, the following entry appears to the Event Log:
“Daily Tasks Executed (Billingobjects)”
After this entry, the charges are invoiceable. Comparing the Event Date timestamps, you can see how long the total process has taken.
Errors In Billing Tasks
If the billing task run encounters an error, it is logged onto the Event Log. These errors are, typically, that the configuration of the billing task, or one/several of its rules have an error the system can’t resolve. An example of an error notification could be:
“ERROR (RULE): TASK_ID 1400: Invalid column name 'workstationcount'.”
This would mean that billing task 1400 is trying to use a data field that does not exist in the data it is configured to be examined. The user then needs to fix the task.
Warning: If a billing task results in an error, no charges will be generated during that process
Errors when Generating Invoices
The Event Log logs specific situations when creating an invoice, or when adding invoice lines to an invoice has failed.