Skip to end of metadata
Go to start of metadata

Introduction

  • JS7 makes use of the YADE Add-on for 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 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.

File Transfer View

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


Explanation:

  • The view shows details of each transfer such as:
    • the source, target and transfer result. 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.

File Transfer Configuration

The Configuration=>File Transfer sub-view offers a schema aware configuration editor for File Transfers like this:


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

Find details from the JS7 - File Transfer Configuration article.

File Transfer Jobs

Location of the YADE Client

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

  • /opt/sos-berlin.com/js7/agent/yade (Unix)
  • C:\Program Files\sos-berlin.com\js7\agent\yade (Windows)

Usage of the YADE Client

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

YADE Client Job Script example
#!/bin/sh

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


Explanation:

  • 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/yade.sh
      • 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/yade4dmz.sh
      • 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 in the profile.

Parameterization of the YADE Client

Mapping of Variables

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


  • The declaration of the above order variables 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.

Command Line Arguments

The YADE Client allows a number of additional command line arguments to be specified:

YADE Client Job Script Parameterization example
#!/bin/sh

# Any environment variables assigned the job are automatically applied if used by the YADE profile

$JS7_YADE_BIN \
  -settings $JS7_YADE_CONFIG_DIR/yade.xml \
  -profile $YADE_PROFILE \
  -java-options "-Xmx32m" \
  -log-level debug

Explanation:

  • 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 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 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 all the files from a directory, then it will be necessary to increase the default heap size.
    • -log-level enables Log4j2 log level indicators such as info, debug, trace to be specified. These will provide more detailed information, for example in the event of files which permanently cannot be transferred. You will find more details in JS7 - Log Levels and Debug Options article.
  • The 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.

File Transfer Security

The YADE supports a number of mechanisms to secure file transfer operation:

  • 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 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

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

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

Mutual Exclusive File Transfers

High parallelism of file transfers can exhaust resources such as an SFTP server that receives a larger number of parallel requests.

In this situation consider to use the JS7 - Resource Locks to implement an exclusive lock or a shared lock that will limit parallel access to a resource. Any file transfer jobs that cannot immediately acquire a Resource Lock will wait until the lock is freed.

Further Resources


Write a comment…