| Category | Import, Export |
|---|---|
Purpose | Enables integration with Across hotfolder feature. |
Bootstrap Class | - |
| Type | Private plug-in |
Description
A translate5 private plug-in that is able to watch a hotfolder for tasks, that should be created in translate5 - and re-exported to the hotfolder, once they are ready.
The hot-folder will be queried every ~15 min with the usual translate5 cron job.
The plug-in is able to watch multiple hotfolders (for different connected systems each) at the same time. This is implemented by configuring one SFTP server per instance, overwriteable on customer level.
All tasks created out of files loaded via a customer specific config are associated to that customer.
The hotfolders are accessed via sftp by translate5.
The instruction.xml is always the last file that is written to the folder. As soon as this is completely present, one can assume completeness.
The list of files and reference files in the instruction.xml must be complete, otherwise there is a process error, which cannot be fixed by translate5, but must be fixed by the client. Therefore all files listed in the instruction.xml must be processed by the connector - not more and not less.
Folder structure
Each hotfolder contains three folders:
...
| View file | ||||
|---|---|---|---|---|
|
Configuration
| Config name | Values | Default | Description |
|---|---|---|---|
runtimeOptions.plugins.AcrossHotfolder.defaultPM | integer | Default user to be assigned as PM for AcrossHotfolder-projects | |
runtimeOptions.plugins.AcrossHotfolder.filesystemConfig | map | [] | Filesystem config for AcrossHotfolder project import |
runtimeOptions.plugins.AcrossHotfolder.enableAutoExport | bool | true | Choose if finished task should be automatically uploaded into client's filesystem |
FilesystemConfig explanation
...
Config itself is a simple JSON object.
Example:
{"host": "ftp-server","username": "translate5","password": "translate5", "type": "sftp", "rootpath": "default-customer"}| Filed name | Values | Variants | Local Type | Required | Default | Description |
|---|---|---|---|---|---|---|
type | string |
| + | Type of filesystem | ||
| location | string | + | + | Path to working folder on server with translate5 project | ||
linkHandling | string |
| + | 0002 | How to deal with links, either 0001 (skip) or 0002 (disallow) Disallowing them causes exceptions when encountered | |
writeFlags | integer |
| + | 2 |
| |
| host | string | + | 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 | ||||
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 | 22 | SFTP server port | |||
useAgent | bool | false | ||||
timeout | integer | 10 | ||||
maxTries | integer | 4 | ||||
hostFingerprint | string |