...
- Import
- Every folder beneath import contains the data of one project, that should be imported
- In this project folder there is one instruction.xml file, that contains the meta-data for the project and is NOT to be translated
- Also in this folder there may be one folder that should contain attachments. Its name is specified in the tag <attachmentfolder path="DocReferenceFiles" /> in the instruction.xml file. If this exists,
- all contained PDF files should be used as sources for the visual of the project
- all other files should be imported as reference files for the translate5 project
- All other files and folders in the project folder should be imported as files, that need to be translated.
- Export
- Once a task of a project has finished its workflow, the translated files are exported to the export folder of the hotfolder, they came from
- For each project a folder with the same name as the folder that was found in the import folder is created. For each task within this project folder a sub-folder with the rfc5646 short-cut of the target language is created and the translated files are placed there
- Error
- If an error happens on import, the project that did run into an error is moved to the folder error
- Import-running
- we move the project folder here during import
- Import-success
- In case an import the transfer of the data is successful, the imported folder beneath the import folder is moved to the import-success folder. Still the import itself may running in translate5.
Example structure of an import hotfolder, that containts a project to be imported:
...
Endpoint: editor/hotfolder/force-check
Possible GET params:
| Param name | Values | Description |
|---|---|---|
none | - | If no params provided - all clients and default configs will be processed |
defaultOnly | true|false | Only default config will be processed |
clientIds | integer[] | Comma separated client ids. Only provided client ids will be processed (if some present of course) |
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 |
...