...
For some cases in the instruction.xml the current across-specific values need to stay for a while and therefore there needs to be a mapping configuration, that maps those across-specific values to their translate5 counterparts. Where this should be done is specified in the instruction.xml file.
Deadline dates in file entries and Project attributes expected to be in one of formats: Y-m-d H:i:s, Y-m-d H:i, Y-m-d. To use any other format first check it using code snipped bellow:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
$deadline = '2024-03-28 11:58:33'; // Set your formated date here
$datetime = false;
try {
$datetime = new DateTime($deadline);
} catch (\Throwable) {
echo 'Invalid deadline format!';
}
if ($datetime) {
echo 'Double check provided deadline: ' . PHP_EOL . $datetime->format('Y-m-d H:i:s');
} |
The attached instruction.xml file stems directly from an across hotfolder scenario. The only things added can be found behind [translate5-mapping] in the comments.
...
{"host": "ftp-server","username": "translate5","password": "translate5", "type": "sftp", "rootpath": "default-customer"}
Filed Field name | Values | Variants | Local Type | Required | Default | Description |
---|---|---|---|---|---|---|
type | string |
| + | Type of filesystem | ||
location | string | + | + (not required for sftp-Usage) | 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 |
...