In the future each error in translate5 should have an own error code to improve support / make live for help desk easier.
List of ErrorCodes
General
| EventCode | Context | ErrorMessage | Description / Solution |
|---|---|---|---|
| E0000 | everywhere | Several | Code used for multi purposes: Mostly for debug messages below level warn, where no fixed message is needed. |
Task
| EventCode | Context | ErrorMessage | Description / Solution |
|---|---|---|---|
| E1011 | Task | Multi Purpose Code for Task logging | Multi Purpose code for several info logs around a task. |
Import
| ErrorCode | Context | ErrorMessage | Description / Solution |
|---|---|---|---|
| E1000 | SdlXliff Fileparser | The file "{filename}" contains SDL comments which are currently not supported! | Since "{filename}" can not be imported, omit that file or remove SDL comments for a successful import. |
| E1001 | SdlXliff Fileparser | The opening tag "{tagName}" contains the tagId "{tagId}" which is not SDLXLIFF conform! | That "{tagName}" contains the tagId "{tagId}" is not valid SDLXLIFF according to our reverse engineering of the SDLXLIFF format. Probably the parse has to be extended here. |
| E1002 | SdlXliff Fileparser | Found a closing tag without an opening one. Segment MID: "{mid}". | Invalid XML structure in the mentioned SDLXLIFF file. |
| E1003 | SdlXliff Fileparser | There are change Markers in the sdlxliff-file "{filename}"! | SDLXLIFF change markup is not supported. |
| E1004 | SdlXliff Fileparser | Locked-tag-content was requested but tag does not contain a xid attribute. | Invalid SDLXIFF according to our reverse engineering. |
| E1005 | SdlXliff Fileparser | <sdl:seg-defs was not found in the current transunit: "{transunit}" | Invalid SDLXIFF according to our reverse engineering. |
| E1006 | SdlXliff Fileparser | Loading the tag information from the SDLXLIFF header has failed! | Check if SDLXLIFF header content is valid XML. |
| E1007 | SdlXliff Fileparser | The tag "{tagname}" is not defined in the "_tagDefMapping" list. | Invalid SDLXIFF according to our reverse engineering. The used tags are either not contained in the tag definition list in the header, or the parser did not parse the header completely. |
| E1008 | SdlXliff Fileparser | The tag ID "{tagId}" contains a dash "-" which is not allowed! | Dashes are not allowed, since this may interfere with the GUI where dashes are used as delimiter in the IDs. |
| E1009 | SdlXliff Fileparser | The source and target segment count does not match in transunit: "{transunit}". | Invalid SDLXIFF according to our reverse engineering. |
| E1010 | SdlXliff Fileparser | The tag "{tagname}" was used in the segment but is not defined in the "_tagDefMapping" list! | Invalid SDLXIFF according to our reverse engineering. The used tags are either not contained in the tag definition list in the header, or the parser did not parse the header completely. |
Export
ErrorCode Design rules / decisions
- Prefixed with "E" so that a search for the error code through the code is more reliable than just searching for a number
- No structure in the numbering to prevent discussions is it an error E12XX or E45XX
- Do not start at 1 and don't use leading zeros.
- Each usage of an error in the code should get separate code. Even if the error message / reason is the same. Reason is that the help desk might need to do different things in different cases.
- Information about the error here in the list should not be copied, but errors can point to another errors: "E4321: See E1234". Thats work to maintain, but better as confusing the client by giving wrong hints.
- if it makes sense for the support / help desk to split up an error in different errorcodes because of different reasons, than this should be done in the code so far
Never forget the purpose of error codes: make life easier for support / help desk.