The upload
variable in the CONFIGURATION
archive contains the settings for the automatic data uploader.
Uploading involves calling one or more generator components, then using the standard upload backend to send their output to some location.
In some cases the generator may handle the uploading itself (e.g. the SQL output) and no actual files are uploaded.
The configuration is spit into profiles defining a single upload operation. Each upload operation has a trigger of updated data that causes the upload to happen (e.g. new data are passed). When the trigger is met, the upload is split into interval segments, with each interval segment being uploaded all at once. Within the interval segment, it can be further split to prevent huge file generation but the whole interval segment will always be done at the same time.
General Settings
- /Profiles
-
- Description
-
Upload profile configuration
- 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).
- /Profiles/
<PROFILE>
/AllowIncomplete -
- Description
-
Allow uploading of incomplete trigger ranges before any trigger is detected past the end of the range
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<PROFILE>
/Archive/Completed -
- Description
-
The target name to move files to after successful upload
- Type
- /Profiles/
<PROFILE>
/Archive/RetryDirectory -
- Description
-
The location to store files queued for upload retry
- Type
- /Profiles/
<PROFILE>
/DisableFill -
- Description
-
Disable uploading of filled intervals between the currently changed one and the end of the last known change
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<PROFILE>
/DisableReupload -
- Description
-
Disable re-uploading of already uploaded ranges when a trigger change is detected within one
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<PROFILE>
/Generate -
- Description
-
Output file generation actions
- 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.
- /Profiles/
<PROFILE>
/Generate/#0
/Command/AllowFailure -
- Description
-
Permit failure of the command without aborting generation
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<PROFILE>
/Generate/#0
/Command/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.
- /Profiles/
<PROFILE>
/Generate/#0
/Command/Arguments/#0
-
- Description
-
Command arguments
- Type
- /Profiles/
<PROFILE>
/Generate/#0
/Command/Program -
- Description
-
Program executable
- Type
- /Profiles/
<PROFILE>
/Generate/#0
/Component/IgnoreDirectory -
- Description
-
Do not set the directory option to the output temporary directory
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<PROFILE>
/Generate/#0
/Component/IgnoreProfile -
- Description
-
Do not set the profile option to match the upload profile
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<PROFILE>
/Generate/#0
/Component/Name -
- Description
-
The component to execute as an action
- Type
- /Profiles/
<PROFILE>
/Interval -
- Description
-
The upload interval
- Type
- Structure
-
A time interval consists of a time unit, a number of units to apply, and an alignment setting.
- Undefined values
-
Exactly the changed data
- /Profiles/
<PROFILE>
/Interval/Units -
- Description
-
A logical time unit
- Type
- Values
-
This is an enumeration value. It accepts a single string (not case sensitive) from a list of possible choices. Possible values:
-
Millisecond
orMilliseconds
-
Second
,Sec
,Seconds
,Secs
, ors
-
Minute
,Min
,Mins
,Minutes
,m
, ormi
-
Hour
,Hours
, orh
-
Day
,Days
, ord
-
Week
,Weeks
, orw
-
Month
,Mon
,Mons
,Months
, ormo
-
Quarter
,Qtr
,Qtrs
,Quarters
, orq
-
Year
,Years
, ory
-
- /Profiles/
<PROFILE>
/Interval/Count -
- Description
-
The number of units to apply in time
- Type
- Undefined values
-
Not permitted
- /Profiles/
<PROFILE>
/Interval/Align -
- Description
-
Align units in logical time
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<PROFILE>
/LatestOnly -
- Description
-
Only upload the latest interval, instead of all detected changed or filled ones
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<PROFILE>
/MaximumAge -
- Description
-
Maximum time in the past to look for the trigger
- Type
- Structure
-
A time interval consists of a time unit, a number of units to apply, and an alignment setting.
- Undefined values
-
Unlimited
- /Profiles/
<PROFILE>
/MaximumAge/Units -
- Description
-
A logical time unit
- Type
- Values
-
This is an enumeration value. It accepts a single string (not case sensitive) from a list of possible choices. Possible values:
-
Millisecond
orMilliseconds
-
Second
,Sec
,Seconds
,Secs
, ors
-
Minute
,Min
,Mins
,Minutes
,m
, ormi
-
Hour
,Hours
, orh
-
Day
,Days
, ord
-
Week
,Weeks
, orw
-
Month
,Mon
,Mons
,Months
, ormo
-
Quarter
,Qtr
,Qtrs
,Quarters
, orq
-
Year
,Years
, ory
-
- /Profiles/
<PROFILE>
/MaximumAge/Count -
- Description
-
The number of units to apply in time
- Type
- Undefined values
-
Not permitted
- /Profiles/
<PROFILE>
/MaximumAge/Align -
- Description
-
Align units in logical time
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<PROFILE>
/Merge -
- Description
-
The maximum time between detected intervals that allows them to be merged into a single output interval
- Type
- Structure
-
A time interval consists of a time unit, a number of units to apply, and an alignment setting.
- Undefined values
-
Do not merge
- /Profiles/
<PROFILE>
/Merge/Units -
- Description
-
A logical time unit
- Type
- Values
-
This is an enumeration value. It accepts a single string (not case sensitive) from a list of possible choices. Possible values:
-
Millisecond
orMilliseconds
-
Second
,Sec
,Seconds
,Secs
, ors
-
Minute
,Min
,Mins
,Minutes
,m
, ormi
-
Hour
,Hours
, orh
-
Day
,Days
, ord
-
Week
,Weeks
, orw
-
Month
,Mon
,Mons
,Months
, ormo
-
Quarter
,Qtr
,Qtrs
,Quarters
, orq
-
Year
,Years
, ory
-
- /Profiles/
<PROFILE>
/Merge/Count -
- Description
-
The number of units to apply in time
- Type
- Undefined values
-
Not permitted
- /Profiles/
<PROFILE>
/Merge/Align -
- Description
-
Align units in logical time
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<PROFILE>
/RecordEvent -
- Description
-
Record and event in the event log when the upload completes
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<PROFILE>
/Split -
- Description
-
The maximum length of an upload interval before it is split
- Type
- Structure
-
A time interval consists of a time unit, a number of units to apply, and an alignment setting.
- Undefined values
-
Do not split
- /Profiles/
<PROFILE>
/Split/Units -
- Description
-
A logical time unit
- Type
- Values
-
This is an enumeration value. It accepts a single string (not case sensitive) from a list of possible choices. Possible values:
-
Millisecond
orMilliseconds
-
Second
,Sec
,Seconds
,Secs
, ors
-
Minute
,Min
,Mins
,Minutes
,m
, ormi
-
Hour
,Hours
, orh
-
Day
,Days
, ord
-
Week
,Weeks
, orw
-
Month
,Mon
,Mons
,Months
, ormo
-
Quarter
,Qtr
,Qtrs
,Quarters
, orq
-
Year
,Years
, ory
-
- /Profiles/
<PROFILE>
/Split/Count -
- Description
-
The number of units to apply in time
- Type
- Undefined values
-
Not permitted
- /Profiles/
<PROFILE>
/Split/Align -
- Description
-
Align units in logical time
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<PROFILE>
/Transfer/AbortOnFailure -
- Description
-
Abort the entire upload on any detected failure
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<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.
- /Profiles/
<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.
- /Profiles/
<PROFILE>
/Transfer/Actions/#0
/#0
/AllowFailure -
- Description
-
Permit failure of the command without aborting uploading
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<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.
- /Profiles/
<PROFILE>
/Transfer/Actions/#0
/#0
/Arguments/#0
-
- Description
-
Command arguments
- Type
- /Profiles/
<PROFILE>
/Transfer/Actions/#0
/#0
/Program -
- Description
-
Program executable
- Type
- /Profiles/
<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.
- /Profiles/
<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.
- /Profiles/
<PROFILE>
/Transfer/After/#0
/#0
/AllowFailure -
- Description
-
Permit failure of the command without aborting uploading
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<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.
- /Profiles/
<PROFILE>
/Transfer/After/#0
/#0
/Arguments/#0
-
- Description
-
Command arguments
- Type
- /Profiles/
<PROFILE>
/Transfer/After/#0
/#0
/Program -
- Description
-
Program executable
- Type
- /Profiles/
<PROFILE>
/Transfer/Batch -
- Description
-
Upload all files in batch mode, instead of one upload per file
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<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.
- /Profiles/
<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.
- /Profiles/
<PROFILE>
/Transfer/Before/#0
/#0
/AllowFailure -
- Description
-
Permit failure of the command without aborting uploading
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<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.
- /Profiles/
<PROFILE>
/Transfer/Before/#0
/#0
/Arguments/#0
-
- Description
-
Command arguments
- Type
- /Profiles/
<PROFILE>
/Transfer/Before/#0
/#0
/Program -
- Description
-
Program executable
- Type
- /Profiles/
<PROFILE>
/Transfer/HaltOnFailure -
- Description
-
Stop uploading subsequent files on failure
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<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
-
- /Profiles/
<PROFILE>
/Transfer/Local/CreateDirectory -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = File
-
- Description
-
Create the output directory if it does not exist
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<PROFILE>
/Transfer/Local/Target -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = File
-
- Description
-
Output target of local files
- Type
- /Profiles/
<PROFILE>
/Transfer/Email/Attachment -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Attachment file name
- Type
- /Profiles/
<PROFILE>
/Transfer/Email/BCC -
- Required conditions
-
-
/Profiles/
<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.
- /Profiles/
<PROFILE>
/Transfer/Email/BCC/#0
-
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Email receiver address
- Type
- /Profiles/
<PROFILE>
/Transfer/Email/Body -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Email message body
- Type
- /Profiles/
<PROFILE>
/Transfer/Email/CC -
- Required conditions
-
-
/Profiles/
<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.
- /Profiles/
<PROFILE>
/Transfer/Email/CC/#0
-
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Email receiver address
- Type
- /Profiles/
<PROFILE>
/Transfer/Email/ContentID -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
ContentID header for the attached files
- Type
- /Profiles/
<PROFILE>
/Transfer/Email/From -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Address to specify as the sender
- Type
- /Profiles/
<PROFILE>
/Transfer/Email/MIMEType -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
MIME type of the attached files
- Type
- Undefined values
-
Inferred from the file extension
- /Profiles/
<PROFILE>
/Transfer/Email/PlainText -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Send the email body in plain text form
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<PROFILE>
/Transfer/Email/Relay/From -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Address to list as in the "From:" header
- Type
- Undefined values
-
Filled by the server
- /Profiles/
<PROFILE>
/Transfer/Email/Relay/Hostname -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Hostname to use as the SMTP relay
- Type
- Undefined values
-
Local program, then direct SMTP connection
- /Profiles/
<PROFILE>
/Transfer/Email/Relay/Password -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Password presented to the relay server
- Type
- /Profiles/
<PROFILE>
/Transfer/Email/Relay/PasswordFile -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
A file to read the SMTP relay password from
- Type
- /Profiles/
<PROFILE>
/Transfer/Email/Relay/Port -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
SMTP relay connection port
- Type
- Valid range
-
1 ≤ value ≤ 65535
- Undefined values
-
Not permitted
- /Profiles/
<PROFILE>
/Transfer/Email/Relay/Program -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Local program used to send an email
- Type
- Undefined values
-
Direct connection if no relay is present
- /Profiles/
<PROFILE>
/Transfer/Email/Relay/TLS -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Use a secured SSL/TLS connection
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<PROFILE>
/Transfer/Email/Relay/Username -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Username presented to the relay server
- Type
- /Profiles/
<PROFILE>
/Transfer/Email/Separate -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Send separate emails for each file being uploaded
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<PROFILE>
/Transfer/Email/Subject -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Email subject
- Type
- /Profiles/
<PROFILE>
/Transfer/Email/Timeout -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Maximum time to wait for the email send to succeed
- Type
- Valid range
-
0.0 < value
- Undefined values
-
Unlimited
- /Profiles/
<PROFILE>
/Transfer/Email/To -
- Required conditions
-
-
/Profiles/
<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.
- /Profiles/
<PROFILE>
/Transfer/Email/To/#0
-
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = EMail
-
- Description
-
Email receiver address
- Type
- /Profiles/
<PROFILE>
/Transfer/URL/PUT -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = URL
-
- Description
-
Use a PUT request instead of a POST
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<PROFILE>
/Transfer/URL/SSL -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = URL
-
- Type
- Structure
-
A SSL specification consists of a hash map defining the parameters for encrypted SSL/TLS connections.
- /Profiles/
<PROFILE>
/Transfer/URL/Target -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = URL
-
- Description
-
Output URL to send files to
- Type
- /Profiles/
<PROFILE>
/Transfer/URL/Timeout -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = URL
-
- Description
-
Maximum time to wait for the request to succeed
- Type
- Valid range
-
0.0 < value
- Undefined values
-
Unlimited
- /Profiles/
<PROFILE>
/Transfer/FTP/ActiveMode -
- Required conditions
-
-
/Profiles/
<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
-
- /Profiles/
<PROFILE>
/Transfer/FTP/CreateDirectory -
- Required conditions
-
-
/Profiles/
<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
- /Profiles/
<PROFILE>
/Transfer/FTP/Hostname -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
FTP server name
- Type
- /Profiles/
<PROFILE>
/Transfer/FTP/ImmediateKeepalive -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
Require immediate responses to keepalives
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<PROFILE>
/Transfer/FTP/KeepAlive -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
Keep alive command interval
- Type
- Valid range
-
0.0 ≤ value
- Units
-
s
- Undefined values
-
Not permitted
- /Profiles/
<PROFILE>
/Transfer/FTP/Password -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
FTP password
- Type
- Undefined values
-
cpd3
- /Profiles/
<PROFILE>
/Transfer/FTP/PasswordFile -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
File to read the FTP password from
- Type
- /Profiles/
<PROFILE>
/Transfer/FTP/Port -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
FTP port to connect on
- Type
- Valid range
-
1 ≤ value ≤ 65535
- Undefined values
-
Not permitted
- /Profiles/
<PROFILE>
/Transfer/FTP/RelaxedIncoming -
- Required conditions
-
-
/Profiles/
<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
- /Profiles/
<PROFILE>
/Transfer/FTP/Resume/Download -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
Enable resume in download mode
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<PROFILE>
/Transfer/FTP/Resume/Retries -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
Maximum number of retries to attempt to resume
- Type
- Valid range
-
0 ≤ value
- Undefined values
-
Not permitted
- /Profiles/
<PROFILE>
/Transfer/FTP/Resume/Upload -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
Enable resume in upload mode
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<PROFILE>
/Transfer/FTP/SSL -
- Required conditions
-
-
/Profiles/
<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.
- /Profiles/
<PROFILE>
/Transfer/FTP/Target -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
Target path to write the uploaded file to on the server
- Type
- /Profiles/
<PROFILE>
/Transfer/FTP/Timeout/Command -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
Command timeout or zero for unlimited
- Type
- Valid range
-
0.0 ≤ value
- Units
-
s
- Undefined values
-
Not permitted
- /Profiles/
<PROFILE>
/Transfer/FTP/Timeout/Total -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
Total operation timeout or zero for unlimited
- Type
- Valid range
-
0.0 ≤ value
- Units
-
s
- Undefined values
-
Not permitted
- /Profiles/
<PROFILE>
/Transfer/FTP/Timeout/Transfer -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
Data transfer timeout or zero for unlimited
- Type
- Valid range
-
0.0 ≤ value
- Units
-
s
- Undefined values
-
Not permitted
- /Profiles/
<PROFILE>
/Transfer/FTP/UploadRateLimit -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
Upload rate limit or zero to disable
- Type
- Valid range
-
0 ≤ value
- Units
-
bytes/s
- /Profiles/
<PROFILE>
/Transfer/FTP/Username -
- Required conditions
-
-
/Profiles/
<PROFILE>
/Transfer/Type = FTP
-
- Description
-
FTP username
- Type
- Undefined values
-
anonymous
- /Profiles/
<PROFILE>
/Trigger -
- Description
-
Upload trigger selection
- 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.
- /Profiles/
<PROFILE>
/Trigger/#0
/Accept -
- Description
-
Accept matched data as passing the filter
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<PROFILE>
/Trigger/#0
/Archive -
- Description
-
The archive to match
- Type
- /Profiles/
<PROFILE>
/Trigger/#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.
- /Profiles/
<PROFILE>
/Trigger/#0
/Flavors/#0
-
- Description
-
A single flavor to match
- Type
- /Profiles/
<PROFILE>
/Trigger/#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.
- /Profiles/
<PROFILE>
/Trigger/#0
/HasFlavors/#0
-
- Description
-
A single flavor to match
- Type
- /Profiles/
<PROFILE>
/Trigger/#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.
- /Profiles/
<PROFILE>
/Trigger/#0
/LacksFlavors/#0
-
- Description
-
A single flavor to match
- Type
- /Profiles/
<PROFILE>
/Trigger/#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
- /Profiles/
<PROFILE>
/Trigger/#0
/Station -
- Description
-
The station to match
- Type
- /Profiles/
<PROFILE>
/Trigger/#0
/Universal -
- Description
-
Apply the operation universally, disregarding other overlapping operations
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Profiles/
<PROFILE>
/Trigger/#0
/Variable -
- Description
-
The variable to match
- Type