Error messages handling
- Licinio Kustra Mano
- Konstantin Hyppönen
- Ivo Pinheiro
Owned by Licinio Kustra Mano
Error messages handling
The purpose of this page is to discuss the error handling in the OpenNCP, but mostly the presentation of those errors in the portal.
It's necessary to do it in such a way that a common user can easily understand them.
Related Issues
- INT-25 - Getting issue details... STATUS
- INT-26 - Getting issue details... STATUS
- INT-27 - Getting issue details... STATUS
- INT-28 - Getting issue details... STATUS
- INT-29 - Getting issue details... STATUS
- PT-183 - Getting issue details... STATUS
Requirements
- User friendly text messages, in Portal (NCP-B), presenting errors emerged from NCP-A.
Use case/scenarios
- All the exceptions from the NCP-A (all services, PS, eP/eD, etc.)
- All the exceptions from the NCP-B (all services, PS, eP/eD, etc.)
- Exceptions provided by NCP components
Technical solution
The technical solution may pass to the implementation of a mapping table that will map the error messages from technical to a more user friendly type at the portal;
Service Messages
The service messages gather a well-defined group of error messages with corresponding codes and descriptions. This errors are related to service aspects and can all be mapped to the destination country language.
XCPD Service
| Code | Message | Response Status | Support In NCP-A |
|---|---|---|---|
| DemographicsQueryNotAllowed | Demographics Query Not Allowed | Failure | Yes |
| AnswerNotAvailable | Answer Not Available | Success | Yes |
| InsufficientRights | Insufficient Rights | Failure | Yes |
XCA Service - RegistryErrorList
| Code | Message | Response Status | Support In NCP-A |
|---|---|---|---|
| 4701 | No Consent | Failure | Yes |
| 4702 | Weak Authentication | Failure | No |
| 4703 | Insufficient Rights | Failure | Yes |
| 1102 | No Data | Success | Yes |
| 4201 | Unsupported Feature | Success | No |
| 4202 | Unknown Signifier | Failure | Yes |
| 4203 | Transcoding Error | Failure | No |
| 4204 | Unknown Filter | Failure | No |
|
XDR Service - RegistryErrorList
Both dispensation and consent service propagate errors (codes and messages) reported by the national connector gateway.
Consent Service
| Code | Message | Response Status | Support In NCP-A |
|---|---|---|---|
| 4705 | Policy violation | Failure | Yes, if supported by national connector |
| 4702 | Weak Authentication | Failure | No |
| 4706 | Unknown Policy | Failure | Yes, if supported by national connector |
| 4701 | No consent | Failure | N/A? |
Dispensation Service
| Code | Message | Response Status | Support In NCP-A |
|---|---|---|---|
| 4105 | No match | Failure | Yes, if supported by national connector |
| 4106 | Invalid Dispensation | Failure | Yes, if supported by national connector |
| 4702 | Weak Authentication | Failure | No |
| 4704 | No signature | Failure | No |
| 4107 | Original data missing | Failure | Yes, if supported by national connector |
| 4108 | Pivot data missing | Failure | Yes, if supported by national connector |
| 4701 | No consent | Failure | Yes |
Component Failures
The component failures may occur for a variety of reasons, throwing more technical errors, such as "Null Pointers", "Index Out Of Bounds", and others.
We believe that these kind of errors should be all included into a single type - for instance "An unexpected error has occurred".
Along with this error, it should be given the possibility to the user to view more details (e.g. Stacktrace) allowing him to send this information to Help Desk systems.
Transformation / Translation Errors