Page History

Introduction

The JADE YADE Client can be operated from the command line and batch files. In addition it can be operated by jobs that are provided as part of the SOS JobScheduler's JITL library and by way of an API, which is available for integration with other applications.
This section of the User Manual will concentrate on using the Client via the JADE YADE Command Line Interface.

In order to allow checking of the validity of the (possibly complex) parameter sets required for more sophisticated file transfer situations, an XML schema will be introduced for version 1.11. The XML schema will use a standardized parameter syntax and many parameter names will change with its introduction. File transfers specified for versions up to 1.10.x will need to be modified before they can be run with versions 1.11 onwards.

A parameter mapping ...

File transfer configuration up to Version 1.10.x

File transfer configurations are stored in a settings.ini file.

Individual parameters are grouped together in profiles that can be reused and allow a 'single point of definition' approach to be followed.

Parameters that can be defined separately for the source and target parts of the transfer - for example, the host name and port number - are set with the source_ and target_ prefixes.

This is illustrated in the following example profile:

[ftp_server_2_local]
;;
 operation               = copy
;;
 source_host             = test.sos-berlin.com
 source_protocol         = ftp
 source_port             = 21
 source_user             = demo
 source_password         = demo
 source_dir              = /
;;
 target_host             = localhost
 target_protocol         = local
 target_dir              = ${USERPROFILE}\jade_demo\a

Detailed descriptions of the parameter configuration and the use of profiles is available in our JADE Tutorials. These include examples that can be tested using our test FTP and SFTP servers. A download containing a configuration file for the tutorial examples is also available.

File transfer configuration from Version 1.11 onwards

The XML schema that will be introduced with version 1.11 of JADE will allow parameter dependencies in JADE to be checked before transfer configurations are tested.

An XML editor is available that will simplify the creation and validation of schema-compatible file transfer configurations.

Change in YADE Configuration Format

Use of the YADE Client will be significantly changed with the introduction of an XSD schema and XML configuration files with version 1.11.

Up to Release 1.10.x - *.ini File Configuration

File transfer configuration has been carried out using text-based *.ini files up to and including Releases 1.10.x

A series of tutorials is available that provides guidance through setting up YADE and configuring basic file transfer situations.

A brief description of a simple *.ini file transfer configuration is available in the Configuration Formats & Tools section of this manual.

Release 1.11.x onwards - XML Based Configuration

An XML based configuration using an XSD schema will be introduced with Release 1.11. The use of the schema will considerably simplify file transfer configuration for the YADE Client - particularly for complex file transfer situations.

A form-based editor is available that will guide the user during the configuration process and ensure that configurations are validated.

File transfer configurations specified for Client versions up to 1.10.x will need to be modified before they can be run with versions 1.11 onwards. A Parameter Mapping table is available to help conversion to the XML based configuration.

Further Information

See Configuring File Transfers with the YADE Client for more information about the changes involvedThe basic principles behind the organization of the schema and parameters will be described in this document. A detailed description of individual parameters can be found in our Parameter Reference.