Introduction
YADE is the Managed File Transfer utility that ships from a Command Line Client and from a JITL template job used with JS7 Agents. For use of the Command Line Client see JS7 - YADE Command Line Operation.
The JITL YADEJob job implements File Transfer operations between sources and targets, for details see JS7 - File Transfer.
File Transfer operations include
- copy
- move
- getlist
- remove
FEATURE AVAILABILITY STARTING FROM RELEASE 2.8.0
Usage
When defining the job either:
- invoke the Wizard that is available from the job properties tab in the Configuration view and select the JITL CanWriteJob and relevant arguments from the Wizard
or
- specify the
JITL
job class andcom.sos.jitl.jobs.yade.YADEJob
Java class name and add arguments as explained in the documentation below.
Example
Download: pdYADE2-JITL-FilePath.workflow.json
A YADEJob configuration can look like this:
Documentation
The Job Documentation including the full list of arguments is available from: https://www.sos-berlin.com/doc/JS7-JITL/YADEJob.xml
The YADEJob class accepts the following arguments:
Name | Required | Default Value | Purpose | Example |
---|---|---|---|---|
Transfer Options (required) | ||||
settings | yes | Specifies the path to an XML file holding the file transfer configuration. Typically the configuration is managed with the JOC Cockpit inventory, see JS7 - File Transfer Configuration. For JS7 - File Transfer Deployment the configurations are mapped to JS7 - Job Resources. |
| |
| yes | Specifies the name of the profile holding the file transfer configuration. The profile is a section in the XML file transfer configuration that specifies the source and target of a transfer. | copy_sftp | |
Transfer Options | ||||
| no | Specifies the the source directory of a transfer. The argument overwrites an existing source directory setting in the YADE XML configuration and is applied to any source protocol such as local, ftp, sftp etc. | /home/sos/outgoing | |
| no | Specifies a number of source directories that should be excluded from recursive file transfer. The argument overwrites an existing excluded source directory setting in the YADE XML configuration and is applied to any source protocol such as local, ftp, sftp etc. | /home/sos/outgong/no-transfer | |
| no | Specifies the path to an individual file that will be selected for transfer. The argument overwrites an existing source file setting in the YADE XML configuration and is applied to any source protocol such as local, ftp, sftp etc. | /home/sos/outgoing/test.csv | |
| no | Specifies a regular expression to select a number of files for transfer, for example:
The argument overwrites an existing source file specification setting in the YADE XML configuration and is applied to any source protocol such as local, ftp, sftp etc. |
| |
| no | Specifies the path to a file that holds the list of file names or paths that will be selected for transfer.
The argument overwrites an existing source file list setting in the YADE XML configuration and is applied to any source protocol such as local, ftp, sftp etc. | /home/sos/transfer.txt | |
| no | Specifies the the target directory of a transfer. The argument overwrites an existing target directory setting in the YADE XML configuration and is applied to any target protocol such as local, ftp, sftp etc. | /home/sos/incoming | |
Processing Options | ||||
| no | true | Specifies if case-sensitivitiy should be considered when replacing variables included in a YADE XML configuration:
Variables in a YADE XML configuration are specified like this: | |
no | true | Specifies if variables included in a YADE XML configuration that cannot be replaced by workflow variables should remain unresolved for replacement by OS environment variables. When operated from a job, then variables in a YADE XMl configuration are
The default value of the option is | ||
| no | 1 | Specifies if transfer of a number of files should be performed in parallel. By default files are transferred sequentially, corresponding to use the |