Date: Fri, 29 Mar 2024 04:37:57 +0000 (UTC)
Message-ID: <1450769166.12367.1711687077082@change.sos-berlin.com>
Subject: Exported From Confluence
MIME-Version: 1.0
Content-Type: multipart/related;
boundary="----=_Part_12366_687123955.1711687077082"
------=_Part_12366_687123955.1711687077082
Content-Type: text/html; charset=UTF-8
Content-Transfer-Encoding: quoted-printable
Content-Location: file:///C:/exported.html
Overview=
h2>
File transfer parameters in YADE are defined hierarchically and are sort=
ed into two branches - Profiles and Fragments. A Prof=
ile specifies what is to be done (e.g. copy from A to B) and =
the Fragment defines how this is to be done (e.g. using p=
rotocol X, authentication Y, etc.).
Fragments (see the link to the relevant section of this manual =
at the foot of this article) are generally configured before Profiles=
em>. The considerations necessary for defining the Profile br=
anch of the configuration are described in this article.
How to generate the Profile configuration
The diagram below shows the minimum parameter hierarchy (i.e. without op=
tional 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 t=
he 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 provi=
des detailed information about the parameter.
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=
em> are as follows:
- The Profile requires a profile_id which is used to ca=
ll 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 el=
ements. For example, a Rename operation will require a different d=
escendants to a Move operation. See the YADE User Manual - The Operation - 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. T=
his element in turn requires an FTPFragmentRef element, which cont=
ains the reference specifying the protocol fragment element. The proto=
col fragment then specifies the transfer connection parameters such as auth=
entication, protocol, etc.
- Note that the FragmentRef element (FTPFragmentRef), w=
hich is used to specify the fragment element, is protocol-specific. This al=
lows 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 par=
ameters related to aspects of file selection.
- The CopyTarget element does not need a corresponding FTPFr=
agmentRef child element as the target is the local file system. Howeve=
r, 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.
Calling Profile Elements
A Profile is specified by its profile_id attribut=
e, which is used to call the profile when the transfer is called from the c=
ommand line.
An example showing the YADE command line call syntax can be seen in the =
Configuring and Running File Transfers article.
Othe=
r documents
- The use of the Operations element - the only Profiles=
child element whose use is required - is described in the Operation section of this manual.<=
/li>
------=_Part_12366_687123955.1711687077082--