Skip to end of metadata
Go to start of metadata

Introduction

The YADE Client is the main component in YADE. The client is not only responsible for file transfer and SSH command execution but can carry out customizable logging, send the transfer history to the YADE Background Service, enable an audit trail and provide error handling. The architecture of the YADE Client and its associated components is described in detail in the YADE Implementation Architecture.

YADE Command Line Interface

The Command Line Interface allows YADE to be operated directly from the command line or from batch files.

  • The YADE Command Line Interface is used e.g. for integration with existing scripts and to replace direct calls to FTP and SFTP command line programs.
  • The YADE Command Line Interface allows to change the file transfer behavior, e.g. switch of protocol from FTP to SFTP, without the need to modify existing scripts. Such modifications can be applied to a YADE configuration file and would not affect existing file transfer scripts.

Read more ...

YADE API

The YADE API is used as a component for an individual application that requires file transfer capabilities.

  • The YADE API makes the functionality of YADE available to any application running in a Java Virtual Machine.
  • The YADE API provides access to classes and methods for individual handling of file transfer needs.

Read more ...

YADE JITL Jobs

Seamless integration of YADE within the SOS JobScheduler using the JobScheduler's YADE JITL Jobs (part of the JobScheduler Integrated Template Library) means that the full range of the JobScheduler's workload automation capabilities can be used to:

  • automatically start and control file transfers using JobScheduler features such as Job Chains and Schedules,
  • carry out advanced pre- and post-processing before and after a file transfer.

Read more ...

About these tutorials

Tutorial Scope

  • The YADE tutorials provide a basis for learning how to use the YADE Client via the Command Line Interface mentioned above. They are intended to function as a Getting Started Guide before proceeding to increasingly complex examples.
  • The tutorials describe operation of the YADE Client from the command line, e.g. by using a batch script. The other methods of operating the Client are:

Operating Environment

  • The examples have been written for use on Windows and Unix systems. Settings files for Windows and Unix systems are available for download via the links in the next section.
  • The examples presented on this page use demonstration FTP and SFTP servers that we have configured for this purpose on our web site.
    • Both servers have the same address:
    • A user demo can log on with password demo and download demonstration files. They cannot upload or delete files.

Configuration file Format and Editor

Configurations for the YADE Client up to and including Release 1.10 are saved in text-based  settings.ini files. From Release 1.11 onwards XML configuration will be used, which will significantly reduce the complexity of more extensive configurations.

The SOS GmbH has developed the XML Editor which provides an easy to follow graphical representation of YADE XML configurations and to a large extent allows uses to click together their configurations. The XML Editor saves YADE configurations in the XML format and can generate a working settings.ini configuration file. A comparison of both formats can be found in the YADE User Manual - Configuration Formats & Tools article.

We strongly recommend the use of this editor which uses an XSD schema to validate and should bring a significant reduction in configuration errors and debugging time.

Using the tutorials with the YADE Client Command Line Interface

The YADE Client should be installed

The XML Editor should be installed.

Setting up the examples

  • For Windows users the location for the jade.cmd file is:
    • C:\Program Files\sos-berlin.com\jade\client\bin
    • or the location that was specified when installing YADE
  • for Unix users the location for the jade.sh file is:
    • ~/sos-berlin.com/jade/client/bin
    • or the location that was specified when installing YADE

Note that comments in the YADE settings profiles are added using double semi-colons (";;").

Running the examples

  • Either open the command line interface in the location where you have installed the jade.cmd or jade.sh files or use suitable path name prefixes.
  • The command line parameterization is identical for both the Windows and the Unix command line.
  • Run the examples by entering the following in the command line, e.g. for the first of the examples listed below:
Windows
Unix

Results of the first example

Running the first example using the ftp_server_2_local profile listed in the code blocks above will cause six test*.txt files to be downloaded to the a sub-folder of the jade_demo folder created following the instructions in the Setting up the Examples section above.

Note for Unix Users

All other examples in this series of articles list the profile settings and command line call for Windows environments. Unix users will find suitable profile settings in the Unix version of the jade_settings.ini file which was linked above and will be able to adapt the Windows command line calls in the manner shown above.

Using the tutorials with the JobScheduler YADE JITL Job

The YADE JITL job tutorial is available with JobScheduler - Tutorial 5 - The YADE JITL Job - Configuring and running file transfer jobs.