Page History

...

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.

Note that the links behind each element name in the diagram lead to the Parameter Reference Documentation for that element, which provides detailed information about the parameter.

• Profiles
  • Profile (profile_id= 'p1')
    
    • Operation
      • Copy
        
        • CopySource
          
          • CopySourceFragmentRef
            
            • FTPFragmentRef (Has the ref attribute which specifies the source ProtocolFragment)
          • SourceFileOptions
            
            • Selection
        • CopyTarget
          
          • CopyTargetFragmentRef
            • LocalTarget (A ProtocolFragment does not need to be defined here as the target is the local file system)
          • Directory
  • Profile (profile_id= 'p2')
  • etc.

...

• 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 User Manual - The Operation 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 diagram 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.
• 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 requiredused.

Calling Profile Elements

...

An example showing the JADE command line call syntax can be seen in the Configuring and Running File Transfers article.

Further Information

Related Sections of this User Manual:

• JADE User Manual - Configuration Formats & Tools
• JADE YADE User Manual - Configuring and Running File Transfers
  • JADE YADE User Manual - Configuration 1 - An OverviewJADE User Manual - XSD Schema
  • JADE User Manual - Configuration 2 - The Fragments Branch
  • JADE User Manual - Configuration 3 - The Profile Branch (this page)
    • JADE User Manual - The Operation - What is to be done?

Other documents

• The use of the Operations element - the only Profiles child element whose use is required - is described in the Operation Element section of this manual.