Page History

Table of Contents

Summary

...

Alternative Fragments are defined for the situations where a preferred connection cannot be made and that waiting for the configuration to become available is not an acceptable alternative.

AlternativeFragments elements can be used in situations where:

• a specified - i.e. first choice - connection may not be available,
• where it is not acceptable to wait for the first choice connection and
• where alternative transfer configurations could be used.

Specifying Alternative Fragments

Alternative fragment AlternativeFragment elements are specified using either a ReadableAlternativeFragmentRef element or a WriteableAlternativeFragmentRef element, both readable fragment element or a writeable fragment element both of which are, respectively, children of the CopySourceFragmentRef or CopyTargetFragmentRef elements in the configuration Profiles branch.

Readable... elements are used where only read permissions are required - i.e. for transfer sources, Writable... elements are used where a file is to be written - i.e. for transfer targets and for transfer sources where the file to be transfered is modified before being transferred. Note that this can be where pre-processing is involved.

In the XML hierarchy this looks like:

• Profile
  • Operation
    
    • Copy
      • CopySource
        CopySourceFragmentRef
        • • CopySourceFragmentRef (specifies one of the following)
            • FTPFragmentRef
            • FTPSFragmentRef
            • etc
          ...
          • • .
          ReadableAlternativeFragmentRef 
          • AlternativeCopySourceFragmentRef (Has the ref
          Attribute
          • attribute specifying the source
          ReadableAlternativeFragment Fragment(s)
          • fragment)
          • AltFTPFragmentRef
        • CopyTarget
          
          • CopyTargetFragmentRef (specifies one of the following)
            • FTPFragmentRef
            • FTPSFragmentRef
            • etc.
          • AlternativeCopyTargetFragmentRef (Has the ref attribute specifying the target fragment)

  The AlternativeCopySourceFragmentRef and AlternativeCopyTargetFragmentRef elements then contain alternative fragment elements that will be tried in turn if the first one is not able to make a connection.

  ...

  Note that the alternative fragment elements are themselves only references to named protocol fragment elements.

  Further Information

  Related Sections of this User Manual:

  • YADE User Manual - Configuration Formats & Tools
  • YADE User Manual - Configuring and Running File Transfers
    • YADE User Manual - Configuration 1 - An Overview
    • YADE User Manual - Configuration 2 - The Fragments Branch
      • YADE User Manual - Configuring Alternative Fragments (this article)
        
    • YADE User Manual - Configuration 3 - The Profile Branch