Error Reporting

From ContactsLaw Documentation

The Desktop App includes functionality for reporting errors to CPMS. This relates specifically to fault conditions, which may occur in the infrastructure for ContactsLaw or in the Desktop App itself.

If an error occurs, the user is presented with a dialog box informing them of the problem and inviting them to submit an error report. If they choose to do so, they are required to provide additional details about the problem. Note that reporting errors is always optional.

All error reports include some telemetry information which allows CPMS to diagnose and solve the problem; however, in the case of infrastructure errors, users can also elect to include the information that was sent to the server. This is optional (and may contain personal information), but will further assist in resolving the issue.

Additionally, users can report errors arising from scheduled jobs; there will be a link in the to-do item that is sent when a job fails which allows the error to be submitted to CPMS. Note that this requires the job to be configured to send notifications upon failure.

Telemetry

The following telemetry information is included in error reports sent to CPMS:

  • The user's name and email address
  • The subscription and business (if any) to which the error relates
  • Version information about the Desktop App
  • The network name of the user's PC
  • The user's CPMS ID
  • Information about the state of the Desktop App when the error occurred