The synchronize
variable in the CONFIGURATION
archive contains the settings controlling bidirectional synchronization.
This includes settings for authorizations, the server, the client, and all file based modes.
The configuration is split into several parts.
In general there are global settings for specific modes (e.g. the client) then a lookup of profile "authorizations".
The authorizations are normally the encryption certificate digests related to a specific instance (e.g. a single person and station combination).
However, they also contain the total profile-like settings for synchronization.
For example the aerosol
authorization can be used by the server to process incoming synchronization for all stations in file based mode.
For peer based modes (e.g. client/server) both ends normally configure an explicit SSL setting. For the client, this includes a certificate authority so it can verify that the server is correct. For the server, it accepts any certificate but requires a station specific authorization restricting the data. The authorization digest used is that of the peer certificate, so the client would have one for the server that permits all raw data and server based configuration files. The server would have one for the authorized client certificate that restricts the data it is allowed to upload and download to the station authorized.
For file based modes (e.g. FTP upload/download) the ends are more asymmetric.
For the server end (the end that processes incoming data for multiple stations), it has a global aerosol
authorization that defines sources for all stations.
It then has specific authorizations for each client restricting their allowed data and setting a specific output file location.
This allows the "download" end of the server to process all incoming authorized data, while each authorization sets its own output encryption.
In this setup, the client has an authorization for the server’s digest that sets that allowed incoming data and the data to send back to the server.
The client then also has global settings defining the source and target of the files, without a specific authorization.
Finally, it also has a global setting to encrypt the files with the server’s certificate.
General Settings
- /AuthorizationTemplates/_
-
- Template Target
-
/Authorization/_
- /Client/Hostname
-
- Description
-
Hostname to connect for synchronization
- Type
- /Client/Port
-
- Description
-
Remote port to connect for synchronization
- Type
- Valid range
-
1 ≤ value ≤ 65535
- Undefined values
-
Not permitted
- /Client/SSL
-
- Type
- Structure
-
A SSL specification consists of a hash map defining the parameters for encrypted SSL/TLS connections.
- /Files/Encryption
-
- Description
-
Certificate used for output file encryption
- Type
- /Files/Sign/Certificate
-
- Description
-
Public certificate used for signing the transfer package
- Type
- /Files/Sign/Key
-
- Description
-
Private key used for signing the transfer package
- Type
- /Files/Sources/HonorModified
-
- Description
-
Explicitly honor the file modified time, even for non-writable sources
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Sources/Match
-
- Description
-
File filter pattern
- 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.
- /Files/Sources/Match/
#0
/CaseSensitive -
- Description
-
Apply the pattern in case sensitive mode
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Sources/Match/
#0
/Pattern -
- Description
-
File pattern to accept
- Type
- /Files/Sources/Minimumage
-
- Description
-
Minimum age of files to accept
- Type
- Structure
-
A time interval consists of a time unit, a number of units to apply, and an alignment setting.
- Undefined values
-
Five minutes
- /Files/Sources/Minimumage/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
-
- /Files/Sources/Minimumage/Count
-
- Description
-
The number of units to apply in time
- Type
- Undefined values
-
Not permitted
- /Files/Sources/Minimumage/Align
-
- Description
-
Align units in logical time
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Sources/PureModifiedTracking
-
- Description
-
Use the modified time only, instead of relying on the source/directory wide timing, if available
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Sources/RequireModified
-
- Description
-
Require a valid modified time
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Sources/TimeContext
-
- Description
-
Access time unique checking context ID
- Type
- /Files/Sources/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
- Download files from a plain FTP server -
Local
- Fetch files from a locally accessible directory -
Single
- Perform a single file fetch -
List
- First acquire a list of files using a single file method, then use that list to actually fetch the files
-
- /Files/Sources/Source
-
- Required conditions
-
-
/Files/Sources/Type = Single
-
- Description
-
File source type
- Type
- Values
-
This is an enumeration value. It accepts a single string (not case sensitive) from a list of possible choices. Possible values:
-
File
orLocal
- Locally accessible file -
GET
- Perform a GET request on a remote server (FTP or HTTP supported) -
POST
- The response to a POST request on a remote server -
PUT
- The response to a PUT request on a remote server -
Process
- Invoked a local command to get the file or contents
-
- /Files/Sources/File
-
- Required conditions
-
-
/Files/Sources/Type = Single
-
/Files/Sources/Type = File
-
- Description
-
Local file name to read from
- Type
- /Files/Sources/Writable
-
- Required conditions
-
-
/Files/Sources/Type = Single
-
/Files/Sources/Type = File
-
- Description
-
Indicate that the local file source supports write access (usually used for moving local files after acquisition)
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Sources/Arguments
-
- Required conditions
-
-
/Files/Sources/Type = Single
-
/Files/Sources/Type = Process
-
- 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.
- /Files/Sources/CaptureOutput
-
- Required conditions
-
-
/Files/Sources/Type = Single
-
/Files/Sources/Type = Process
-
- Description
-
Capture the program standard output and use it as the download result
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Sources/Exit/IgnoreStatus
-
- Required conditions
-
-
/Files/Sources/Type = Single
-
/Files/Sources/Type = Process
-
- Description
-
Ignore abnormal exit status (e.x. crash)
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Sources/Exit/RequireCode
-
- Required conditions
-
-
/Files/Sources/Type = Single
-
/Files/Sources/Type = Process
-
- Description
-
Required exit code for download success
- Type
- Undefined values
-
Any
- /Files/Sources/Literal
-
- Required conditions
-
-
/Files/Sources/Type = Single
-
/Files/Sources/Type = Process
-
- Description
-
Do not process the program result with standard substitutions
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Sources/Program
-
- Required conditions
-
-
/Files/Sources/Type = Single
-
/Files/Sources/Type = Process
-
- Description
-
Program executable
- Type
- /Files/Sources/Data
-
- Required conditions
-
-
/Files/Sources/Type = Single
-
/Files/Sources/Type = POST
-
- Description
-
Data to send with the request
- Type
-
Binary, data are raw bytes
- /Files/Sources/File
-
- Required conditions
-
-
/Files/Sources/Type = Single
-
/Files/Sources/Type = POST
-
- Description
-
URL to send the request to
- Type
- /Files/Sources/Headers
-
- Required conditions
-
-
/Files/Sources/Type = Single
-
/Files/Sources/Type = POST
-
- Description
-
Headers send with the request, keyed on the header name
- Keys
-
The keys immediately below this are unique names selected by the user. These names can be any non-empty text and are generally used to designate different components to be configured. In the paths listed
<IDENTIFIER>
is used as a placeholder to real name selected during configuration.
- /Files/Sources/Headers/
<IDENTIFIER>
-
- Required conditions
-
-
/Files/Sources/Type = Single
-
/Files/Sources/Type = POST
-
- Description
-
Header value
- Type
- /Files/Sources/SSL
-
- Required conditions
-
-
/Files/Sources/Type = Single
-
/Files/Sources/Type = POST
-
- Description
-
SSL parameters for the connection
- Type
- Structure
-
A SSL specification consists of a hash map defining the parameters for encrypted SSL/TLS connections.
- /Files/Sources/Timeout
-
- Required conditions
-
-
/Files/Sources/Type = Single
-
/Files/Sources/Type = POST
-
- Description
-
Maximum request time
- Type
- Valid range
-
0.0 < value
- Units
-
s
- Undefined values
-
Unlimited
- /Files/Sources/Data
-
- Required conditions
-
-
/Files/Sources/Type = Single
-
/Files/Sources/Type = PUT
-
- Description
-
Data to send with the request
- Type
-
Binary, data are raw bytes
- /Files/Sources/File
-
- Required conditions
-
-
/Files/Sources/Type = Single
-
/Files/Sources/Type = PUT
-
- Description
-
URL to send the request to
- Type
- /Files/Sources/Headers
-
- Required conditions
-
-
/Files/Sources/Type = Single
-
/Files/Sources/Type = PUT
-
- Description
-
Headers send with the request, keyed on the header name
- Keys
-
The keys immediately below this are unique names selected by the user. These names can be any non-empty text and are generally used to designate different components to be configured. In the paths listed
<IDENTIFIER>
is used as a placeholder to real name selected during configuration.
- /Files/Sources/Headers/
<IDENTIFIER>
-
- Required conditions
-
-
/Files/Sources/Type = Single
-
/Files/Sources/Type = PUT
-
- Description
-
Header value
- Type
- /Files/Sources/SSL
-
- Required conditions
-
-
/Files/Sources/Type = Single
-
/Files/Sources/Type = PUT
-
- Description
-
SSL parameters for the connection
- Type
- Structure
-
A SSL specification consists of a hash map defining the parameters for encrypted SSL/TLS connections.
- /Files/Sources/Timeout
-
- Required conditions
-
-
/Files/Sources/Type = Single
-
/Files/Sources/Type = PUT
-
- Description
-
Maximum request time
- Type
- Valid range
-
0.0 < value
- Units
-
s
- Undefined values
-
Unlimited
- /Files/Sources/File
-
- Required conditions
-
-
/Files/Sources/Type = Single
-
/Files/Sources/Type = GET
-
- Description
-
URL to send the request to
- Type
- /Files/Sources/Headers
-
- Required conditions
-
-
/Files/Sources/Type = Single
-
/Files/Sources/Type = GET
-
- Description
-
Headers send with the request, keyed on the header name
- Keys
-
The keys immediately below this are unique names selected by the user. These names can be any non-empty text and are generally used to designate different components to be configured. In the paths listed
<IDENTIFIER>
is used as a placeholder to real name selected during configuration.
- /Files/Sources/Headers/
<IDENTIFIER>
-
- Required conditions
-
-
/Files/Sources/Type = Single
-
/Files/Sources/Type = GET
-
- Description
-
Header value
- Type
- /Files/Sources/SSL
-
- Required conditions
-
-
/Files/Sources/Type = Single
-
/Files/Sources/Type = GET
-
- Description
-
SSL parameters for the connection
- Type
- Structure
-
A SSL specification consists of a hash map defining the parameters for encrypted SSL/TLS connections.
- /Files/Sources/Timeout
-
- Required conditions
-
-
/Files/Sources/Type = Single
-
/Files/Sources/Type = GET
-
- Description
-
Maximum request time
- Type
- Valid range
-
0.0 < value
- Units
-
s
- Undefined values
-
Unlimited
- /Files/Sources/Fetch/Source
-
- Required conditions
-
-
/Files/Sources/Type = List
-
- Description
-
File source type
- Type
- Values
-
This is an enumeration value. It accepts a single string (not case sensitive) from a list of possible choices. Possible values:
-
File
orLocal
- Locally accessible file -
GET
- Perform a GET request on a remote server (FTP or HTTP supported) -
POST
- The response to a POST request on a remote server -
PUT
- The response to a PUT request on a remote server -
Process
- Invoked a local command to get the file or contents
-
- /Files/Sources/Fetch/Writable
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Fetch/Type = File
-
- Description
-
Indicate that the local file source supports write access (usually used for moving local files after acquisition)
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Sources/Fetch/Arguments
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Fetch/Type = Process
-
- Description
-
Arguments passed to the executable with the listed line appended to them
- 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.
- /Files/Sources/Fetch/CaptureOutput
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Fetch/Type = Process
-
- Description
-
Capture the program standard output and use it as the download result
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Sources/Fetch/Exit/IgnoreStatus
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Fetch/Type = Process
-
- Description
-
Ignore abnormal exit status (e.x. crash)
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Sources/Fetch/Exit/RequireCode
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Fetch/Type = Process
-
- Description
-
Required exit code for download success
- Type
- Undefined values
-
Any
- /Files/Sources/Fetch/Literal
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Fetch/Type = Process
-
- Description
-
Do not process the program result with standard substitutions
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Sources/Fetch/Program
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Fetch/Type = Process
-
- Description
-
Program executable
- Type
- /Files/Sources/Fetch/Data
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Fetch/Type = POST
-
- Description
-
Data to send with the request
- Type
-
Binary, data are raw bytes
- /Files/Sources/Fetch/Headers
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Fetch/Type = POST
-
- Description
-
Headers send with the request, keyed on the header name
- Keys
-
The keys immediately below this are unique names selected by the user. These names can be any non-empty text and are generally used to designate different components to be configured. In the paths listed
<IDENTIFIER>
is used as a placeholder to real name selected during configuration.
- /Files/Sources/Fetch/Headers/
<IDENTIFIER>
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Fetch/Type = POST
-
- Description
-
Header value
- Type
- /Files/Sources/Fetch/SSL
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Fetch/Type = POST
-
- Description
-
SSL parameters for the connection
- Type
- Structure
-
A SSL specification consists of a hash map defining the parameters for encrypted SSL/TLS connections.
- /Files/Sources/Fetch/Timeout
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Fetch/Type = POST
-
- Description
-
Maximum request time
- Type
- Valid range
-
0.0 < value
- Units
-
s
- Undefined values
-
Unlimited
- /Files/Sources/Fetch/Data
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Fetch/Type = PUT
-
- Description
-
Data to send with the request
- Type
-
Binary, data are raw bytes
- /Files/Sources/Fetch/Headers
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Fetch/Type = PUT
-
- Description
-
Headers send with the request, keyed on the header name
- Keys
-
The keys immediately below this are unique names selected by the user. These names can be any non-empty text and are generally used to designate different components to be configured. In the paths listed
<IDENTIFIER>
is used as a placeholder to real name selected during configuration.
- /Files/Sources/Fetch/Headers/
<IDENTIFIER>
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Fetch/Type = PUT
-
- Description
-
Header value
- Type
- /Files/Sources/Fetch/SSL
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Fetch/Type = PUT
-
- Description
-
SSL parameters for the connection
- Type
- Structure
-
A SSL specification consists of a hash map defining the parameters for encrypted SSL/TLS connections.
- /Files/Sources/Fetch/Timeout
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Fetch/Type = PUT
-
- Description
-
Maximum request time
- Type
- Valid range
-
0.0 < value
- Units
-
s
- Undefined values
-
Unlimited
- /Files/Sources/Fetch/Headers
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Fetch/Type = GET
-
- Description
-
Headers send with the request, keyed on the header name
- Keys
-
The keys immediately below this are unique names selected by the user. These names can be any non-empty text and are generally used to designate different components to be configured. In the paths listed
<IDENTIFIER>
is used as a placeholder to real name selected during configuration.
- /Files/Sources/Fetch/Headers/
<IDENTIFIER>
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Fetch/Type = GET
-
- Description
-
Header value
- Type
- /Files/Sources/Fetch/SSL
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Fetch/Type = GET
-
- Description
-
SSL parameters for the connection
- Type
- Structure
-
A SSL specification consists of a hash map defining the parameters for encrypted SSL/TLS connections.
- /Files/Sources/Fetch/Timeout
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Fetch/Type = GET
-
- Description
-
Maximum request time
- Type
- Valid range
-
0.0 < value
- Units
-
s
- Undefined values
-
Unlimited
- /Files/Sources/Source
-
- Required conditions
-
-
/Files/Sources/Type = List
-
- Description
-
File source type
- Type
- Values
-
This is an enumeration value. It accepts a single string (not case sensitive) from a list of possible choices. Possible values:
-
File
orLocal
- Locally accessible file -
GET
- Perform a GET request on a remote server (FTP or HTTP supported) -
POST
- The response to a POST request on a remote server -
PUT
- The response to a PUT request on a remote server -
Process
- Invoked a local command to get the file or contents
-
- /Files/Sources/File
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Type = File
-
- Description
-
Local file name to read from
- Type
- /Files/Sources/Writable
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Type = File
-
- Description
-
Indicate that the local file source supports write access (usually used for moving local files after acquisition)
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Sources/Arguments
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Type = Process
-
- 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.
- /Files/Sources/CaptureOutput
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Type = Process
-
- Description
-
Capture the program standard output and use it as the download result
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Sources/Exit/IgnoreStatus
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Type = Process
-
- Description
-
Ignore abnormal exit status (e.x. crash)
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Sources/Exit/RequireCode
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Type = Process
-
- Description
-
Required exit code for download success
- Type
- Undefined values
-
Any
- /Files/Sources/Literal
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Type = Process
-
- Description
-
Do not process the program result with standard substitutions
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Sources/Program
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Type = Process
-
- Description
-
Program executable
- Type
- /Files/Sources/Data
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Type = POST
-
- Description
-
Data to send with the request
- Type
-
Binary, data are raw bytes
- /Files/Sources/File
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Type = POST
-
- Description
-
URL to send the request to
- Type
- /Files/Sources/Headers
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Type = POST
-
- Description
-
Headers send with the request, keyed on the header name
- Keys
-
The keys immediately below this are unique names selected by the user. These names can be any non-empty text and are generally used to designate different components to be configured. In the paths listed
<IDENTIFIER>
is used as a placeholder to real name selected during configuration.
- /Files/Sources/Headers/
<IDENTIFIER>
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Type = POST
-
- Description
-
Header value
- Type
- /Files/Sources/SSL
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Type = POST
-
- Description
-
SSL parameters for the connection
- Type
- Structure
-
A SSL specification consists of a hash map defining the parameters for encrypted SSL/TLS connections.
- /Files/Sources/Timeout
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Type = POST
-
- Description
-
Maximum request time
- Type
- Valid range
-
0.0 < value
- Units
-
s
- Undefined values
-
Unlimited
- /Files/Sources/Data
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Type = PUT
-
- Description
-
Data to send with the request
- Type
-
Binary, data are raw bytes
- /Files/Sources/File
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Type = PUT
-
- Description
-
URL to send the request to
- Type
- /Files/Sources/Headers
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Type = PUT
-
- Description
-
Headers send with the request, keyed on the header name
- Keys
-
The keys immediately below this are unique names selected by the user. These names can be any non-empty text and are generally used to designate different components to be configured. In the paths listed
<IDENTIFIER>
is used as a placeholder to real name selected during configuration.
- /Files/Sources/Headers/
<IDENTIFIER>
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Type = PUT
-
- Description
-
Header value
- Type
- /Files/Sources/SSL
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Type = PUT
-
- Description
-
SSL parameters for the connection
- Type
- Structure
-
A SSL specification consists of a hash map defining the parameters for encrypted SSL/TLS connections.
- /Files/Sources/Timeout
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Type = PUT
-
- Description
-
Maximum request time
- Type
- Valid range
-
0.0 < value
- Units
-
s
- Undefined values
-
Unlimited
- /Files/Sources/File
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Type = GET
-
- Description
-
URL to send the request to
- Type
- /Files/Sources/Headers
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Type = GET
-
- Description
-
Headers send with the request, keyed on the header name
- Keys
-
The keys immediately below this are unique names selected by the user. These names can be any non-empty text and are generally used to designate different components to be configured. In the paths listed
<IDENTIFIER>
is used as a placeholder to real name selected during configuration.
- /Files/Sources/Headers/
<IDENTIFIER>
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Type = GET
-
- Description
-
Header value
- Type
- /Files/Sources/SSL
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Type = GET
-
- Description
-
SSL parameters for the connection
- Type
- Structure
-
A SSL specification consists of a hash map defining the parameters for encrypted SSL/TLS connections.
- /Files/Sources/Timeout
-
- Required conditions
-
-
/Files/Sources/Type = List
-
/Files/Sources/Type = GET
-
- Description
-
Maximum request time
- Type
- Valid range
-
0.0 < value
- Units
-
s
- Undefined values
-
Unlimited
- /Files/Sources/ActiveMode
-
- Required conditions
-
-
/Files/Sources/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
-
- /Files/Sources/Hostname
-
- Required conditions
-
-
/Files/Sources/Type = FTP
-
- Description
-
FTP server name
- Type
- /Files/Sources/ImmediateKeepalive
-
- Required conditions
-
-
/Files/Sources/Type = FTP
-
- Description
-
Require immediate responses to keepalives
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Sources/KeepAlive
-
- Required conditions
-
-
/Files/Sources/Type = FTP
-
- Description
-
Keep alive command interval
- Type
- Valid range
-
0.0 ≤ value
- Units
-
s
- Undefined values
-
Not permitted
- /Files/Sources/MatchPath
-
- Required conditions
-
-
/Files/Sources/Type = FTP
-
- Description
-
Path filter patterns, in depth order
- 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.
- /Files/Sources/MatchPath/
#0
/CaseSensitive -
- Required conditions
-
-
/Files/Sources/Type = FTP
-
- Description
-
Apply the pattern in case sensitive mode
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Sources/MatchPath/
#0
/Pattern -
- Required conditions
-
-
/Files/Sources/Type = FTP
-
- Description
-
File pattern to accept
- Type
- /Files/Sources/Password
-
- Required conditions
-
-
/Files/Sources/Type = FTP
-
- Description
-
FTP password
- Type
- Undefined values
-
cpd3
- /Files/Sources/PasswordFile
-
- Required conditions
-
-
/Files/Sources/Type = FTP
-
- Description
-
File to read the FTP password from
- Type
- /Files/Sources/Path
-
- Required conditions
-
-
/Files/Sources/Type = FTP
-
- Description
-
Root FTP path before pattern depth walk
- Type
- /Files/Sources/Port
-
- Required conditions
-
-
/Files/Sources/Type = FTP
-
- Description
-
FTP port to connect on
- Type
- Valid range
-
1 ≤ value ≤ 65535
- Undefined values
-
Not permitted
- /Files/Sources/Recursive
-
- Required conditions
-
-
/Files/Sources/Type = FTP
-
- Description
-
Recurse all directories at the final level
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Sources/RelaxedIncoming
-
- Required conditions
-
-
/Files/Sources/Type = FTP
-
- Description
-
Do not check the incoming server and port in active mode
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Sources/Resume/Download
-
- Required conditions
-
-
/Files/Sources/Type = FTP
-
- Description
-
Enable resume in download mode
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Sources/Resume/Retries
-
- Required conditions
-
-
/Files/Sources/Type = FTP
-
- Description
-
Maximum number of retries to attempt to resume
- Type
- Valid range
-
0 ≤ value
- Undefined values
-
Not permitted
- /Files/Sources/Resume/Upload
-
- Required conditions
-
-
/Files/Sources/Type = FTP
-
- Description
-
Enable resume in upload mode
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Sources/SSL
-
- Required conditions
-
-
/Files/Sources/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.
- /Files/Sources/Timeout/Command
-
- Required conditions
-
-
/Files/Sources/Type = FTP
-
- Description
-
Command timeout or zero for unlimited
- Type
- Valid range
-
0.0 ≤ value
- Units
-
s
- Undefined values
-
Not permitted
- /Files/Sources/Timeout/Total
-
- Required conditions
-
-
/Files/Sources/Type = FTP
-
- Description
-
Total operation timeout or zero for unlimited
- Type
- Valid range
-
0.0 ≤ value
- Units
-
s
- Undefined values
-
Not permitted
- /Files/Sources/Timeout/Transfer
-
- Required conditions
-
-
/Files/Sources/Type = FTP
-
- Description
-
Data transfer timeout or zero for unlimited
- Type
- Valid range
-
0.0 ≤ value
- Units
-
s
- Undefined values
-
Not permitted
- /Files/Sources/UploadRateLimit
-
- Required conditions
-
-
/Files/Sources/Type = FTP
-
- Description
-
Upload rate limit or zero to disable
- Type
- Valid range
-
0 ≤ value
- Units
-
bytes/s
- /Files/Sources/Username
-
- Required conditions
-
-
/Files/Sources/Type = FTP
-
- Description
-
FTP username
- Type
- Undefined values
-
anonymous
- /Files/Sources/IgnoreReadableFlag
-
- Required conditions
-
-
/Files/Sources/Type = Local
-
- Description
-
Ignore the filesystem specified readable flag in transversal (in the event that ACLs allow reading anyway)
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Sources/MatchPath
-
- Required conditions
-
-
/Files/Sources/Type = Local
-
- Description
-
Path filter patterns, in depth order
- 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.
- /Files/Sources/MatchPath/
#0
/CaseSensitive -
- Required conditions
-
-
/Files/Sources/Type = Local
-
- Description
-
Apply the pattern in case sensitive mode
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Sources/MatchPath/
#0
/Pattern -
- Required conditions
-
-
/Files/Sources/Type = Local
-
- Description
-
File pattern to accept
- Type
- /Files/Sources/Path
-
- Required conditions
-
-
/Files/Sources/Type = Local
-
- Description
-
Root local path before pattern depth walk
- Type
- /Files/Sources/Recursive
-
- Required conditions
-
-
/Files/Sources/Type = Local
-
- Description
-
Recurse all directories at the final level
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Sources/Writable
-
- Required conditions
-
-
/Files/Sources/Type = Local
-
- Description
-
Indicate that the local file source supports write access (usually used for moving local files after acquisition)
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/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.
- /Files/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.
- /Files/Transfer/Actions/
#0
/#0
/AllowFailure -
- Description
-
Permit failure of the command without aborting uploading
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/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.
- /Files/Transfer/Actions/
#0
/#0
/Arguments/#0
-
- Description
-
Command arguments
- Type
- /Files/Transfer/Actions/
#0
/#0
/Program -
- Description
-
Program executable
- Type
- /Files/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.
- /Files/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.
- /Files/Transfer/After/
#0
/#0
/AllowFailure -
- Description
-
Permit failure of the command without aborting uploading
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/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.
- /Files/Transfer/After/
#0
/#0
/Arguments/#0
-
- Description
-
Command arguments
- Type
- /Files/Transfer/After/
#0
/#0
/Program -
- Description
-
Program executable
- Type
- /Files/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.
- /Files/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.
- /Files/Transfer/Before/
#0
/#0
/AllowFailure -
- Description
-
Permit failure of the command without aborting uploading
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/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.
- /Files/Transfer/Before/
#0
/#0
/Arguments/#0
-
- Description
-
Command arguments
- Type
- /Files/Transfer/Before/
#0
/#0
/Program -
- Description
-
Program executable
- Type
- /Files/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
-
- /Files/Transfer/Local/CreateDirectory
-
- Required conditions
-
-
/Files/Transfer/Type = File
-
- Description
-
Create the output directory if it does not exist
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Transfer/Local/Target
-
- Required conditions
-
-
/Files/Transfer/Type = File
-
- Description
-
Output target of local files
- Type
- /Files/Transfer/Email/Attachment
-
- Required conditions
-
-
/Files/Transfer/Type = EMail
-
- Description
-
Attachment file name
- Type
- /Files/Transfer/Email/BCC
-
- Required conditions
-
-
/Files/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.
- /Files/Transfer/Email/BCC/
#0
-
- Required conditions
-
-
/Files/Transfer/Type = EMail
-
- Description
-
Email receiver address
- Type
- /Files/Transfer/Email/Body
-
- Required conditions
-
-
/Files/Transfer/Type = EMail
-
- Description
-
Email message body
- Type
- /Files/Transfer/Email/CC
-
- Required conditions
-
-
/Files/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.
- /Files/Transfer/Email/CC/
#0
-
- Required conditions
-
-
/Files/Transfer/Type = EMail
-
- Description
-
Email receiver address
- Type
- /Files/Transfer/Email/ContentID
-
- Required conditions
-
-
/Files/Transfer/Type = EMail
-
- Description
-
ContentID header for the attached files
- Type
- /Files/Transfer/Email/From
-
- Required conditions
-
-
/Files/Transfer/Type = EMail
-
- Description
-
Address to specify as the sender
- Type
- /Files/Transfer/Email/MIMEType
-
- Required conditions
-
-
/Files/Transfer/Type = EMail
-
- Description
-
MIME type of the attached files
- Type
- Undefined values
-
Inferred from the file extension
- /Files/Transfer/Email/PlainText
-
- Required conditions
-
-
/Files/Transfer/Type = EMail
-
- Description
-
Send the email body in plain text form
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Transfer/Email/Relay/From
-
- Required conditions
-
-
/Files/Transfer/Type = EMail
-
- Description
-
Address to list as in the "From:" header
- Type
- Undefined values
-
Filled by the server
- /Files/Transfer/Email/Relay/Hostname
-
- Required conditions
-
-
/Files/Transfer/Type = EMail
-
- Description
-
Hostname to use as the SMTP relay
- Type
- Undefined values
-
Local program, then direct SMTP connection
- /Files/Transfer/Email/Relay/Password
-
- Required conditions
-
-
/Files/Transfer/Type = EMail
-
- Description
-
Password presented to the relay server
- Type
- /Files/Transfer/Email/Relay/PasswordFile
-
- Required conditions
-
-
/Files/Transfer/Type = EMail
-
- Description
-
A file to read the SMTP relay password from
- Type
- /Files/Transfer/Email/Relay/Port
-
- Required conditions
-
-
/Files/Transfer/Type = EMail
-
- Description
-
SMTP relay connection port
- Type
- Valid range
-
1 ≤ value ≤ 65535
- Undefined values
-
Not permitted
- /Files/Transfer/Email/Relay/Program
-
- Required conditions
-
-
/Files/Transfer/Type = EMail
-
- Description
-
Local program used to send an email
- Type
- Undefined values
-
Direct connection if no relay is present
- /Files/Transfer/Email/Relay/TLS
-
- Required conditions
-
-
/Files/Transfer/Type = EMail
-
- Description
-
Use a secured SSL/TLS connection
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Transfer/Email/Relay/Username
-
- Required conditions
-
-
/Files/Transfer/Type = EMail
-
- Description
-
Username presented to the relay server
- Type
- /Files/Transfer/Email/Separate
-
- Required conditions
-
-
/Files/Transfer/Type = EMail
-
- Description
-
Send separate emails for each file being uploaded
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Transfer/Email/Subject
-
- Required conditions
-
-
/Files/Transfer/Type = EMail
-
- Description
-
Email subject
- Type
- /Files/Transfer/Email/Timeout
-
- Required conditions
-
-
/Files/Transfer/Type = EMail
-
- Description
-
Maximum time to wait for the email send to succeed
- Type
- Valid range
-
0.0 < value
- Undefined values
-
Unlimited
- /Files/Transfer/Email/To
-
- Required conditions
-
-
/Files/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.
- /Files/Transfer/Email/To/
#0
-
- Required conditions
-
-
/Files/Transfer/Type = EMail
-
- Description
-
Email receiver address
- Type
- /Files/Transfer/URL/PUT
-
- Required conditions
-
-
/Files/Transfer/Type = URL
-
- Description
-
Use a PUT request instead of a POST
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Transfer/URL/SSL
-
- Required conditions
-
-
/Files/Transfer/Type = URL
-
- Type
- Structure
-
A SSL specification consists of a hash map defining the parameters for encrypted SSL/TLS connections.
- /Files/Transfer/URL/Target
-
- Required conditions
-
-
/Files/Transfer/Type = URL
-
- Description
-
Output URL to send files to
- Type
- /Files/Transfer/URL/Timeout
-
- Required conditions
-
-
/Files/Transfer/Type = URL
-
- Description
-
Maximum time to wait for the request to succeed
- Type
- Valid range
-
0.0 < value
- Undefined values
-
Unlimited
- /Files/Transfer/FTP/ActiveMode
-
- Required conditions
-
-
/Files/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
-
- /Files/Transfer/FTP/CreateDirectory
-
- Required conditions
-
-
/Files/Transfer/Type = FTP
-
- Description
-
Create the directory on the server if it does not exist
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Transfer/FTP/Hostname
-
- Required conditions
-
-
/Files/Transfer/Type = FTP
-
- Description
-
FTP server name
- Type
- /Files/Transfer/FTP/ImmediateKeepalive
-
- Required conditions
-
-
/Files/Transfer/Type = FTP
-
- Description
-
Require immediate responses to keepalives
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Transfer/FTP/KeepAlive
-
- Required conditions
-
-
/Files/Transfer/Type = FTP
-
- Description
-
Keep alive command interval
- Type
- Valid range
-
0.0 ≤ value
- Units
-
s
- Undefined values
-
Not permitted
- /Files/Transfer/FTP/Password
-
- Required conditions
-
-
/Files/Transfer/Type = FTP
-
- Description
-
FTP password
- Type
- Undefined values
-
cpd3
- /Files/Transfer/FTP/PasswordFile
-
- Required conditions
-
-
/Files/Transfer/Type = FTP
-
- Description
-
File to read the FTP password from
- Type
- /Files/Transfer/FTP/Port
-
- Required conditions
-
-
/Files/Transfer/Type = FTP
-
- Description
-
FTP port to connect on
- Type
- Valid range
-
1 ≤ value ≤ 65535
- Undefined values
-
Not permitted
- /Files/Transfer/FTP/RelaxedIncoming
-
- Required conditions
-
-
/Files/Transfer/Type = FTP
-
- Description
-
Do not check the incoming server and port in active mode
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Transfer/FTP/Resume/Download
-
- Required conditions
-
-
/Files/Transfer/Type = FTP
-
- Description
-
Enable resume in download mode
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Transfer/FTP/Resume/Retries
-
- Required conditions
-
-
/Files/Transfer/Type = FTP
-
- Description
-
Maximum number of retries to attempt to resume
- Type
- Valid range
-
0 ≤ value
- Undefined values
-
Not permitted
- /Files/Transfer/FTP/Resume/Upload
-
- Required conditions
-
-
/Files/Transfer/Type = FTP
-
- Description
-
Enable resume in upload mode
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Files/Transfer/FTP/SSL
-
- Required conditions
-
-
/Files/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.
- /Files/Transfer/FTP/Target
-
- Required conditions
-
-
/Files/Transfer/Type = FTP
-
- Description
-
Target path to write the uploaded file to on the server
- Type
- /Files/Transfer/FTP/Timeout/Command
-
- Required conditions
-
-
/Files/Transfer/Type = FTP
-
- Description
-
Command timeout or zero for unlimited
- Type
- Valid range
-
0.0 ≤ value
- Units
-
s
- Undefined values
-
Not permitted
- /Files/Transfer/FTP/Timeout/Total
-
- Required conditions
-
-
/Files/Transfer/Type = FTP
-
- Description
-
Total operation timeout or zero for unlimited
- Type
- Valid range
-
0.0 ≤ value
- Units
-
s
- Undefined values
-
Not permitted
- /Files/Transfer/FTP/Timeout/Transfer
-
- Required conditions
-
-
/Files/Transfer/Type = FTP
-
- Description
-
Data transfer timeout or zero for unlimited
- Type
- Valid range
-
0.0 ≤ value
- Units
-
s
- Undefined values
-
Not permitted
- /Files/Transfer/FTP/UploadRateLimit
-
- Required conditions
-
-
/Files/Transfer/Type = FTP
-
- Description
-
Upload rate limit or zero to disable
- Type
- Valid range
-
0 ≤ value
- Units
-
bytes/s
- /Files/Transfer/FTP/Username
-
- Required conditions
-
-
/Files/Transfer/Type = FTP
-
- Description
-
FTP username
- Type
- Undefined values
-
anonymous
- /Processing/Authorize/AdditionalEmail
-
- Description
-
Additional recipients of the confirmation email, in addition to the request originator
- 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.
- /Processing/Authorize/AdditionalEmail/
#0
-
- Description
-
A recipient of the email
- Type
- /Processing/Authorize/DigestActions
-
- Description
-
Actions taken when adding a specific authorization digest
- 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.
- /Processing/Authorize/DigestActions/
#0
/Type -
- Description
-
The type of actopm performed
- Type
- /Processing/Authorize/DigestActions/
#0
/Arguments -
- Required conditions
-
-
/Processing/Authorize/DigestActions/
#0
/Type = Program
-
- 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.
- /Processing/Authorize/DigestActions/
#0
/Arguments/#0
-
- Required conditions
-
-
/Processing/Authorize/DigestActions/
#0
/Type = Program
-
- Description
-
Command arguments
- Type
- /Processing/Authorize/DigestActions/
#0
/Program -
- Required conditions
-
-
/Processing/Authorize/DigestActions/
#0
/Type = Program
-
- Description
-
Program executable
- Type
- /Processing/Authorize/DigestActions/
#0
/Name -
- Required conditions
-
-
/Processing/Authorize/DigestActions/
#0
/Type = Component
-
- Description
-
The component to execute as an action
- Type
- /Processing/Authorize/DisableEmail
-
- Description
-
Do not send the email when an authorization has been added
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Processing/Authorize/GlobalActions
-
- Description
-
Actions taken before any authorization 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.
- /Processing/Authorize/GlobalActions/
#0
/Type -
- Description
-
The type of actopm performed
- Type
- /Processing/Authorize/GlobalActions/
#0
/Arguments -
- Required conditions
-
-
/Processing/Authorize/GlobalActions/
#0
/Type = Program
-
- 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.
- /Processing/Authorize/GlobalActions/
#0
/Arguments/#0
-
- Required conditions
-
-
/Processing/Authorize/GlobalActions/
#0
/Type = Program
-
- Description
-
Command arguments
- Type
- /Processing/Authorize/GlobalActions/
#0
/Program -
- Required conditions
-
-
/Processing/Authorize/GlobalActions/
#0
/Type = Program
-
- Description
-
Program executable
- Type
- /Processing/Authorize/GlobalActions/
#0
/Name -
- Required conditions
-
-
/Processing/Authorize/GlobalActions/
#0
/Type = Component
-
- Description
-
The component to execute as an action
- Type
- /Processing/Authorize/Relay/From
-
- Description
-
Address to list as in the "From:" header
- Type
- Undefined values
-
Filled by the server
- /Processing/Authorize/Relay/Hostname
-
- Description
-
Hostname to use as the SMTP relay
- Type
- Undefined values
-
Local program, then direct SMTP connection
- /Processing/Authorize/Relay/Password
-
- Description
-
Password presented to the relay server
- Type
- /Processing/Authorize/Relay/PasswordFile
-
- Description
-
A file to read the SMTP relay password from
- Type
- /Processing/Authorize/Relay/Port
-
- Description
-
SMTP relay connection port
- Type
- Valid range
-
1 ≤ value ≤ 65535
- Undefined values
-
Not permitted
- /Processing/Authorize/Relay/Program
-
- Description
-
Local program used to send an email
- Type
- Undefined values
-
Direct connection if no relay is present
- /Processing/Authorize/Relay/TLS
-
- Description
-
Use a secured SSL/TLS connection
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Processing/Authorize/Relay/Username
-
- Description
-
Username presented to the relay server
- Type
- /Processing/Authorize/StationActions
-
- Description
-
Actions taken in the context of authorizing a station
- 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.
- /Processing/Authorize/StationActions/
#0
/Type -
- Description
-
The type of actopm performed
- Type
- /Processing/Authorize/StationActions/
#0
/Arguments -
- Required conditions
-
-
/Processing/Authorize/StationActions/
#0
/Type = Program
-
- 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.
- /Processing/Authorize/StationActions/
#0
/Arguments/#0
-
- Required conditions
-
-
/Processing/Authorize/StationActions/
#0
/Type = Program
-
- Description
-
Command arguments
- Type
- /Processing/Authorize/StationActions/
#0
/Program -
- Required conditions
-
-
/Processing/Authorize/StationActions/
#0
/Type = Program
-
- Description
-
Program executable
- Type
- /Processing/Authorize/StationActions/
#0
/Name -
- Required conditions
-
-
/Processing/Authorize/StationActions/
#0
/Type = Component
-
- Description
-
The component to execute as an action
- Type
- /Processing/Authorize/Text
-
- Description
-
Email body text
- Type
- Undefined values
-
The default confirmation email
- /Processing/Request/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.
- /Processing/Request/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.
- /Processing/Request/Transfer/Actions/
#0
/#0
/AllowFailure -
- Description
-
Permit failure of the command without aborting uploading
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Processing/Request/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.
- /Processing/Request/Transfer/Actions/
#0
/#0
/Arguments/#0
-
- Description
-
Command arguments
- Type
- /Processing/Request/Transfer/Actions/
#0
/#0
/Program -
- Description
-
Program executable
- Type
- /Processing/Request/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.
- /Processing/Request/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.
- /Processing/Request/Transfer/After/
#0
/#0
/AllowFailure -
- Description
-
Permit failure of the command without aborting uploading
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Processing/Request/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.
- /Processing/Request/Transfer/After/
#0
/#0
/Arguments/#0
-
- Description
-
Command arguments
- Type
- /Processing/Request/Transfer/After/
#0
/#0
/Program -
- Description
-
Program executable
- Type
- /Processing/Request/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.
- /Processing/Request/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.
- /Processing/Request/Transfer/Before/
#0
/#0
/AllowFailure -
- Description
-
Permit failure of the command without aborting uploading
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Processing/Request/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.
- /Processing/Request/Transfer/Before/
#0
/#0
/Arguments/#0
-
- Description
-
Command arguments
- Type
- /Processing/Request/Transfer/Before/
#0
/#0
/Program -
- Description
-
Program executable
- Type
- /Processing/Request/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
-
- /Processing/Request/Transfer/Local/CreateDirectory
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = File
-
- Description
-
Create the output directory if it does not exist
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Processing/Request/Transfer/Local/Target
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = File
-
- Description
-
Output target of local files
- Type
- /Processing/Request/Transfer/Email/Attachment
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = EMail
-
- Description
-
Attachment file name
- Type
- /Processing/Request/Transfer/Email/BCC
-
- Required conditions
-
-
/Processing/Request/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.
- /Processing/Request/Transfer/Email/BCC/
#0
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = EMail
-
- Description
-
Email receiver address
- Type
- /Processing/Request/Transfer/Email/Body
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = EMail
-
- Description
-
Email message body
- Type
- /Processing/Request/Transfer/Email/CC
-
- Required conditions
-
-
/Processing/Request/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.
- /Processing/Request/Transfer/Email/CC/
#0
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = EMail
-
- Description
-
Email receiver address
- Type
- /Processing/Request/Transfer/Email/ContentID
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = EMail
-
- Description
-
ContentID header for the attached files
- Type
- /Processing/Request/Transfer/Email/From
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = EMail
-
- Description
-
Address to specify as the sender
- Type
- /Processing/Request/Transfer/Email/MIMEType
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = EMail
-
- Description
-
MIME type of the attached files
- Type
- Undefined values
-
Inferred from the file extension
- /Processing/Request/Transfer/Email/PlainText
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = EMail
-
- Description
-
Send the email body in plain text form
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Processing/Request/Transfer/Email/Relay/From
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = EMail
-
- Description
-
Address to list as in the "From:" header
- Type
- Undefined values
-
Filled by the server
- /Processing/Request/Transfer/Email/Relay/Hostname
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = EMail
-
- Description
-
Hostname to use as the SMTP relay
- Type
- Undefined values
-
Local program, then direct SMTP connection
- /Processing/Request/Transfer/Email/Relay/Password
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = EMail
-
- Description
-
Password presented to the relay server
- Type
- /Processing/Request/Transfer/Email/Relay/PasswordFile
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = EMail
-
- Description
-
A file to read the SMTP relay password from
- Type
- /Processing/Request/Transfer/Email/Relay/Port
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = EMail
-
- Description
-
SMTP relay connection port
- Type
- Valid range
-
1 ≤ value ≤ 65535
- Undefined values
-
Not permitted
- /Processing/Request/Transfer/Email/Relay/Program
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = EMail
-
- Description
-
Local program used to send an email
- Type
- Undefined values
-
Direct connection if no relay is present
- /Processing/Request/Transfer/Email/Relay/TLS
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = EMail
-
- Description
-
Use a secured SSL/TLS connection
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Processing/Request/Transfer/Email/Relay/Username
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = EMail
-
- Description
-
Username presented to the relay server
- Type
- /Processing/Request/Transfer/Email/Separate
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = EMail
-
- Description
-
Send separate emails for each file being uploaded
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Processing/Request/Transfer/Email/Subject
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = EMail
-
- Description
-
Email subject
- Type
- /Processing/Request/Transfer/Email/Timeout
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = EMail
-
- Description
-
Maximum time to wait for the email send to succeed
- Type
- Valid range
-
0.0 < value
- Undefined values
-
Unlimited
- /Processing/Request/Transfer/Email/To
-
- Required conditions
-
-
/Processing/Request/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.
- /Processing/Request/Transfer/Email/To/
#0
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = EMail
-
- Description
-
Email receiver address
- Type
- /Processing/Request/Transfer/URL/PUT
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = URL
-
- Description
-
Use a PUT request instead of a POST
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Processing/Request/Transfer/URL/SSL
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = URL
-
- Type
- Structure
-
A SSL specification consists of a hash map defining the parameters for encrypted SSL/TLS connections.
- /Processing/Request/Transfer/URL/Target
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = URL
-
- Description
-
Output URL to send files to
- Type
- /Processing/Request/Transfer/URL/Timeout
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = URL
-
- Description
-
Maximum time to wait for the request to succeed
- Type
- Valid range
-
0.0 < value
- Undefined values
-
Unlimited
- /Processing/Request/Transfer/FTP/ActiveMode
-
- Required conditions
-
-
/Processing/Request/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
-
- /Processing/Request/Transfer/FTP/CreateDirectory
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = FTP
-
- Description
-
Create the directory on the server if it does not exist
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Processing/Request/Transfer/FTP/Hostname
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = FTP
-
- Description
-
FTP server name
- Type
- /Processing/Request/Transfer/FTP/ImmediateKeepalive
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = FTP
-
- Description
-
Require immediate responses to keepalives
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Processing/Request/Transfer/FTP/KeepAlive
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = FTP
-
- Description
-
Keep alive command interval
- Type
- Valid range
-
0.0 ≤ value
- Units
-
s
- Undefined values
-
Not permitted
- /Processing/Request/Transfer/FTP/Password
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = FTP
-
- Description
-
FTP password
- Type
- Undefined values
-
cpd3
- /Processing/Request/Transfer/FTP/PasswordFile
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = FTP
-
- Description
-
File to read the FTP password from
- Type
- /Processing/Request/Transfer/FTP/Port
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = FTP
-
- Description
-
FTP port to connect on
- Type
- Valid range
-
1 ≤ value ≤ 65535
- Undefined values
-
Not permitted
- /Processing/Request/Transfer/FTP/RelaxedIncoming
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = FTP
-
- Description
-
Do not check the incoming server and port in active mode
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Processing/Request/Transfer/FTP/Resume/Download
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = FTP
-
- Description
-
Enable resume in download mode
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Processing/Request/Transfer/FTP/Resume/Retries
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = FTP
-
- Description
-
Maximum number of retries to attempt to resume
- Type
- Valid range
-
0 ≤ value
- Undefined values
-
Not permitted
- /Processing/Request/Transfer/FTP/Resume/Upload
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = FTP
-
- Description
-
Enable resume in upload mode
- Type
-
Boolean, values are
TRUE
orFALSE
and defaults toFALSE
- /Processing/Request/Transfer/FTP/SSL
-
- Required conditions
-
-
/Processing/Request/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.
- /Processing/Request/Transfer/FTP/Target
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = FTP
-
- Description
-
Target path to write the uploaded file to on the server
- Type
- /Processing/Request/Transfer/FTP/Timeout/Command
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = FTP
-
- Description
-
Command timeout or zero for unlimited
- Type
- Valid range
-
0.0 ≤ value
- Units
-
s
- Undefined values
-
Not permitted
- /Processing/Request/Transfer/FTP/Timeout/Total
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = FTP
-
- Description
-
Total operation timeout or zero for unlimited
- Type
- Valid range
-
0.0 ≤ value
- Units
-
s
- Undefined values
-
Not permitted
- /Processing/Request/Transfer/FTP/Timeout/Transfer
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = FTP
-
- Description
-
Data transfer timeout or zero for unlimited
- Type
- Valid range
-
0.0 ≤ value
- Units
-
s
- Undefined values
-
Not permitted
- /Processing/Request/Transfer/FTP/UploadRateLimit
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = FTP
-
- Description
-
Upload rate limit or zero to disable
- Type
- Valid range
-
0 ≤ value
- Units
-
bytes/s
- /Processing/Request/Transfer/FTP/Username
-
- Required conditions
-
-
/Processing/Request/Transfer/Type = FTP
-
- Description
-
FTP username
- Type
- Undefined values
-
anonymous
- /Server/ListenAddress
-
- Description
-
The local address of the network interface to listen on
- Type
- Undefined values
-
All network interfaces
- /Server/Port
-
- Description
-
Local port number to listen on
- Type
- Valid range
-
1 ≤ value ≤ 65535
- Undefined values
-
Not permitted
- /Server/SSL
-
- Type
- Structure
-
A SSL specification consists of a hash map defining the parameters for encrypted SSL/TLS connections.