Difference between revisions of "DE4A Logs and error messages"

From DE4A
Jump to navigation Jump to search
(Created page with "== Overview == In order to standarize the errors handled by each component, some conventions have been taken, as log patterns, error codes definition or messages content. The...")
 
Line 1: Line 1:
 
== Overview ==
 
== Overview ==
In order to standarize the errors handled by each component, some conventions have been taken, as log patterns, error codes definition or messages content.
+
In order to standarize the errors and logs handled by each component, some conventions have been taken, as log patterns, error codes definition or messages content.
  
The information on this page should be used by each partner who develop a DE4A component, also it should be maintained to have a proper errors reference and be aware which information will include.
+
The information on this page should be used by each partner who develop a DE4A component, also it should be maintained to have a proper messages reference and be aware which information will include.
 +
 
 +
== Structure definition ==
 +
This section will describe the hierarchy and model followed to build the different logs and messages. There are multples pattern depending on the message nature, but the following tables will be a common reference to understand the rest of information collected in the page.
 +
 
 +
=== Layer ===
 +
The layer concept will be used to name the system level where the message comes from.
 +
{| class="wikitable"
 +
|+
 +
!Layer
 +
!Layer Code
 +
!Description
 +
|-
 +
|Communication
 +
|1
 +
|External  connections/communications performed by the Connector
 +
|-
 +
|Internal failure
 +
|2
 +
|Internal  failure of the Connector to be handled and stored in ErrorTypes wrapped in  DE4A responses
 +
|-
 +
|Configuration
 +
|3
 +
|Unexpected  situation due to a missing configuration paramater
 +
|-
 +
|Business
 +
|4
 +
|Unsuccessful  situation on the business flow
 +
|}
 +
 
 +
=== Module ===

Revision as of 16:11, 20 October 2021

Overview

In order to standarize the errors and logs handled by each component, some conventions have been taken, as log patterns, error codes definition or messages content.

The information on this page should be used by each partner who develop a DE4A component, also it should be maintained to have a proper messages reference and be aware which information will include.

Structure definition

This section will describe the hierarchy and model followed to build the different logs and messages. There are multples pattern depending on the message nature, but the following tables will be a common reference to understand the rest of information collected in the page.

Layer

The layer concept will be used to name the system level where the message comes from.

Layer Layer Code Description
Communication 1 External connections/communications performed by the Connector
Internal failure 2 Internal failure of the Connector to be handled and stored in ErrorTypes wrapped in DE4A responses
Configuration 3 Unexpected situation due to a missing configuration paramater
Business 4 Unsuccessful situation on the business flow

Module