Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.



  • JS7 makes use of the YADE Add-on for transfer of transferring files using a number of protocols such as FTP, FTPS, SFTP, WebDAV, HTTP/HTTPS etc.
  • The JS7 Agent ships with a YADE client installation that is available in the yade sub-directory of the Agent's home directory.
  • In addition to the JS7 - Order History and JS7 - Task History, the JS7 - File Transfer History is available, provided for displaying detailed results about transfers and the files included.
  • For File Transfers:
    • The File Transfer View provides information about past and present transfers.
    • The File Transfer Configuration is used to manage the configuration, for example to access SFTP servers and to select files and locations for transfer.
    • File Transfer Jobs can share a File Transfer configuration and perform the effective transfer.


The File Transfer view allows to monitor current transfers and offers to check to be monitored and allows past and present transfers to be checked:


  • The view shows details about of each transfer such as:
    • the source, target , and transfer result that . These are reported individually for each file included in a transfer,
    • any errors occurring during transfer.
  • The Advanced Filter allows individual files to be looked up by name, path etc.
  • Find more details from the JS7 - File Transfer History view.


The configuration editor is used, for example, to manage connection data and credential credentials for access to remote servers. In addition, it allows to manage management of profiles that specify which servers are involved in a transfer and which files should be transferred.


The YADE Client ships with Agents by default from the installation directory:

  • /opt/ (Unix)
  • C:\Program Files\\js7\agent\yade (Windows)


File Transfer jobs are technically shell jobs that execute the YADE command line interface (CLI). Therefore the job script looks will look like this:

Code Block
titleYADE Client Job Script example

  -settings $JS7_YADE_CONFIG_DIR/yade.xml \
  -profile transfer_by_sftp \
  -file_path /tmp/some.file.txt


  • The job script can make use of a number of JS7 - Job Environment Variables that are automatically available. This includes any environment variables prefixed with JS7 such as:
    • JS7_YADE_BIN, which points to the YADE start script that is available:
      • for Unix from $JS7_AGENT_HOME/yade/bin/
      • for Windows from %JS7_AGENT_HOME%/yade/bin/yade.cmd
    • JS7_YADE_DMZ_BIN, which points to the second YADE start script that is used for transfers with a YADE Jump Host available:
      • for Unix from $JS7_AGENT_HOME/yade/bin/
      • for Windows from %JS7_AGENT_HOME%\yade\bin\yade4dmz.cmd
    • JS7_YADE_CONFIG_DIR, which points to the YADE configuration directory that corresponds to the Agent's configuration directory, i.e. JS7_AGENT_CONFIG_DIR.
  • The following arguments are used:
    • -settings expects the path to a YADE configuration file (*.xml, *.ini) that specifies the file transfer source, targets and profiles.
    • -profile expects the name of the profile to be applied from the the YADE configuration file.
    • -file_path can optionally be used as the path of a file to be transferred if not otherwise specified from in the profile.

Parameterization of the YADE Client


  • The mapping of order variables and optionally node arguments to environment variables for the a job looks like:

  • The declaration of the above order variables looks will look like:

  • Note that use of default values is not required. If no default value is specified then the order has to specify a value for the variable in question.


  • The following command line arguments can be used with a File Transfer job:
    • -settings is the path to a YADE *.xml or *.ini configuration file that holds fragments and profiles for transfer of files.
      • YADE configurations can be managed from the Configuration -> File Transfer View and can be both automatically deployed and can be exported to *.xml files:
      • For details about how to deploy YADE configurations see JS7 - File Transfer Deployment.
      • The YADE configuration file has to be located with an Agent, therefore it is an option to transferring this file to an Agent is an option.
    • -profile is the name of the profile to be applied from the the YADE configuration file.
    • -java-options are options for the Java Virtual Machine. Frequently such options are used to specify the maximum heap size. By default YADE will use 32 MB, however, if 1000s of files are transferred with a single call to the YADE Client, e.g. when using a file specification to transfer any all the files from a directory, then it will be required necessary to increase the default heap size.
    • -log-level enables to specify Log4j2 log level indicators such as info, debug, trace that  to be specified. These will provide more detailed information, for example in case that the event of files which permanently cannot be transferred. Find You will find more details from in JS7 - Log Levels and Debug Options article.
  • The above job script shown above does not indicate a specific selection of files for transfer. This gives you two options:
    1. to hard-wire the file selection directly with the YADE configuration file (yade.xml).
    2. to specify the file selection from an order variable that is mapped to an environment variable with the job script. Use this environment variable with the YADE configuration.
      • Example:
        • Add an environment variable such as e.g. YADE_FILE_SPEC to your mapping of environment variables.
          • The value can be a hard-wired regular expression:

          • The value can be mapped from an order variable or node argument:

        • The YADE configuration can makes use of the ${YADE_FILE_SPEC} environment variable that will be substituted at run-time, e.g. with:

        • Note that this mechanism can be used for any environment variables that are available for a job and with the YADE configuration.


  • Connection Management
    • Use of secure protocols such as SFTP, FTPS, WebDAV
    • Use of private/public keys for authentication
    • Use of a YADE Credential Store for file transfer connections
  • Access Management
  • Logging

The above building blocks allow to implement the implementation of secure file transfers for compliance with standards such as HIPPA, PCI-DSS, SOX etc. For further information see Is YADE compliant to some information security standard?

File Transfer Operation

Parallelism of File Transfers


  • Memory requirements typically include 32 MB for a YADE job.
  • CPU consumption is somewhat higher when loading the YADE Client, however this will be modest during the transfer of a file.

YADE jobs are executed in separate OS processes. Therefore there is no interference between jobs.