...
The diagram below shows the minimum parameter hierarchy (i.e. without optional parameters) required to specify a file transfer from a remote source per FTP protocol to the local file system.
When the XML Editor is used to generate the configuration you will be guided using the Add child button to insert valid elements starting with the Profiles element and proceed down the hierarchy.
...
- The Profile requires a profile_id which is used to call the profile when the transfer is called from the command line.
- Each Profile element is required to have an Operation element.
Note that the Operation specified defines subsequent descendant elements. For example, a Rename operation will require a different descendants to a Move operation. See the JADE YADE User Manual - The Operation article - What is to be done? article for more information. - In the example, a Copy operation is specified, which, in turn, requires that CopySource and CopyTarget elements are set.
- The CopySource element has two child elements:
- a CopySourceFragmentRef element, which is required. This element in turn requires an FTPFragmentRef element, which contains the reference specifying the protocol fragment element. The protocol fragment then specifies the transfer connection parameters such as authentication, protocol, etc.
- Note that the FragmentRef element (FTPFragmentRef), which is used to specify the fragment element, is protocol-specific. This allows optional pre- and post-processing child elements - which are not shown in the hierarchy - to be added to the profile as child elements of the FTPFragmentRef element. Such elements are protocol-specific.
- a SourceFileOptions element which is also required - together with the Selection element - and is used to specify a range of parameters related to aspects of file selection.
- a CopySourceFragmentRef element, which is required. This element in turn requires an FTPFragmentRef element, which contains the reference specifying the protocol fragment element. The protocol fragment then specifies the transfer connection parameters such as authentication, protocol, etc.
- The CopyTarget element does not need a corresponding FTPFragmentRef child element as the target is the local file system. However, the LocalTarget element must be specified.
- The Directory element is used to specify a target directory if a directory other than the user's root directory is used.
...
A Profile is specified by its profile_id attribute, which is used to call the profile when the transfer is called from the command line.
An example showing the JADE YADE command line call syntax can be seen in the Configuring and Running File Transfers article.
...
Related Sections of this User Manual:
- JADE YADE User Manual - Configuration Formats & Tools
- YADE User Manual - Configuring and Running File Transfers
- YADE User Manual - Configuration 1 - An Overview
- JADE YADE User Manual - Configuration 2 - The Fragments Branch
- YADE User Manual - Configuration 3 - The Profile Branch (this page)
...