Description

TermImport plugin is able to watch a remote filesystem folder for terminology-to-be-imported to translate5.

Remote SFTP folder will be queried every ~15 min with the usual translate5 cron job

The plug-in is able to watch multiple folders e.g. located on different SFTPs at the same time. This is implemented by ability to overwrite global SFTP settings on customer-level.

All terminology is imported with respect to a customer specific config are associated to that customer, which should be copied from TermImport/config/instruction.ini and uploaded to the remote SFTP directory, which is then accessed by translate5.

If there is no instruction.ini in the remote directory - the import won't be started.

Folder structure

Each remote SFTP folder may 4 folders:

• Import
  
  • In this folder there should be one instruction.ini file, that contains the setting to control the import behaviour
  • Others files are expected to be *.tbx files
• Error
  • If an error happens on import, the Import-dir is renamed to Error-dir
• Import-running
  • we move the project folder here during import
•  Import-success
  • In case the transfer of the data is successful, the imported tbx-files beneath the import folder is moved to the Import-success folder. Still the import itself may running in translate5.

Example structure of an remote directory, that containts a terminology files to be imported:

/some/dir/with/tbx

    /Import

        /instruction.ini

        /terminology1.tbx

        /terminology2.tbx

How it looks after being moved to Import-success:

/some/dir/with/tbx

    /Import-success

        /instruction.ini

        /terminology1.tbx

        /terminology2.tbx

Instruction.ini

The information in the instruction.ini is evaluated as explained in the attached instruction.ini file.

For all parameters that are not present in the copy of instruction.ini that you'll upload to your remote sftp directory  - the ones shown below are assumed as default

instruction.ini

API point for manual start

Users with role api have right to manually start processing.

Endpoint: editor/hotfolder/force-check

Possible GET params:

Configuration

FilesystemConfig explanation

Default config in Preferences→System configuration always checked

If it is set for any customer then except from Default configuration customer's one will also be checked.

So in case with filesystemConfig setting value in customer entry not over-write system's but extends it instead.

Config itself is a simple JSON object.

Example: 

{"host": "sftp-server","username": "translate5","password": "translate5", "type": "sftp", "rootpath": "/some/dir/with/tbx"}