Script API Ftp - AnalyticsGate/AGR-OnPrem-Setups GitHub Wiki
active
Description
Switch delivery to the file system on or off.
Required: Yes
Default: false
Example
active: true
host
Description
The FTP server to connect to.
Required: Yes
Example
host: demo.example.com
username
Description
The username used to connect to the FTP server.
Note: Connection via Anonymous will not be allowed.
Required: Yes
Example
userName: myusername
password
Description
The password used to connect to the FTP server. The password can also be encrypted in the future.
Required: Yes
Example
password: Test$123456
encryptionMode
Description
The encryption mode when the "useSsl" parameter is enabled. The following values can be specified: None, Implicit, Explicit.
Default: None
Example
encryptionMode: Implicit
useSsl
Description
Turning on encryption by certificate via FTPS.
Default: false
Example
useSsl: true
port
Description
The port used to connect to the FTP server.
Default: 21
Example
port: 990
remotePath
Description
The delivery path on the FTP server.
Required: Yes
Example
remotePath: /Test
mode
Description
The delivery mode, the following modes are possible. CreateOnly: Creating a new report is allowed. This report may not overwrite an existing report. Overwrite: New creation of a report is allowed. This report may even overwrite an existing report. DeleteAllFirst: Creation of a new report is allowed. An already existing report is deleted first.
Required: Yes
Default: createOnly
Example
mode: DeleteAllFirst
useBase64Password
Description
If an "outputPassword” with encrypted Base64-text is to be used, this parameter must be set to "true”.
Default: false
Example
useBase64Password: true
encryptType
Description
Sets the encryption algorithm. The possible choice is AES256 or RSA256.
- Long texts can only be encrypted with AES256.
- With RSA you can encrypt only up to 64 characters.
Default: RSA256
Example
encryptType: AES256