...
title | Rewrite/Restructure Page |
---|
The Configuring Profiles and Fragments - 1 an Overview page gives an overview of the considerations to be made when using the Editor and thereby makes a good part of the information below redundant
The information presented here can be reduced to:
...
Table of Contents |
---|
Overview
...
Note that the links behind each parameter name in the diagram lead to the Parameter Reference page 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 (optional)
- CopySourceFragmentRef
- CopyTarget
- CopyTargetFragmentRef
- LocalTarget (A ProtocolFragment does not need to be defined here as the target is the local file system)
- Directory
- CopyTargetFragmentRef
- CopySource
- Copy
- Operation
- Profile (profile_id= 'p2')
- etc....
- Profile (profile_id= 'p1')
Each individual file transfer is headed up by a Profile, which is added as a child of the Profiles element.
The individual parameters that have to be specified in the Profile are as follows:
- 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 descencent elements. For example, a Rename operation will require a different descendants to a Move operation. - In the example, a Copy operation is specified, which, in turn, requires that CopySource and CopyTarget elements are set.
- The CopySource element requires has two child elements:
- a CopySourceFragmentRef element
- , which is required. This element in turn requires an FTPFragmentRef element
- , which contains the reference specifying the ProtocolFragment element
- . The ProtocolFragment then specifies the transfer connection parameters such as authentication, protocol, etc.
- Note that the FragmentRef element (FTPFragmentRef), which is used to specify the ProtocolFragment element, is protocol-specific. This allows optional pre- and post-processing child elements - which are not shown in the diagram - to be added to the profile as child elements of the FTPFragmentRef element. Such elements are protocol-specific.
- a SourceFileOptions element which - together with the Selection element - can be optionally used to specify a range of parameters related to aspects of file selection.
- The CopyTarget element does not have 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 rood directory is required.
~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~
...