Error Reporting (Desktop App)

From ContactsLaw Documentation
The information in this section does not meet our standards and may be of poor quality. It is still under development.

This section of ContactsLaw provides an overview about Error reporting. In the ContactsLaw,

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.

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.

The below guide will be covering about error reporting in the ContactsLaw:

1. Getting Started

  • Proceed to the Me tab and click on Tasks.
Step 1 - Error Reporting.png
  • Navigate to the ribbon group and proceed to Debug.
Step 2 - Error Reporting.png
  • Click a certain report that you want to check and try to fix.
Step 3 - Error Reporting.png

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.
Step 4 - Error Reporting (Client Error).png
  • An error window will appear on your screen.
Step 5 - Error Reporting (Client Error Window).png
  • 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.
Step 6 - Error Reporting (Notepad).png
  • Path 2: Select an error report. Right click and choose Properties.
Step 7 - Error Reporting.png
  • Check the property details and click Save & Close.
Step 8 - Error Reporting.png
  • Proceed to ribbon group and click on Test API Error.
Step 9 - Error Reporting (API Error).png
  • 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.
Step 10- Error Reporting (API Error window).png
  • 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.