JADE User Manual - Simple FTP File Transfer

Introduction

The key element in the JADE XML schema for the specification of a file transfer by FTP is the FTPFragmentRef element. This element is part of the Profiles branch of the schema and a direct descendant of operation source or target elements such as CopySource or MoveTarget. The FTPFragmentRef element can be specified for the source and/or target parts of the operation.

The FTPFragmentRef element itself contains a reference to the FTPFragment to be used for this part of the transfer.

In addition, as shown in the first diagram below, the FTPFragmentRef element has three child elements that are optional but define aspects of the operation that are FTP-specific: FTPPreProcessing, FTPPostProcessing and Rename.

Section Title

A Simple File Transfer Example ConfigurationTODO

The configuration for a simple file transfer as shown in the SOS XML Editor is shown in the screen shot below.

(The transfer is carried out per FTP from a remote server to the local file system and password authentication is required for the remote server.)

This file transfer profile would be started by calling the XML configuration file and the profile in that file that is to be used.

The calls for Windows and Unix systems respectively would be: CHECK SYNTAX (SETTINGS)

jade.cmd -settings="%USERPROFILE%\jade_demo\jade_user_manual_configuration.xml" -profile="ftp_server_2_local"

./jade.sh -settings="${HOME}/jade_demo/jade_user_manual_configuration.xml" -profile="ftp_server_2_local"

The example shown in the Editor screen shot above clearly shows the organization of the configuration in the editor's left hand pane:

• The starting point is the ProfileID in center of the pane which is specified in the command line call.
• The Copy Operation specifies that CopySource and  CopyTarget elements are required. These elements are added automatically by the Editor along with any child elements that are listed in the XSD Schema as being required.
  As the Editor validates the configuration before it can be saved, the user is effectively guided through the configuration, being prompted to set values at least for all required elements and informed about the optional child elements that can be applied at a particular point in the configuration by the 'Add child' button at the top of the right hand pane.
  • See The Operation Parameter for more information
• An FTPFragmentRef element has been selected for the CopySourceFragmentRef. The value for this element is the name of the ProtocolFragment specified in the Protocol branch shown at the top of the Editor pane.
  • This referencing technique allows a number of Fragment elements to be specified within a Configuration and used as desired.
• The FTPFragment specified is selected from the Fragments listed when the 'Add child' button is clicked for the ProtocolFragments element.
  Selection of the FTPFragment element causes the Editor to automatically add the required child elements - in this case the BasicAuthentication and Account and BasicConnection and Hostname elements.
  • The optional Password element, which is required by the FTP server on test.sos-berlin.com, is added manually by way of the 'Add child' button.
  • The optional Port element shown was added for demonstration purposes but is set to the default value for the FTPFragment.
  • See ...... for more detailed information about Fragments TODO

Further Information

• Configuring File Transfers with the JADE Client
• The SOS XML Editor
• Authentication
• Parameter Reference