Note |
---|
If the API changes in an incompatible manner this is listed explicitly in the "important release notes" section of each releases changelog. |
Currently there are three five ways to import terminology into translate5:
- Importing a task with terminology into translate5 for editing
→ this is not covered here, since that terminology currently can not be searched in the termportal. - Import a TBX file in the translate5 GUI in the language resources panel. For explanation of options please read below the options of "file-system based term import", as the options are the same.
- Provide TBX files with the terminology → use file-system based import
- Get TBX files from Across via crossApi
- SFTP-directory based
Depending on which way the terminology should be imported, the TermImport Plug-In must be configured.
The configuration files are located
Table of Contents |
---|
SFTP based term import
File-system based term import
...
Code Block |
---|
;;;; ATTENTION: the below variables need to be placed above the areas [FileMapping] and [CollectionMapping] ;import directory of the tbx files importDir=/var/www/translate5/data/tbx-import/filesystem/; ;mergeTerms: Allowed values: true or false. ;If this is true, terms will be merged as described at https://confluence.translate5.net/display/TAD/Term+Collection. ;Otherwise all terms will be added to the termCollection, if the ID in the TBX does NOT exist already in the DB ;when the ID of the termEntry of the TBX does already exist in the DB, the terms of this termEntry will always be merged mergeTerms=true; ;Deletes all termEntriesterms in all listed termCollections, that have a modificationupdated date older than the listed one.date configured for "deleteTermsModifiedOlderThan". ;SinceEvery everyterm entryin thata existstermCollection inhas a TBXcreation getsdate, a newmodification updated date on TBX-import, even if it is not changed: Simply set this date to yesterday to delete all terms, that are not part of the current importand an updated dated. ;The creation date and the modification date are taken from the dates as they appear in the TBX file. ;The updated date is anot dateshown internalin tothe translate5GUI and is differentchanged fromevery thetime modifieda dateuser ofchanges the term, that is shown through touching ;it in the interface deleteEntriesModifiedOlderThan GUI or through an import deleteTermsModifiedOlderThan=2018-05-01 ;Deletes all termEntriesterms in all listed termCollections, that have aan modification"updated date" older than the the start of the current import. ;To learn, what the "updated date" is, please read above ;possible values: true or false deleteEntriesOlderThanCurrentImportdeleteTermsOlderThanCurrentImport=true ;DeletesDelete all term proposals proposals in a listed termCollections, that have a creation date older thenthan this deleteEntriesModifiedOlderThanconfigs datevalue. ;If the deleteEntriesModifiedOlderThan is not set, then the current date will be used ;The current date will be used also when deleteEntriesOlderThanCurrentImport is truedeleteProposalsOlderThan=2018-05-01 ;Delete all proposals in a listed termCollections, that have a creation date older than the start of the current import. ;possible values: true or false deletProposalsOlderThandeleteProposalsOlderThanCurrentImport=truefalse ;;;; ATTENTION: the above variables need to be placed above the areas [FileMapping] and [CollectionMapping] ;mapping between tbx file and term collection name [FileMapping] Term.tbx=exampletermCollection; Term1.tbx=exampletermCollection; Term2.tbx=exampletermCollection; example2.tbx=exampletermCollection2; example3.tbx=exampletermCollection3 ;mapping between term collection name and customer number (NOT the id) [CollectionMapping] exampletermCollection3=1000; exampletermCollection2=1003; |
...
Code Block |
---|
crossAPIurl=http://win.translate5.net ;All Across TBX Export templates (as created by Across) will be used. For each of the export templates a TBX will be exported and imported into the translate5 termCollection, to that it is mapped to below in the area [FileMapping] crossExportFilesDir=/var/www/translate5/data/tbx-import/crossapi/ apiUsername=crossapi.user apiPassword=pass ;mergeTerms: Allowed values: true or false. ;If this is true, terms will be merged as described at https://confluence.translate5.net/display/TAD/Term+Collection. ;Otherwise all terms will be added to the termCollection, if the ID in the TBX does NOT exist already in the DB ;when the ID of the termEntry of the TBX does already exist in the DB, the terms of this termEntry will always be merged mergeTerms=true; ;Deletes all termEntriesterms in all listed termCollections, that have a modificationupdated date older than the listed one. ;Since every entryterm that exists in a TBX gets a new updated date on TBX-import, even if it is not changed: Simply set this date to yesterday to delete all terms, that are not part of the current import ;The updated date is a date internal to translate5 and different from the modified date of the term, that is shown in the interface deleteEntriesModifiedOlderThandeleteTermsLastTouchedOlderThan=2018-05-01 ;Deletes all termEntriesterms in all listed termCollections, that have a modification date older than the the start of the current import. ;possible values: true or false deleteEntriesOlderThanCurrentImportdeleteTermsOlderThanCurrentImport=true ;DeletesDelete all term proposals older then deleteEntriesModifiedOlderThan date. ;If the deleteEntriesModifiedOlderThan is not set, then the current date will be used ;The current date will be used also when deleteEntriesOlderThanCurrentImport is true proposals in a listed termCollections, that have a creation date older than this configs value. deleteProposalsLastTouchedOlderThan=2018-05-01 ;Delete all proposals in a listed termCollections, that have a creation date older than the start of the current import. ;possible values: true or false deletProposalsOlderThandeleteProposalsOlderThanCurrentImport=truefalse ;mapping between across export template name (potentially located in the crossExportFilesDir directory) and term collection a translate5 termCollection.;the termCollection will be created, if it does not exist. [FileMapping] template-1.export=exampletermCollection ;mapping between term collection name and customer number [CollectionMapping] exampletermCollection3=10001; exampletermCollection2=10002; exampletermCollection=123456789; |
...
URL: | (YOUR_TRANSLATE5_DOMAIN)/editor/plugins_termimport_termimport/crossapi |
Available Methods: | GET |
Specialities: | Start the crossapi-system based term import for the across configuration TBX export template files with location defined in the crossExportFilesDir parameter from the crossapi.config |
Availability: | It is avalable only for users with system role "admin" or "api") |
...