Currently there are three ways to import terminology into translate5:
Depending on which way the terminology should be imported, the TermImport Plug-In must be configured.
The configuration files are located
To import TBX files from the file system into translate5s termCollections use the file-system based import.
For this a configuration file maps the TermCollection name with the file name of the TBX and the collection name with the customer number. In addition the config file defines the import directory, where the files are read from.
Example of the config file for the file system-based import. This file is located under "config" folder inside the TermImport plugin.
TermCollections, that do not exist, will be created by the import.
;;;; 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 terms in all listed termCollections, that have a updated date older than the date configured for "deleteTermsModifiedOlderThan". ;Every term in a termCollection has a creation date, a modification date and 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 not shown in the GUI and is changed every time a user changes the term through touching ;it in the GUI or through an import deleteTermsModifiedOlderThan=2018-05-01 ;Deletes all terms in all listed termCollections, that have an "updated date" older than the start of the current import. ;To learn, what the "updated date" is, please read above ;possible values: true or false deleteTermsOlderThanCurrentImport=true ;Delete all proposals in a listed termCollections, that have a creation date older than this configs value. deleteProposalsOlderThan=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 deleteProposalsOlderThanCurrentImport=false ;;;; 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 [CollectionMapping] exampletermCollection3=1000; exampletermCollection2=1003; |
This api call is only allowed for translate5 authenticated PM, Admin and API users.
To use the API as an authenticated user, first a session must be generated. More about how to authenticate and use translate5 API at: REST API
URL: | (YOUR_TRANSLATE5_DOMAIN)/editor/plugins_termimport_termimport/filesystem |
Available Methods: | GET |
Specialities: | Start the files-system based term import for the files with location defined in the importDir parameter from the filesystem.config |
Availability: | It is avalable only for PMs (users with system roles PM, Admin or API) |
Example of the config file for the file crossapi-based import. This file is located under "config" folder inside the TermImport plugin.
TermCollections, that do not exist, will be created by the import.
crossAPIurl=http://win.translate5.net 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 terms in all listed termCollections, that have a modification date older than the listed one. ;Since every term 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 deleteTermsModifiedOlderThan=2018-05-01 ;Deletes all terms in all listed termCollections, that have a modification date older than the start of the current import. ;possible values: true or false deleteTermsOlderThanCurrentImport=true ;Delete all proposals in a listed termCollections, that have a creation date older than this configs value. deleteProposalsOlderThan=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 deleteProposalsOlderThanCurrentImport=false ;mapping between across export template and term collection [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 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") |