Summary
The main restrictions of FTP file transfer are:
- only basic authentication can be carried out - i.e. authentication with an account name and optionally a password.
As with all file transfer protocols, any number of FTP file transfer configurations in the form of ProtocolFragments can be pre-configured and selected as required.
Operations around FTP file transfer
In addition, JADE can carry out the following operations in conjunction with FTP file transfer:
- pre- and post-processing operations, both for the source part of the transfer (i.e. pickup) and the target part (i.e. put down)
- file renaming
The configuration of these operations is described in detail on this page.
FTP-specific transfer features
FTP provides a number of protocol-specific features:
- passive mode
- a choice of transfer modes
The configuration of these features is described in detail on our FTP-only Parameters page.
Specification of FTP File Transfer Elements
1. What is added to the Fragments branch
FTPFragment
The key element in the JADE XML schema for the specification of a file transfer by FTP is the FTPFragment.
- This includes parameters for a connection to a host and authentication parameters accordingly.
- Such fragments can be defined once and can be re-used by any number of Profiles
Specify an FTPFragment for the source of your transfer.
2. What is added to the Profiles branch
a) Add a Source This element is part of the Profiles branch of the schema and a direct descendant of operation source or target elements such as CopySource . Add the FTPFragmentRef
In order to use your FTPFragment in a Profile add the FTPFragmentRef element.
b) Add a target
use a local target
For a complete configuration see the "Getting Started" sample from our article JADE - XML Configuration - Sample Files
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. FTPFragment elements are specified in the Fragments branch of the schema and may not be specific to the current transfer operation - i.e. more than one configuration can be defined.
Note that the FTPFragment reference, which is specified as a name attribute of the FTPFragmentRef element, is not shown in the XSD schema hierarchy diagram below.
In addition, as shown in the first diagram below, the FTPFragmentRef element has child elements that are but define aspects of the operation that are FTP-specific: FTPPreProcessing, FTPPostProcessing and Rename. These elements are described in detail below.
The FTPFragmentRef Element
xxx JADE Parameter Reference - FTPFragmentRef
A Simple FTP File Transfer Example Configuration
The configuration for a simple FTP file transfer is shown in the Example JADE Configuration for Simple FTP File Transfer article.
Further Information
Pages
Navigation