Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Info
titleConvienient way to get highest ErrorCode

Just call the following command to get the currently highest value of E1XXX codes here in the doc. E1XXX only, because the E4321 is used as example below.
php -r '$text = file_get_contents("https://confluence.translate5.net/display/TAD/ErrorCodes"); preg_match_all("/(E1[0-9]{3})/", $text, $codes); print_r(max(array_unique($codes[0])));echo "\n";'

or to get a whole list sorted from lowest to highest:
php -r '$text = file_get_contents("https://confluence.translate5.net/display/TAD/ErrorCodes"); preg_match_all("/(E[0-9]{4})/", $text, $codes); $codes = array_unique($codes[0]); sort($codes); print_r($codes);echo "\n";'

In the future each error in translate5 should have an own error code to improve support / make live for help desk easier.

...

EventCodeContextErrorMessageDescription / Solution

Anchor
E0000
E0000
E0000

everywhereSeveralCode used for multi purposes: Mostly for debug messages below level warn, where no fixed message is needed.

Anchor
E9999
E9999
E9999

everywhereSeveralDefault code used for old error messages, which are not converted yet to the new error code system.

Anchor
E1014
E1014
E1014

everywhereLog HTTP RequestThe HTTP request to the server and its parameters are logged. Generally for debugging only.

Anchor
E1015
E1015
E1015

entitiesDuplicate KeyA database key for the entity to be saved does already exist.

Anchor
E1016
E1016
E1016

entitiesIntegrity Constraint Violation

An entity can not be added or updated since a referenced entity does not exist (anymore).

Or an entity can not be updated or deleted since it is referenced by other entities.

Anchor
E1019
E1019
E1019

everywhereHTTP Status 404The requested URL / page was not found, the API endpoint in the application does not exist.

Anchor
E1025
E1025
E1025

everywhereHTTP Status 422The PUT / POST request to that URL could not be processed due invalid given data.
The invalid fields are listed in the result from the server.

Anchor
E1026
E1026
E1026

everywhereHTTP Status 422

The File Upload did not succeed PUT / POST request to that URL could not be processed due invalid given data.

The invalid fields are listed in the result from the server.

Anchor
E1041
E1041
E1041

everywhereHTTP Status 409

The PUT / POST request to that URL could not be processed due the given data would produce an invalid state of the entity on the server.

If possible, the causing fields are listed in the result from the server, or the error message is self explaining.

Anchor
E1027
E1027
E1027

everywherePHP Fatal ErrorPHP Fatal error, see error message for details.

Anchor
E1029
E1029
E1029

everywherePHP WarningPHP Warning, see error message for details.

Anchor
E1030
E1030
E1030

everywherePHP InfoPHP Info, see error message for details.

Anchor
E1061
E1061
E1061

everywhereEntity lockedThe accessed entity is locked.

Anchor
E1062
E1062
E1062

everywhereEntity in useThe accessed entity is in use.


Users & Customers

EventCodeContextErrorMessageDescription / Solution

Anchor
E1047
E1047
E1047

CustomerA client cannot be deleted as long as tasks are assigned to this client.Remove all tasks first from that customer.

Anchor
E1048
E1048
E1048

User

The user can not be deleted, he is PM in one or more tasks.



Change the PMs in the affected tasks.

...

EventCodeContextErrorMessageDescription / Solution

Anchor
E1055
E1055
E1055

Plug-In Okapi

Okapi Plug-In: Bconf not given or not found: {bconfFile}

Either there was no bconf given, or the default bconf could not be found.
Default for import should be: ./application/modules/editor/Plugins/Okapi/data/okapi_default_import.bconf
Default for export should be: ./application/modules/editor/Plugins/Okapi/data/okapi_default_export.bconf

Anchor
E1056
E1056
E1056

Plug-In OkapiOkapi Plug-In: tikal fallback can not be used, workfile does not contain the XLF suffix: {workfile}In seldom scenarios tikal is used for export, if tikal receives an non XLIFF file this error is thrown.

Anchor
E1057
E1057
E1057

Plug-In Okapi

Okapi Plug-In: Data dir not writeable: {okapiDataDir}

Solution: change filesystem rights so that the apache user can write into
./application/modules/editor/Plugins/Okapi/data

Anchor
E1058
E1058
E1058

Plug-In OkapiOkapi Plug-In: Error in converting a file: "{message}" on converting file {file}An error described in message happend on converting the file.
Check the message, since the error could be independent from the given file, for example if some Okapi configuration was wrong, or the Okapi server is not available.
A full log of the happened exception is available in the log.

Anchor
E1059
E1059
E1059

Plug-In OkapiOkapi Plug-In: Configuration error - no Okapi server URL is configured!Set a correct Okapi server URL in the configuration:

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: "E 4321: See E 1234". 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.


        'E1061' => 'Entity locked',
        'E1062' => 'Entity in use',