Introduction
The Operation element specifies the type of file transfer that is to be carried out. The Operation is a child element of the Profile and a required element
Table of Contents |
---|
Introduction
Operational parameters may or may not be mandatory.
Operational parameters are used without the source_ and target_ prefixes.
Operation - the action
...
YADE is to carry out
...
The JADE Operation elements that the YADE Client can carry out a number of operations.These areare defined as follows:
- copy
Copy - duplicate the files from one location to another
send Move -
transferduplicate the files
to a remote server - deprecated- receive - transfer files from a remote server - deprecated
- remove - remove files on/from a server
- execute - execute a command on a remote server by SSH - deprecated
- install - install JADE on a remote (jump host) server - deprecated
from one location to another and then delete the original files
Remove - delete files from a server
GetList -
getlist -obtain a file containing a list of file
namesStatus colour Yellow title Verify
Data-Type: SOSOptionStringValueList
The default value for this parameter is send.
This parameter is mandatory.
...
names
Specifying the Operation Element
An Operation element is required for each file transfer configuration.
In the YADE XSD schema, the Operation is a child of the Profile element as is shown in the hierarchy below:
- Profile
- Operation
- Copy
- CopySource
- CopyTarget
- Move
- MoveSource
- MoveTarget
- Remove
- RemoveSource
- GetList
- GetListSource
- Copy
- Client (optional)
- other optional siblings ...
- Operation
The hierarchy also shows how the Operation element that is selected defines whether source and target elements require to be called. These in turn define the transfer options that may be available.
The Operation element has a number of siblings (Client, JobScheduler and Notifications) which are optional children of the Profile element and are described in the Profile parameter reference article.
When the XML Editor is used, selection of an Operation will cause the Editor to automatically generate the required descendants necessary to specify the Operation.
For the Copy Operation these would be:
- Copy
- CopySource
- CopySourceFragmentRef
- *FragmentRef (contains the reference to the Fragment to be used, where * defines the protocol to be used)
- SourceFileOptions
- Selection
- CopySourceFragmentRef
- CopyTarget
- CopyTargetFragmentRef
- Directory
- CopySource
Example Configuration using the Copy Operation
An example configuration using the Copy Operation was shown on the Configuring File Transfers with the YADE Client page.
Example Configuration using the GetList Operation
An example configuration using the GetList Operation is shown on the Example YADE Configuration using the GetList Operation page.
Further Information
- We recommend using the Editor for XML Configuration to configure file transfers for YADE. The editor uses the YADE XSD schema to guide users through the configuration process and validate configurations.
- The Operation parameter reference page.
...
Global parameters
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
The parameters listed below are per default global and apply to all profiles unless overwritten.
Note that it is also possible to define a global profile with the name 'global'. Parameter/name pairs set in this profile will apply to all profiles unless overwritten by parameters set in individual profiles.
buffer_size - Max size of transferred data block
The maximum size of a data block is defined with this option.
Data-Type: SOSOptionInteger
The default value for this parameter is 32000.
log_filename - Name (and Pathname) of the logging-file
This parameter specifies the location of a file to which the log output will be written.
log4jpropertyfilename
...
verbose - the debug message granularity
Status | ||||
---|---|---|---|---|
|
The verbose parameter specifies the intensity of log entries.
A value between 1 and 9 can be specified. Higher values cause more detailed information to be logged.
Log output is written to stdout or to a file that has been specified with the log_filename parameter.
Data-Type: SOSOptionInteger
This parameter is optional.
...
If this Option is set to true, all not processed or recognized options are reported as a warning.
Data-Type: SOSOptionBoolean
...