Error Codes in Openpetra: Difference between revisions

From OpenPetra Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
In petra every error message has got a code which helps to identify a message. In openpetra this is a little bit more important because here the message may be translated and unclear. The object TVerificationResultCollection for example provides a file named AResultCode and this may be one good position to place it.  
==Objective of Error Codes==
In Petra 2.x, every error message has got an error code which helps to identify a message. In openPETRA this is even more important, because in openPETRA the message text and message title may be translated into any language and its meaning will be unclear to support staff who don't speak the language the message is shown in. The only way they can identify the error message in such a case is by looking up the error code.


The task of this side is either to provide a ticket system which guarantees that a code is unique and it provides the start page for enhanced service information. As it was done in petra, in openpetra we will handle a code containing two parts, the name of the module and a running number. Each code number which is used by open petra has to be listed here including a short description. Later - if necessary - a link to a more detailed page can be added.  
==Error Code Handling in openPETRA==
The object TVerificationResult provides the Property 'ResultCode'. The error code of a particular error needs to be assigned to this property.


The error number contains of a module name like MODULE and a running number like MODULE.01 or else.  
When an error message is displayed, e.g. in a MessageBox, the 'ResultCode' is to be displayed in a separate line at the end of the message.


== Error Codes Example ==
==Central Inventory of Error Codes==
 
See [[Central Inventory of openPETRA Error Codes]]
* EXCAMPLE
** EXCAMPLE.01: Message ...
** EXCAMPLE.02: [[The message example.02]]
 
Please join the code and the number correctly at the first part of the line. This helps a user to find the information by using the search function. And the message itself can contain a link o an other page. please do not use more than a line for the description.
 
== Error Codes ==

Revision as of 09:33, 16 March 2011

Objective of Error Codes

In Petra 2.x, every error message has got an error code which helps to identify a message. In openPETRA this is even more important, because in openPETRA the message text and message title may be translated into any language and its meaning will be unclear to support staff who don't speak the language the message is shown in. The only way they can identify the error message in such a case is by looking up the error code.

Error Code Handling in openPETRA

The object TVerificationResult provides the Property 'ResultCode'. The error code of a particular error needs to be assigned to this property.

When an error message is displayed, e.g. in a MessageBox, the 'ResultCode' is to be displayed in a separate line at the end of the message.

Central Inventory of Error Codes

See Central Inventory of openPETRA Error Codes

Retrieved from ‘https://wiki.openpetra.org/index.php?title=Error_Codes_in_Openpetra&oldid=1878’