System administrators

Page tree

Versions Compared

Key

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

...

  • Import - This is single folder, initially expected to exist inside SFTP directory. It, in it's turn, is expected to have:
    • *.tbx files to be imported
    • instruction.ini that contains the settings to control the import behaviour of *.tbx-files
  • Error
    • If at least one tbx-file was failed to import - this folder will be automatically created and failed tbx-file will be moved here
  • Import-running
    • If we initially had Import folder having valid instruction.ini file then Import folder itself is kept but it's contents (possibly except instruction.ini file) is moved to Import-running folder (it's created if not exists so far), so this is indicating that import process is started
  •  Import-success
    • Once at least one tbx-file has been successfully imported - this folder is auto-created and this tbx-file is moved here. Still the import itself may running in translate5.

...

    /Import-success

        /instruction.iniini                NOTE: this file won't be moved here from /Import subdir if sftpPersistentInstructionIni-config is set to true, but by default it is not. See more details below.

        /terminology1.tbx

...

Code Block
; 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
; Possible values: true or false.
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
deleteTermsLastTouchedOlderThan=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.
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
deleteProposalsOlderThanCurrentImport=false

; If settings how tbx should be imported into Translate5 always stay the same, and you can not create it automatically,
; you can activate this sftpPersistentInstructionIni setting, so TermImport will leave the instruction.ini file where it is.
; Plugin will look for the configured files in FileMapping and process them if they are present.
sftpPersistentInstructionIni=false

; Mappings between tbx-file names, expected to exist in remote sftp directory and local TermCollection names
; where those files shoud be imported into. If some TermCollection does not exist so far - it will be created
; if there the customer exists having the specified number (see comments for further [CollectionMapping] section)

[FileMapping]
Term1.tbx=exampletermCollection
Term2.tbx=exampletermCollection2
;Term3.tbx=exampletermCollection2

; Mappings between TermCollection names and customer numbers.
; If there is no customer having such number in the database
; then tbx file won't be imported into such a TermCollection
[CollectionMapping]
exampletermCollection3=10001
exampletermCollection2=123456789
exampletermCollection=123456789

...

Field nameValuesVariantsLocal Type

Required

DefaultDescription

type

string
  • sftp

+
Type of filesystem

linkHandling

string
  • 0001

  • 0002

+
0002

How to deal with links, either 0001 (skip) or 0002 (disallow)

Disallowing them causes exceptions when encountered

writeFlags

integer
  • 1
  • 2
  • 3
+
2
  • 1 to acquire a shared lock (reader).
  • 2 to acquire an exclusive lock (writer).
  • 3 to release a lock (shared or exclusive)
hoststring

+
sftp host

username

string

+
sftp login

password

string



sftp password

set to null if privateKey is used

privateKey

string



can be used instead of password, set to null if password is set
must be a path: '/path/to/my/private_key'
if a relative path is given, APPLICATION_ROOT is prepended

passphrase

string



set to null if privateKey is not used or has no passphrase

rootpath

string


/

the root directory to be used on the SFTP server

port

integer


22SFTP server port

useAgent

bool


false

timeout

integer


10

maxTries

integer


4

hostFingerprint

string




...