The transfer
variable in the CONFIGURATION
archive contains the settings for automatic transfer of local data to a central server.
The configuration is spit into profiles defining a single transfer target and operations. Uploading is intended to be performed automatically and periodically to ensure that data are processed by the central server. So the normal usage is via an automatic job on the acquisition computer.
General Settings
- /Upload
-
- Description
-
The automatic upload profiles
- Keys
-
The keys immediately below this are profile names that are selected by the application. For example,
aerosol
is the commonly used default profile. However, any non-empty name is acceptable and can be used to create customized configurations that can be selected at run time. In general, profile names should be all lower case to preserve case insensitivity. In the paths listed<PROFILE>
is used as a placeholder to real profile name (e.g. replace<PROFILE>
withaerosol
for the default profile).
- /Upload/
<PROFILE>
/AllowInfiniteStart -
- Description
-
Allow values with undefined/infinite starts instead of clipping them
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Upload/
<PROFILE>
/BeginActions -
- Description
-
Command actions to execute before starting any uploads
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/BeginActions/#0
-
- Description
-
Command executed before an upload is started
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/BeginActions/#0
/#0
/AllowFailure -
- Description
-
Permit failure of the command without aborting uploading
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Upload/
<PROFILE>
/BeginActions/#0
/#0
/Arguments -
- Description
-
Arguments passed to the executable
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/BeginActions/#0
/#0
/Arguments/#0
-
- Description
-
Command arguments
- Type
- /Upload/
<PROFILE>
/BeginActions/#0
/#0
/Program -
- Description
-
Program executable
- Type
- /Upload/
<PROFILE>
/Certificate -
- Description
-
Public certificate used for signing the transfer package
- Type
- /Upload/
<PROFILE>
/Encryption/Certificate -
- Description
-
Public certificate used for package encryption
- Type
- /Upload/
<PROFILE>
/Encryption/Key -
- Description
-
Private key used for package encryption
- Type
- /Upload/
<PROFILE>
/EndActions -
- Description
-
Command actions to execute after all uploads have finished
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/EndActions/#0
-
- Description
-
Command executed at the end of uploading
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/EndActions/#0
/#0
/AllowFailure -
- Description
-
Permit failure of the command without aborting uploading
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Upload/
<PROFILE>
/EndActions/#0
/#0
/Arguments -
- Description
-
Arguments passed to the executable
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/EndActions/#0
/#0
/Arguments/#0
-
- Description
-
Command arguments
- Type
- /Upload/
<PROFILE>
/EndActions/#0
/#0
/Program -
- Description
-
Program executable
- Type
- /Upload/
<PROFILE>
/FilePackageActions -
- Description
-
Command actions to execute before writing the packaged file
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/FilePackageActions/#0
-
- Description
-
Command executed before the transfer file is packaged
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/FilePackageActions/#0
/#0
/AllowFailure -
- Description
-
Permit failure of the command without aborting uploading
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Upload/
<PROFILE>
/FilePackageActions/#0
/#0
/Arguments -
- Description
-
Arguments passed to the executable
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/FilePackageActions/#0
/#0
/Arguments/#0
-
- Description
-
Command arguments
- Type
- /Upload/
<PROFILE>
/FilePackageActions/#0
/#0
/Program -
- Description
-
Program executable
- Type
- /Upload/
<PROFILE>
/FilePrepareActions -
- Description
-
Command actions to execute after writing the packaged file
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/FilePrepareActions/#0
-
- Description
-
Command executed after the transfer file is packaged
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/FilePrepareActions/#0
/#0
/AllowFailure -
- Description
-
Permit failure of the command without aborting uploading
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Upload/
<PROFILE>
/FilePrepareActions/#0
/#0
/Arguments -
- Description
-
Arguments passed to the executable
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/FilePrepareActions/#0
/#0
/Arguments/#0
-
- Description
-
Command arguments
- Type
- /Upload/
<PROFILE>
/FilePrepareActions/#0
/#0
/Program -
- Description
-
Program executable
- Type
- /Upload/
<PROFILE>
/Filename -
- Description
-
Base upload file name
- Type
- Undefined values
-
${STATION|UPPER}_${TIME}_${UID|UPPER}_${INSTANCE}.c3i
- /Upload/
<PROFILE>
/Filter -
- Description
-
The data to upload
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/Filter/#0
/Accept -
- Description
-
Accept matched data as passing the filter
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Upload/
<PROFILE>
/Filter/#0
/Archive -
- Description
-
The archive to match
- Type
- /Upload/
<PROFILE>
/Filter/#0
/Flavors -
- Description
-
The exact set of flavor matches to require
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/Filter/#0
/Flavors/#0
-
- Description
-
A single flavor to match
- Type
- /Upload/
<PROFILE>
/Filter/#0
/HasFlavors -
- Description
-
The list of flavor matches to require
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/Filter/#0
/HasFlavors/#0
-
- Description
-
A single flavor to match
- Type
- /Upload/
<PROFILE>
/Filter/#0
/LacksFlavors -
- Description
-
The list of flavor matches to exclude
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/Filter/#0
/LacksFlavors/#0
-
- Description
-
A single flavor to match
- Type
- /Upload/
<PROFILE>
/Filter/#0
/Priority -
- Description
-
The priority of the operation, defining the order in which it is applied with respect to other operations
- Type
- Undefined values
-
Not permitted
- /Upload/
<PROFILE>
/Filter/#0
/Station -
- Description
-
The station to match
- Type
- /Upload/
<PROFILE>
/Filter/#0
/Universal -
- Description
-
Apply the operation universally, disregarding other overlapping operations
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Upload/
<PROFILE>
/Filter/#0
/Variable -
- Description
-
The variable to match
- Type
- /Upload/
<PROFILE>
/Key -
- Description
-
Private key used for signing the transfer package
- Type
- /Upload/
<PROFILE>
/Send -
- Description
-
The directory to place file that have not yet been sent
- Type
- Undefined values
-
/aer/${STATION|LOWER}/log/send
- /Upload/
<PROFILE>
/Sent -
- Description
-
The directory to place file that have been successfully sent
- Type
- Undefined values
-
/aer/${STATION|LOWER}/log/sent
- /Upload/
<PROFILE>
/Storage/Type -
- Description
-
The file storage type
- Type
- Values
-
This is an enumeration value. It accepts a single string (not case sensitive) from a list of possible choices. Possible values:
-
Directory
orSend
- Use local directories to store a queue of files to send and a copy of all those that have been sent successfully -
None
orAnonymous
- Do not store files after uploading -
Leave
,Keep
, orSendKeep
- Keep queued files in a local directory and do not remove them once uploading completes (requires an action to prevent duplicate uploads) -
Remove
orSendRemove
- Keep queued files in a local directory, but remove them once uploading completes
-
- /Upload/
<PROFILE>
/Transfer/Actions -
- Description
-
Command actions to execute for each file being uploaded
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/Transfer/Actions/#0
-
- Description
-
Command executed for each file being uploaded
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/Transfer/Actions/#0
/#0
/AllowFailure -
- Description
-
Permit failure of the command without aborting uploading
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Upload/
<PROFILE>
/Transfer/Actions/#0
/#0
/Arguments -
- Description
-
Arguments passed to the executable
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/Transfer/Actions/#0
/#0
/Arguments/#0
-
- Description
-
Command arguments
- Type
- /Upload/
<PROFILE>
/Transfer/Actions/#0
/#0
/Program -
- Description
-
Program executable
- Type
- /Upload/
<PROFILE>
/Transfer/After -
- Description
-
Command actions to execute after uploading is completed
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/Transfer/After/#0
-
- Description
-
Command executed executed after uploading
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/Transfer/After/#0
/#0
/AllowFailure -
- Description
-
Permit failure of the command without aborting uploading
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Upload/
<PROFILE>
/Transfer/After/#0
/#0
/Arguments -
- Description
-
Arguments passed to the executable
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/Transfer/After/#0
/#0
/Arguments/#0
-
- Description
-
Command arguments
- Type
- /Upload/
<PROFILE>
/Transfer/After/#0
/#0
/Program -
- Description
-
Program executable
- Type
- /Upload/
<PROFILE>
/Transfer/Before -
- Description
-
Command actions to execute before any uploading is processed
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/Transfer/Before/#0
-
- Description
-
Command executed before upload processing
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/Transfer/Before/#0
/#0
/AllowFailure -
- Description
-
Permit failure of the command without aborting uploading
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Upload/
<PROFILE>
/Transfer/Before/#0
/#0
/Arguments -
- Description
-
Arguments passed to the executable
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/Transfer/Before/#0
/#0
/Arguments/#0
-
- Description
-
Command arguments
- Type
- /Upload/
<PROFILE>
/Transfer/Before/#0
/#0
/Program -
- Description
-
Program executable
- Type
- /Upload/
<PROFILE>
/Transfer/Type -
- Description
-
The type of upload performed
- Type
- Values
-
This is an enumeration value. It accepts a single string (not case sensitive) from a list of possible choices. Possible values:
-
FTP
- Upload files to a plain FTP server -
External
orCommand
- Process uploading using only upload command actions on each file -
File
,Copy
, orLocal
- Copy files to a locally accessible path -
Email
- Send files via EMail -
URL
- Upload via a POST or PUT request to a specific URL
-
- /Upload/
<PROFILE>
/Transfer/Local/CreateDirectory -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = File
-
- Description
-
Create the output directory if it does not exist
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Upload/
<PROFILE>
/Transfer/Local/Target -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = File
-
- Description
-
Output target of local files
- Type
- /Upload/
<PROFILE>
/Transfer/Email/Attachment -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Attachment file name
- Type
- /Upload/
<PROFILE>
/Transfer/Email/BCC -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Email BCC receivers
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/Transfer/Email/BCC/#0
-
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Email receiver address
- Type
- /Upload/
<PROFILE>
/Transfer/Email/Body -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Email message body
- Type
- /Upload/
<PROFILE>
/Transfer/Email/CC -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Email CC receivers
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/Transfer/Email/CC/#0
-
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Email receiver address
- Type
- /Upload/
<PROFILE>
/Transfer/Email/ContentID -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
ContentID header for the attached files
- Type
- /Upload/
<PROFILE>
/Transfer/Email/From -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Address to specify as the sender
- Type
- /Upload/
<PROFILE>
/Transfer/Email/MIMEType -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
MIME type of the attached files
- Type
- Undefined values
-
Inferred from the file extension
- /Upload/
<PROFILE>
/Transfer/Email/PlainText -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Send the email body in plain text form
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Upload/
<PROFILE>
/Transfer/Email/Relay/From -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Address to list as in the "From:" header
- Type
- Undefined values
-
Filled by the server
- /Upload/
<PROFILE>
/Transfer/Email/Relay/Hostname -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Hostname to use as the SMTP relay
- Type
- Undefined values
-
Local program, then direct SMTP connection
- /Upload/
<PROFILE>
/Transfer/Email/Relay/Password -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Password presented to the relay server
- Type
- /Upload/
<PROFILE>
/Transfer/Email/Relay/PasswordFile -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
A file to read the SMTP relay password from
- Type
- /Upload/
<PROFILE>
/Transfer/Email/Relay/Port -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
SMTP relay connection port
- Type
- Valid range
-
1 ≤ value ≤ 65535
- Undefined values
-
Not permitted
- /Upload/
<PROFILE>
/Transfer/Email/Relay/Program -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Local program used to send an email
- Type
- Undefined values
-
Direct connection if no relay is present
- /Upload/
<PROFILE>
/Transfer/Email/Relay/TLS -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Use a secured SSL/TLS connection
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Upload/
<PROFILE>
/Transfer/Email/Relay/Username -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Username presented to the relay server
- Type
- /Upload/
<PROFILE>
/Transfer/Email/Separate -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Send separate emails for each file being uploaded
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Upload/
<PROFILE>
/Transfer/Email/Subject -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Email subject
- Type
- /Upload/
<PROFILE>
/Transfer/Email/Timeout -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Maximum time to wait for the email send to succeed
- Type
- Valid range
-
0.0 < value
- Undefined values
-
Unlimited
- /Upload/
<PROFILE>
/Transfer/Email/To -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Email receivers
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/Transfer/Email/To/#0
-
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Email receiver address
- Type
- /Upload/
<PROFILE>
/Transfer/URL/PUT -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = URL
-
- Description
-
Use a PUT request instead of a POST
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Upload/
<PROFILE>
/Transfer/URL/SSL -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = URL
-
- Type
- Structure
-
A SSL specification consists of a hash map defining the parameters for encrypted SSL/TLS connections.
- /Upload/
<PROFILE>
/Transfer/URL/Target -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = URL
-
- Description
-
Output URL to send files to
- Type
- /Upload/
<PROFILE>
/Transfer/URL/Timeout -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = URL
-
- Description
-
Maximum time to wait for the request to succeed
- Type
- Valid range
-
0.0 < value
- Undefined values
-
Unlimited
- /Upload/
<PROFILE>
/Transfer/FTP/ActiveMode -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
FTP active mode configuration
- Type
- Values
-
This is an enumeration value. It accepts a single string (not case sensitive) from a list of possible choices. Possible values:
-
Active
orActiveOnly
- Only use active mode transfers -
Both
- Try passive mode then active mode -
Passive
orPassiveOnly
- Only use passive mode transfers
-
- /Upload/
<PROFILE>
/Transfer/FTP/CreateDirectory -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
Create the directory on the server if it does not exist
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Upload/
<PROFILE>
/Transfer/FTP/Hostname -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
FTP server name
- Type
- /Upload/
<PROFILE>
/Transfer/FTP/ImmediateKeepalive -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
Require immediate responses to keepalives
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Upload/
<PROFILE>
/Transfer/FTP/KeepAlive -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
Keep alive command interval
- Type
- Valid range
-
0.0 ≤ value
- Units
-
s
- Undefined values
-
Not permitted
- /Upload/
<PROFILE>
/Transfer/FTP/Password -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
FTP password
- Type
- Undefined values
-
cpd3
- /Upload/
<PROFILE>
/Transfer/FTP/PasswordFile -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
File to read the FTP password from
- Type
- /Upload/
<PROFILE>
/Transfer/FTP/Port -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
FTP port to connect on
- Type
- Valid range
-
1 ≤ value ≤ 65535
- Undefined values
-
Not permitted
- /Upload/
<PROFILE>
/Transfer/FTP/RelaxedIncoming -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
Do not check the incoming server and port in active mode
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Upload/
<PROFILE>
/Transfer/FTP/Resume/Download -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
Enable resume in download mode
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Upload/
<PROFILE>
/Transfer/FTP/Resume/Retries -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
Maximum number of retries to attempt to resume
- Type
- Valid range
-
0 ≤ value
- Undefined values
-
Not permitted
- /Upload/
<PROFILE>
/Transfer/FTP/Resume/Upload -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
Enable resume in upload mode
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Upload/
<PROFILE>
/Transfer/FTP/SSL -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
SSL parameters for the connection
- Type
- Structure
-
A SSL specification consists of a hash map defining the parameters for encrypted SSL/TLS connections.
- /Upload/
<PROFILE>
/Transfer/FTP/Target -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
Target path to write the uploaded file to on the server
- Type
- /Upload/
<PROFILE>
/Transfer/FTP/Timeout/Command -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
Command timeout or zero for unlimited
- Type
- Valid range
-
0.0 ≤ value
- Units
-
s
- Undefined values
-
Not permitted
- /Upload/
<PROFILE>
/Transfer/FTP/Timeout/Total -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
Total operation timeout or zero for unlimited
- Type
- Valid range
-
0.0 ≤ value
- Units
-
s
- Undefined values
-
Not permitted
- /Upload/
<PROFILE>
/Transfer/FTP/Timeout/Transfer -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
Data transfer timeout or zero for unlimited
- Type
- Valid range
-
0.0 ≤ value
- Units
-
s
- Undefined values
-
Not permitted
- /Upload/
<PROFILE>
/Transfer/FTP/UploadRateLimit -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
Upload rate limit or zero to disable
- Type
- Valid range
-
0 ≤ value
- Units
-
bytes/s
- /Upload/
<PROFILE>
/Transfer/FTP/Username -
- Required conditions
-
-
/Upload/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
FTP username
- Type
- Undefined values
-
anonymous
- /Upload/
<PROFILE>
/UploadActions -
- Description
-
Command actions to execute after the current data transfer file has been created
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/UploadActions/#0
-
- Description
-
Command executed before after the output file is created
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/UploadActions/#0
/#0
/AllowFailure -
- Description
-
Permit failure of the command without aborting uploading
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Upload/
<PROFILE>
/UploadActions/#0
/#0
/Arguments -
- Description
-
Arguments passed to the executable
- Keys
-
The keys immediately below this are array indices. These are indexes into an ordered list, with the first element being zero. For example,
#0
is the first element of the array. The paths represented here use#0
as a placeholder for all indices.
- /Upload/
<PROFILE>
/UploadActions/#0
/#0
/Arguments/#0
-
- Description
-
Command arguments
- Type
- /Upload/
<PROFILE>
/UploadActions/#0
/#0
/Program -
- Description
-
Program executable
- Type
- /Upload/
<PROFILE>
/CreateDirectory -
- Excluding conditions
-
-
/Upload/
<PROFILE>
/Storage/Type = None
-
- Description
-
Create the target directory if required
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Upload/
<PROFILE>
/Storage/Send -
- Excluding conditions
-
-
/Upload/
<PROFILE>
/Storage/Type = None
-
- Description
-
Completed storage file name
- Type
- Undefined values
-
${SENT}/${FILE}
- /Upload/
<PROFILE>
/Transfer/AbortOnFailure -
- Excluding conditions
-
-
/Upload/
<PROFILE>
/Storage/Type = None
-
- Description
-
Abort the entire upload on any detected failure
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Upload/
<PROFILE>
/Transfer/HaltOnFailure -
- Excluding conditions
-
-
/Upload/
<PROFILE>
/Storage/Type = None
-
- Description
-
Stop uploading subsequent files on failure
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE