Info | ||
---|---|---|
| ||
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. or to get a whole list sorted from lowest to highest: |
In the future each error in translate5 should have an own error code to improve support / make live for help desk easier.
...
EventCode | Context | ErrorMessage | Description / Solution | ||||||
---|---|---|---|---|---|---|---|---|---|
| everywhere | Several | Code used for multi purposes: Mostly for debug messages below level warn, where no fixed message is needed. | ||||||
| everywhere | Several | Default code used for old error messages, which are not converted yet to the new error code system. | ||||||
| everywhere | Log HTTP Request | The HTTP request to the server and its parameters are logged. Generally for debugging only. | ||||||
| entities | Duplicate Key | A database key for the entity to be saved does already exist. | ||||||
| entities | Integrity 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. | ||||||
| everywhere | HTTP Status 404 | The requested URL / page was not found, the API endpoint in the application does not exist. | ||||||
| everywhere | HTTP Status 422 | The 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. | ||||||
| everywhere | HTTP 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. | ||||||
| everywhere | HTTP 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. | ||||||
| everywhere | PHP Fatal Error | PHP Fatal error, see error message for details. | ||||||
| everywhere | PHP Warning | PHP Warning, see error message for details. | ||||||
| everywhere | PHP Info | PHP Info, see error message for details. | ||||||
| everywhere | Entity locked | The accessed entity is locked. | ||||||
| everywhere | Entity in use | The accessed entity is in use. |
Users & Customers
EventCode | Context | ErrorMessage | Description / Solution | ||||||
---|---|---|---|---|---|---|---|---|---|
| Customer | A client cannot be deleted as long as tasks are assigned to this client. | Remove all tasks first from that customer. | ||||||
| User | The user can not be deleted, he is PM in one or more tasks. | Change the PMs in the affected tasks. |
...
EventCode | Context | ErrorMessage | Description / Solution | ||||||
---|---|---|---|---|---|---|---|---|---|
| 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 | ||||||
| Plug-In Okapi | Okapi 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. | ||||||
| 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 | ||||||
| Plug-In Okapi | Okapi 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. | ||||||
| Plug-In Okapi | Okapi 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',