...
In the future each error or event in translate5 should have an own event code to improve support / make live for help desk easier.
List of Error- and EventCodes
General
| EventCode | Context | EventMessage | 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. | ||||||
| Worker | Can not trigger worker URL: {host}:{port} Error: {errorName} ({errorNumber}) | The triggered worker URL is technically not available. Local firewall problems? Is the configured "runtimeOptions.server.name" available and callable from the translate5 instance? If not, it can help to configure "runtimeOptions.worker.server" with the local host name or the localhost IP, basicly the server adress which points to the local server and is available for the translate5 instance. | ||||||
| Worker | Worker URL result is no HTTP answer!: {host}:{port} | This can only happen if the worker URL is not pointing to an translate5 instance, or if there is an error on the translate5 instance. In the latter case investigate the log for further errors. | ||||||
| Worker | Worker HTTP response state was not 2XX but {state}. | This should happen only if there is an error on the translate5 instance. In the latter case investigate the log for further errors. | ||||||
| Worker | Worker HTTP response state was 404, the worker system requests probably the wrong server! | Check the server URL configuration values. Either runtimeOptions.worker.server or runtimeOptions.server.protocol and runtimeOptions.server.name are pointing to a wrong server / translate5 installation! |
Users & Customers
| EventCode | Context | EventMessage | Description / Solution | ||||||
|---|---|---|---|---|---|---|---|---|---|
| Customer | A client cannot be deleted as long as tasks are assigned to this client. | Remove all tasks first from that customer. | ||||||
| Customer | The given client-number is already in use. | There exists already a customer with that client-number. | ||||||
| User | The user can not be deleted, he is PM in one or more tasks. | Change the PMs in the affected tasks. | ||||||
| User | User can not be saved: the chosen login does already exist. | Use a different login. | ||||||
| User | User can not be saved: the chosen userGuid does already exist. | Use a different userGuid, if no userGuid was provided explicitly, just save again to generate a new one. | ||||||
| Customer | The given domain is already in use. | The given domain is already defined for one of the customers. |
Task & Workflow
| EventCode | Context | EventMessage | Description / Solution | ||||||
|---|---|---|---|---|---|---|---|---|---|
| Task; Workflow | Multi Purpose Code logging in the context of a task | Multi Purpose code for several info logs around a task. Also important in Context of workflow. | ||||||
| Job; Workflow | Multi Purpose Code logging in the context of jobs (task user association) | Multi Purpose Code logging in the context of jobs (task user association) | ||||||
| Workflow only | Multi Purpose Code logging in the context of pure workflow processing | Multi Purpose Code logging in the context of workflow processing | ||||||
| Task | The task can not be removed due it is used by a user. | One user has opened the task for reading or editing the task. Therefore this task can not be deleted. | ||||||
| Task | The task can not be removed due it is locked by a user. | One user has opened the task for editing the task, or some other action has locked the task. Therefore this task can not be deleted. | ||||||
| Task | The task can not be locked for deletion. | The task must be locked by the deleting user, before it can be deleted. This lock could not be set. | ||||||
| Task; ManualStatusCheck Plug-In | The Task can not be set to finished, since not all segments have a set status. | Each segment must have set a status in order to finish the task. | ||||||
| Task | The current task status does not allow that action. | This error occurs if the current status of the task does not allow the triggering action. | ||||||
| Task; ArchiveTaskBeforeDelete Plug-In | Task could not be locked for archiving, stopping therefore the delete call. | The task must be locked by the deleting user, before it can be deleted. This lock could not be set. | ||||||
| Task | The referenced customer does not exist (anymore). | The user tried to add a non existence client to a task. Probably the customer was deleted in the mean time. |
Jobs (Association between Tasks and Users)
| EventCode | Context | EventMessage | Description / Solution | ||||||
|---|---|---|---|---|---|---|---|---|---|
| Job | The job can not be removed, since the user is using the task. | The user of the job has opened the associated task for reading or editing. Therefore this job can not be deleted. | ||||||
| Job | The job can not be removed, since the task is locked by the user. | The user of the job has opened the associated task for editing. Therefore this job can not be deleted. |
Import
| EventCode | Context | EventMessage | Description / Solution | ||||||
|---|---|---|---|---|---|---|---|---|---|
| Fileparser | The encoding of the file "{fileName}" is none of the encodings utf-8, iso-8859-1 and win-1252. | The named file is not encoded in one of the three supported types. | ||||||
| Fileparser | Given MID was to long (max 1000 chars), MID: "{mid}". | One of the MIDs in the uploaded file is too long. Maximal 1000 bytes are allowed. | ||||||
| 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. | ||||||
| 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. | ||||||
| SdlXliff Fileparser | Found a closing tag without an opening one. Segment MID: "{mid}". | Invalid XML structure in the mentioned SDLXLIFF file. | ||||||
| SdlXliff Fileparser | There are change Markers in the sdlxliff-file "{filename}"! | SDLXLIFF change markup is not supported. | ||||||
| SdlXliff Fileparser | Locked-tag-content was requested but tag does not contain a xid attribute. | Invalid SDLXIFF according to our reverse engineering. | ||||||
| SdlXliff Fileparser | <sdl:seg-defs was not found in the current transunit: "{transunit}" | Invalid SDLXIFF according to our reverse engineering. | ||||||
| SdlXliff Fileparser | Loading the tag information from the SDLXLIFF header has failed! | Check if SDLXLIFF header content is valid XML. | ||||||
| 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. | ||||||
| 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. | ||||||
| SdlXliff Fileparser | The source and target segment count does not match in transunit: "{transunit}". | Invalid SDLXIFF according to our reverse engineering. | ||||||
| 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. | ||||||
| CSV Fileparser | The regex {regex} matches the placeholderCSV string {placeholder} that is used in the editor_Models_Import_FileParser_Csv class to manage the protection loop. | It is not allowed to use a regular expression to protect CSV content which matches the internally used placeholder. Please find another solution to protect what you need to protect in your CSV via Regular Expression. | ||||||
| CSV Fileparser | The string $this->placeholderCSV ({placeholder}) had been present in the segment before parsing it. This is not allowed. | The mentioned placeholder string is used for internally replacement, therefore it may not occur in the real CSV content. | ||||||
| CSV Fileparser | Error on parsing a line of CSV. Current line is: "{line}". Error could also be in previous line! | The mentioned line could not be parsed as CSV line. Check the CSV content. | ||||||
| CSV Fileparser | In the line "{line}" there is no third column. | Each line must contain at least 3 columns: mid, source and target column. Check the CSV content. | ||||||
| CSV Fileparser | No linebreak found in CSV: {file} | No valid line break(s) were found in the CSV, does it contain only one line? | ||||||
| CSV Fileparser | No header column found in CSV: "{file}" | No header columns could be found, check the CSV content. | ||||||
| CSV Fileparser | In application.ini configured column-header(s) "{headers}" not found in CSV: "{file}" | The header column names of the CSV do not match to the configured header column names in "runtimeOptions.import.csv.fields". The missing fields according to the configuration are shown in the error message. | ||||||
| CSV Fileparser | Source and mid given but no more data columns found in CSV: "{file}" | Each line must contain at least 3 columns: mid, source and target column. Check the CSV content. | ||||||
| XLF 1.2 Fileparser | MRK/SUB tag of source not found in target with Mid: "{mid}" | In the XLF a MRK or SUB tag was referenced in the source, but the referenced segment with the given mid was not found. | ||||||
| XLF 1.2 Fileparser | MRK/SUB tag of target not found in source with Mid(s): "{mids}" | In the XLF a MRK or SUB tag was referenced in the target, but the referenced segment with the given mid was not found. | ||||||
| XLF 1.2 Fileparser | There is other content as whitespace outside of the mrk tags. Found content: {content} | Translate5 interprets the XLIFF 1.2 specification in a way that in a segmented segment there may not be any other content as whitespace outside between the <mrk type="seg"> tags. If this is the case translate5 can not import the XLF file. | ||||||
| XLF 1.2 Fileparser | SUB tag of {field} is not unique due missing ID in the parent node and is ignored as separate segment therefore. | The XML node surrounding a <sub> tag must contain an id in order to identfy that sub tag. | ||||||
| XLF 1.2 Fileparser | MRK tag of {field} has no MID attribute. | The given MRK tag does not contain a MID attribute. | ||||||
| Relais Import | Errors in processing relais files: The following MIDs are present in the relais file "{fileName}" but could not be found in the source file, the relais segment(s) was/were ignored. MIDs: {midList} | For the listed MIDs the source segment was not found to the MID in the relais file, the Relais segment was ignored on import. The affected file is also logged. | ||||||
| Relais Import | Errors in processing relais files: Source-content of relais file "{fileName}" is not identical with source of translated file. Relais target is left empty. Segments: {segments} | For the listed segments the source content in the source file and in the relais file was different, therefore no relais target content was saved to the segment. | ||||||
| Relais Import | Errors in adding relais segment: Source-content of relais file "{fileName}" is identical with source of translated file, but still original segment not found in the database: {segments} | This issue is similar to ErrorCodes EventCodes, first a matching source segment was found to the relais segment, the source content equals, but the relais target data could not be saved. Investigate additional debug content! | ||||||
| Relais Import | Task was configured with relais language, but some relais file were not found. See Details. | Some of the work files do not have a corresponding file in the relais folder. In the details of the error the work files without a relais file are listed. Compare them with the files in the imported task. | ||||||
| TBX Parser | Unable to read the provided tbx file {filename} | The provided file for parsing can is not readable. | ||||||
| XML Parser | Invalid XML: expected closing "{closingTag}" tag, but got tag "{receivedTag}". Opening tag was: {openingTag} | Invalid xml chunk found while parsing xml file. | ||||||
| TBX Parser | {message}. \n Term collection name: {name} | Log the exception/info produced while the tbx parser is running. | ||||||
| Task Import - File Upload | A file "{filename}" with an unknown file extension "{ext}" was tried to be imported. | The uploaded file type is currently not supported. | ||||||
| Task Import | The passed source language "{language}" is not valid. | The source language given for the new task is invalid or not found in the languages table of the application. | ||||||
| Task Import | The passed target language "{language}" is not valid. | The target language given for the new task is invalid or not found in the languages table of the application. | ||||||
| Task Import | The import did not contain files for the relais language "{language}". | No importable data was found in the import package for the chosen relais language. | ||||||
| Task Import | The given taskGuid "{taskGuid}" was not valid GUID. | Please provide a valid GUID. | ||||||
| Task Import | The given userGuid "{userGuid}" was not valid GUID. | Please provide a valid GUID. | ||||||
| Task Import | The given userName "{userName}" was not valid user name. | Please provide a valid username. | ||||||
| Task Import | The import root folder does not exist. Path "{folder}". | The provided ZIP package is unzipped on the server for further processing. That unzipped folder can not be found. This is probably a problem of permissions on the server. | ||||||
| Task Import | The imported package did not contain a valid "{proofRead}" folder. | The uploaded ZIP package did not contain a "proofRead" folder, which contains the data to be imported. See ZIP import package format. | ||||||
| Task Import | The imported package did not contain any files in the "{proofRead}" folder. | The "proofRead" Folder in the imported ZIP package was empty, so there is nothing to be imported. | ||||||
| Task Import | TODO Some of the tasks metaData can not be imported. See previous exception. | Some of the tasks metaData can not be imported. See previous exception. | ||||||
| Task Import; Pixel-Mapping MetaData | Pixel-Mapping: Import failed due not found customer specified by customer number in excel - client nr: {lastClientNr} | |||||||
| Task Import; Pixel-Mapping MetaData | Pixel-Mapping: missing default-values for pixel-width for font-size {fontSize}. Add the missing values to the config. | Add the missing value in your defaultPixelWidths-settings in the task template config. | ||||||
| Task Import; Pixel-Mapping MetaData | Pixel-Mapping: ignored one ore more lines of the excel due one or more empty columns. | Check the imported pixel-mapping.xlsx some of the needed columns were empty, see also error details for the collected lines with empty columns. | ||||||
| Task Import | For the fileextension "{extension}" no parser is registered. For available parsers see log details. | The user tried to import a file which can not be imported by the native import converters. See the log details for the available native importable file formats. Otherwise consider to enable Okapi to convert the uploaded file into a native importable XLF format. |
Export
| EventCode | Context | EventMessage | Description / Solution | ||||||
|---|---|---|---|---|---|---|---|---|---|
| Task Export | this->_classNameDifftagger must be defined in the child class. | This is a developer issue, contact the developers. | ||||||
| Tsk Export | Error in Export-Fileparsing. instead of a id="INT" and a optional field="STRING" attribute the following content was extracted: "{content}" | The parsing of the internal <lekTargetSeg/> placeholders in the skeleton data failed. | ||||||
| Task Export | See E1086 | |||||||
| Task Export | Error in diff tagging of export. For details see the previous exception. | The export with enabled automatic diff of the content fails. The original message of the export should be attached. | ||||||
| Task Export with Diff | Tag syntax error in the segment content. No diff export is possible. The segment had been: "{segment}" | In this segment for one closing tag no corresponding opening tag exists - or the tagorder had been syntactically incorrect already before the import in the editor. Therefore it is not possible to create an export with sdl-change-marks in it. Try to export without change-marks. | ||||||
| Task Export with Diff | The number of opening and closing g-Tags had not been the same! The Segment had been: "{segment}" | Similar to E1089. | ||||||
| Task Export with Diff | See E1089 | |||||||
| Task Export with Diff | See E1090 | |||||||
| Task Export with Diff | See E1090 |
Language Resources
| EventCode | Context | EventMessage | Description / Solution | ||||||
|---|---|---|---|---|---|---|---|---|---|
| Language Resources; Task | Referenced language resource not found. | This error can happen on the association of language resources to tasks, if the a chosen language resource was deleted in the meantime. | ||||||
| Language Resources; Task | Cannot remove language resource from task, since task is used at the moment. | The association of a language resource to a task can not removed, since the affected task is used by a user at the moment. | ||||||
| Language Resources | Given Language-Resource-Service "{serviceType}." is not registered in the Language-Resource-Service-Manager! | This happens if a task has associated a language resource, which has completly deactivated (for example by deactivating the plug-in). |
Terminology
| EventCode | Context | EventMessage | Description / Solution | ||||||
|---|---|---|---|---|---|---|---|---|---|
| Terminology | There is no proposal which can be confirmed. | The user tried to confirm a term proposal on a term which does not have any proposal to be confirmed. | ||||||
| Terminology | There is no attribute proposal which can be confirmed. | The user tried to confirm a term attribute proposal on a attribute which does not have any proposal to be confirmed. | ||||||
| Terminology | There is no proposal which can be deleted. | The user tried to deleted a term proposal on a term which does not have any proposal. | ||||||
| Terminology | There is no attribute proposal which can be deleted. | The user tried to deleted a term attribute proposal on a attribute which does not have any proposal. | ||||||
| Terminology | The made term proposal does already exist as different term in the same language in the current term collection. | Search for the proposed term in the collection. |
Segment
| EventCode | Context | EventMessage | Description / Solution | ||||||
|---|---|---|---|---|---|---|---|---|---|
| Segment | The data of the saved segment is not valid. | The data of the saved segment contains invalid data, see error details for more information. | ||||||
| Segment | The data of the saved segment is not valid. | See E1065, in addition that the validations contain at least an error where the segment is either to long or to short. This error is separate since it should produce an warning instead just a debug level entry. | ||||||
| Segment Pixellength | Textlength by pixel failed; most probably data about the pixelWidth is missing: fontFamily: "{fontFamily} fontSize: "{fontSize}". | Same as E1082 below, but no default width is available for that font and font size. | ||||||
| Segment Pixellength | Segment length calculation: missing pixel width for several characters. | On of the characters in the segment has no pixel length defined, the default pixel width is used. This error happens in most cases on the export of a task, where the length of the segments is finally checked. Also it happens on saving a segment. |
Plug-Ins
Plug-In Okapi
| EventCode | Context | EventMessage | 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 file {file}. See log details for more information. | 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: |
Plug-In Groupshare
| EventCode | Context | EventMessage | Description / Solution | ||||||
|---|---|---|---|---|---|---|---|---|---|
| Plug-In GroupShare | Multi Purpose Code logging in the context of Groupshare | Multi Purpose Code logging in the context of Groupshare. | ||||||
| Plug-In GroupShare | Groupshare Plug-In: Exception | General Purpose Exception | ||||||
| Plug-In GroupShare | Groupshare Plug-In: No valid license token in cache for current user | There is no valid license token in the cache for the current user. The license token creation for this user was probably done before, but the token does not exist anymore. |
Plug-In MatchAnalysis
| EventCode | Context | EventMessage | Description / Solution | ||||||
|---|---|---|---|---|---|---|---|---|---|
| Plug-In MatchAnalysis | Multi Purpose Code logging in the context of MatchAnalysis | Multi Purpose Code logging in the context of MatchAnalysis. | ||||||
| Plug-In MatchAnalysis | Disabled a Language Resource for analysing and pretranslation due too much errors. | Check the details and also the logs for more information. | ||||||
| Plug-In MatchAnalysis | Unable to use connector from Language Resource "{name}". Error was: "{msg}". | Check the details and also the logs for more information. | ||||||
| Plug-In MatchAnalysis | MatchAnalysis Plug-In: tried to load analysis data without providing a valid taskGuid | A valid taskGuid must be provided here as parameter, to load only the analysis data for one task. |
EventCode 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 event codes: make life easier for support / help desk.