Desktop:Error Report: Difference between revisions

Latest revision as of 14:20, 19 December 2025

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

@@ Line 1: / Line 1: @@
-{{DISPLAYTITLE:Error Reporting (Desktop App)}}{{Quality}}
+{{DISPLAYTITLE:Error Reporting}}
+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.
-This section of ContactsLaw provides an overview about Error reporting. In the ContactsLaw,
+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.
-it is inevitable that from time to time problems will come up with the software. Either because there are some faults in the software or there are some things that need to be developed in the software.
+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.
-With the help of reporting errors, the CPMS are very interested in knowing about those instances in order for them to develop a mechanism whereby and to take actions to fix the errors.
+Additionally, users can report errors arising from [[Daemon:Job|scheduled jobs]]; there will be a link in the [[Task Item|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.
-The below guide will be covering about error reporting in the ContactsLaw:
+== Telemetry ==
+The following telemetry information is included in error reports sent to CPMS:
-== 1. Getting Started ==
+* The user's name and email address
-* Proceed to the Me tab and click on ''Tasks''.
+* The [[subscription]] and [[business]] (if any) to which the error relates
+* Version information about the Desktop App
-[[File:Step 1 - Error Reporting.png|none|thumb|500x500px]]
+* The network name of the user's PC
+* The user's [[CPMS ID:Account|CPMS ID]]
-* Navigate to the ribbon group and proceed to ''Debug''.
+* Information about the state of the Desktop App when the error occurred__FORCETOC__
-[[File:Step 2 - Error Reporting.png|none|thumb|400x400px]]
-* Click a certain report that you want to check and try to fix.
-[[File:Step 3 - Error Reporting.png|none|thumb|500x500px]]
-== 2. Paths of Error Reporting ==
-To debug and fix the reported errors, there are two paths:
-* '''Path 1''': Proceed to ribbon group and click on ''Test Client Error''.
-[[File:Step 4 - Error Reporting (Client Error).png|none|thumb|500x500px]]
-* An error window will appear on your screen.
-[[File:Step 5 - Error Reporting (Client Error Window).png|none|thumb|500x500px]]
-* '''Note''': There are two points in any report where things can go wrong. ''First'', it may be because of the implementation of the desktop application, so that means that there is a fault in the desktop application, or some unforeseen path in the desktop application before we've even attempted to communicate with the ContactsLaw service. ''Second'', maybe something has gone wrong locally on the client computer.
-* If you click ''Yes'', an ''Error Report Notepad'' will be shown on your screen. This will allow users and clients to describe what kind of error they encountered while using the application.
-* Then, click ''Send''.
-[[File:Step 6 - Error Reporting (Notepad).png|none|thumb|500x500px]]
-* '''Path 2''': Select an error report. Right click and choose ''Properties''.
-[[File:Step 7 - Error Reporting.png|none|thumb|500x500px]]
-* Check the property details and click ''Save & Close''.
-[[File:Step 8 - Error Reporting.png|none|thumb|330x330px]]
-* Proceed to ribbon group and click on ''Test API Error''.
-[[File:Step 9 - Error Reporting (API Error).png|none|thumb|500x500px]]
-* A similar error window will appear on your screen. But this time, often the end user won't be able to distinguish between a problem with the desktop application or a problem with the server. It’s just the nature of the errors that change and the users are presented with the same two options and they can submit an error report.
-[[File:Step 10- Error Reporting (API Error window).png|none|thumb|500x500px]]
-* Similar to ''Path 1'', if you click ''Yes'', an ''Error Report Notepad'' will be shown on your screen. This will allow you to describe what kind of error you encountered while using the application. Then, click ''Send''.
-* '''Note''': There will be times the user will be presented with the option to submit their report, and sometimes they won't. Specifically, in the situations where they won’t, it is feasible that the end user might contact the CPMS for support.
-__FORCETOC__
 [[Category:Desktop]]