| Table of Contents |
|---|
Introduction
Use of the JADE YADE Client will be significantly changed with the introduction of an XSD schema and XML configuration files with Release 1.11.
Example configuration and command line calls for the XML-based configuration are presented on this page.
XML-based file transfer configuration - available from Release 1.11 onwards
The XML file transfer configuration introduced with Release 1.11 of JADE YADE allows parameter dependencies in JADE YADE to be validated before the configuration file is transferred to an operating environment.
Dependencies and conflicts between configuration elements are avoided through the use of an XSD schemaAn XML editor is available that will simplify the creation and validation of schema-compatible file transfer configurations.
The basic principles behind the organization of the schema and parameters will be described on this page. A detailed description of individual parameters can be found in our Parameter Reference and a description of the considerations involved in configuration of a simple file transfer can be found in the Simple File Transfer with Basic Authentication example.
The following screen shot of the SOS XML Editor shows the configuration of a simple FTP file transfer example - in this case the example downloads files from the SOS demo server to the local file system.
...
Although longer and seemingly more complex than a comparable settings file configuration (see JADE YADE Tutorial 1), the XML code for this example was produced using the graphical editor and therefore has been validated against the JADE YADE Client XSD Schema. It is error and conflict free and dependencies are correctly specified.
Running a file transfer profile
A file transfer is started by specifying an XML configuration file and the profile in that file that is to be used.
...
| Code Block | ||
|---|---|---|
| ||
./jade.sh -settings="${HOME}/jade_demo/jade_user_manual_configuration.xml" -profile="ftp_server_2_local" |
Moving from a Settings File to an XML Configuration
Comparison of the two approaches reveal a significant difference in the concept behind the two approaches to configuration:
- Settings file configuration
Parameters such as host, protocol, user, password and dir (directory) are usually grouped separately in the settings file configuration according to whether they apply to the transfer source or target. This usually has no functional meaning (the files are processed from top to bottom) and is partly simply for convenience (grouping parameters together makes them easier to find) and partly to allow their reuse in the form of so-called profile fragments if required. - XML configuration
- Parameters are divided up between profile and fragment branches. (Note that these expressions are defined differently to elements in the settings file configuration with the same names.)
- authentication and connection parameters (Account & Password and Hostname & Port respectively) and the protocol (defined through the use of FTP) are part of the Fragments branch of the configuration.
- the operation (copy) and the source and target file paths (FilePath and LocalTarget respectively) are specified in the Profiles branch.
- the CopySourceFragmentRef element refers to the FTPFragment specified in the Fragments branch
- The division between Fragments and Profiles branches allows the reuse of elements whilst working within the strict hierarchical structure of XML.
- The use of a reference in the Profiles branch (in the example, using the CopySourceFragmentRef element) to specify the authentication and connection parameters in the Profiles branch allows any number of Profiles elements to be defined and specified as required.
- Parameters are divided up between profile and fragment branches. (Note that these expressions are defined differently to elements in the settings file configuration with the same names.)
More Information
Further Information
Related Sections of this User Manual:
- YADE User Manual - Configuration Formats & Tools
- YADE User Manual - Configuring and Running File Transfers (this page)
See the Configuration Formats & Tools article for a comparison between the XML Configuration and its predecessor, the *.ini File.
See JobScheduler Monitoring Interface - XSD Schema Reference article See JADE User Manual - XSD Schema article for more detailed information about the XML configuration.
...