Introduction

• JS7 make use of the YADE Add-on for transfer of files by use of 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 from the yade sub-directory of the Agent's home directory.

File Transfer Jobs

Usage of the YADE Client

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

Explanations:

• 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 points to the YADE start script that is available
    • for Windows from %JS7_AGENT_HOME%/yade/bin/yade.cmd
    • for Unix from $JS7_AGENT_HOME/yade/bin/yade.sh
  • JS7_YADE_CONFIG_DIR points to the YADE configuration directory that corresponds to the Agent's configuration directory, i.e. JS7_AGENT_CONFIG_DIR
• The following environment variables are specific to this File Transfer job as they are mapped from order variables and node arguments, see JS7 - Order Variables:
  • YADE_PROFILE is the name of the profile to be applied from the the YADE configuration file.
    
  • YADE_FILE_PATH is the path of the file to be transferred.
• The mapping of order variables and optionally node arguments to environment variables for the job looks like this:
  
  
  
• The declaration of the above order variables looks like this:
  
  
  
  
• Consider that use of default values is not required. If no default value is specified then the order has to specify a value for the respective variable.

Parameterization of the YADE Client

The YADE Client offers to specify a number of additional command line arguments:

Explanations:

• 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 are offered for export to *.xml files.
    • As the YADE configuration file has to be located with an Agent we recommend to manually deploy or transfer this file to the respective Agent.
  • -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 files from a directory, then the default heap size could be increased.
  • -log-level enables to specify Log4j2 log level indicators such as info, debug, trace that will provide more detailed information, e.g. in case that files permanently could not be transferred.
• The job script is not not indicating a specific selection of files for transfer. This gives you two options:
  1. Hard-wire the file selection directly with the YADE configuration file (yade.xml).
  2. 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:
           
           
           
       • The YADE configuration can makes use of the ${YADE_FILE_SPEC} environment variable that will be substituted at run-time, e.g. with:
         
         
         
         
       • Consider that this mechanism can be used for any environment variable names that are available for a job and with the YADE configuration.

File Transfer View

The File Transfer View offers to monitor current transfers and past transfers in detail:

Explanations:

• The view offers details about each transfer such as
  • the source, target, transfer result individually for each file included with a transfer
  • any errors occurring during transfer
• The Advanced Search offers to look up individual files by name, path etc.

File Transfer Operation

Parallelism of File Transfers

Any number of parallel file transfer jobs can be executed. There is no built-in limit to parallelism.

• 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 transfer of a file.

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