| Table of Contents |
|---|
Introduction
The following example describes the configuration of a simple file transfer with basic - i.e. password - authentication is described on this page.
To keep the example simple, the FTP protocol is used and the transfer involves copying files A simple FTP file transfer example is used in which files are transferred from a remote server to the local file system.
The transfer configuration of this example is described here using the XML element based configuration introduced with Release 1.11 of JADE. See our JADE Tutorials for a description of the configuration of a similar example using the Settings parameters that could be applied for version before 1.11.A configuration example that copies files from the online SOS Demo server to the local file system is described in detail on in detail in our JADE - XML Configuration - Sample Files page.
On this page the more general aspects of the configuration procedure will be discussed.
Note:
- On our JADE - XML Configuration - Sample Files page
...
- there is complete configuration file
...
- download available to help get the example up and running as quickly as possible. This configuration can be used to download files from the online SOS Demo server to a local file system.
- The transfer configuration is described here uses the XML-based configuration introduced with Release 1.11 of JADE. A similar example using the Settings parameters configuration that was implemented for releases before 1.11 can be found our JADE Tutorials.
Configuration Tool
We recommend using our XML Editor to generate the configuration file. This editor uses the JADE XSD schema as a guide through each stage of the process, controlling . The schema is used to control and then validate the elements that can be be specified and then validating in the configuration.
Using the editor will significantly reduce the possibility of configuration errors.
...
The configuration described in this example is held as simple as possible. More complex file transfer scenarios will be described later.
Configuration Procedure
The configuration procedure involves 3 steps:
- Configuration of the Fragments - i.e. the protocol, connection and authentication methods to be used for the source and target parts of the operation.
- Configuration of the Profile - i.e. the operation to be carried out (e.g. copy or move), the fragments to be used for the source and target parts of the transfer and any specific directories that are to be used.
- Note that the Profile can also be used to specify other elements such as any notifications to be made or preprocessing that is to be carried out. These will be described later on.
Status Yellow title Clarify
- Note that the Profile can also be used to specify other elements such as any notifications to be made or preprocessing that is to be carried out. These will be described later on.
- Calling the Configuration and Profile from the command line, a batch file or via the JADE API.
...
The first step in the configuration is to configure the ProtocolFragments to be used for the transfer. Other fragments are not required for this example.
These are XML elements that specify how transfers are to be carried out. Protocol fragments can be thought of as predefined connection specifications. They are protocol-specific - the FTP protocol, for example, brings a different set of features and constraints than WebDAV protocol.
Fragments are not generally operation-specific - a fragment could be used as the target for one operation and then as a source for a subsequent one.
Any number of Fragments can be predefined in an XML a Configuration.
Fragments are given name attributes, with which they will be referenced from the file transfer profile as shown in the next step.
...
The XML hierarchy for the FTPFragment for this example is structured as follows:
...
The second configuration step is to define the Profile, which is operation-specific. For example, a Profile for a Move operation Operation requires source and target to be specified where as a Remove operation only requires a source.
The operation in the current example is Copy for which a source and a target elements (CopySource and CopyTarget respectively) have to be specified.
The type of fragment to be used for the source part of the transfer - here an FTPFragmentRef element - is specified in the CopySourceFragmentRef element.
The FTP fragment itself is then specified in the FTPFragmentRef element's reference ref attribute.
In this example, the CopyTargetFragmentRef is used to specify that the target is to be local. The target directory is specified in the Directory element, which is a sibling of the CopyTargetFragmentRef reference element.
...