FTP(S) writer
Writes a file to an FTP server and allows renaming etc of file. If source is not specified, the file is uploaded from the data stream.
Impact on Adapterflow data stream: No
Remark
Note that directory paths on server side may be case sensitive.
In parameters
Activity
| Name | Type | Description |
|---|---|---|
| Enabled | BoolValue | Specifies whether the activity is to be enabled or not. Only enabled activities are validated and executed. |
| Description | StringValue | Description of the activity. |
| Name | StringValue | Name of the activity. The name has to be unique in the workflow. The name is used as identifier of the activity in activity binding. |
Connection
| Name | Type | Description |
|---|---|---|
| Server | ActivityComplexValue of StringValue | Name or IP address of server to connect to. Bindable. |
| Port | IntegerValue | Port to be used for connection. Default: 21 Bindable. |
| User | StringValue | User name to be used to log on to the account on the FTP server. Bindable. |
| Password | PasswordValue | Password to be used to log on to the account on the FTP server. Bindable. |
Connection - advanced
| Name | Type | Description |
|---|---|---|
| Passive FTP mode | BoolValue | Specifies whether passive FTP mode is to be used. True means it will be used (Default). Bindable. |
| Connection timeout | IntegerValue | A connection time period (in milliseconds) that applies to:
Bindable. |
| List method | FtpListMethod | The list command sent to the server. If the server supports MLSD, this option is recommended. Default: MLSD Bindable. |
| List entry format | ListEntryFormat | Specifies interpretation of list entries received from server. Bindable. |
| Server directory separator | StringValue | Character used by server to separate directories. Default: / Bindable. |
| Retries | IntegerValue | Number of times the activity will retry to issue a failed command before an error occurs. Default: 0 Bindable. |
| Time between retries | IntegerValue | Time in seconds to wait between each retry. Default: 0 Bindable. |
| Trace | BoolValue | Enables/disables tracing of sent and received FTP commands to a file. True means tracing is enabled. Default: False Bindable. |
| Trace file | ActivityComplexValue of FilePathValue | The file where traced commands are to be saved. Bindable. |
| Ignore error codes | StringValue | Specifies error codes (not specified by the FTP protocol) that may be returned from the FTP server when listing files and there are no files to return. The specified error codes will be ignored when returned. Fill in codes to be ignored as comma separated list. Example: 500, 503, 550 Bindable. |
| List is case sensitive | BoolValue | Specifies whether file lists are handled as case sensitive. True means lists will be case sensitive. Bindable |
| Remote code page | CodePageIDValue | Specifies the code page/charset to be used by the remote server. If not specified, 20127 (US-ASCII) is used. Bindable. |
| Buffer size | IntegerValue | Specifies the buffer size when sending data to the server. The value is specified in bytes. Default: 262144 Bindable. |
| Account info (ACCT) | StringValue | Specifies account info to be sent using ACCT command. Bindable. |
| Speed limit | IntegerValue | Specifies the maximum number of bytes per second that may be sent to the server. A value of 0 (zero) means unlimited. Default: 0 Bindable. |
| Use IPv6 | BoolValue | Specifies if IPv6 should be used for communication with the server. Default: False Bindable. |
| Use FEAT | BoolValue | Specifies if FEAT Command should be used for determining which features are implemented by the server. Default: True Bindable. |
| Virtual host name | StringValue | Specifies the name of the host to send using the HOST command. Bindable. |
Connection - SSL
| Name | Type | Description |
|---|---|---|
| Encrypt data channel | BoolValue | Specifies whether encryption of data channel is to be enabled. True means encryption is enabled. Default: False. Bindable. |
| Use SSL | BoolValue | Specifies whether SSL is to be enabled. True means SSL is enabled. Default: False Bindable. |
| Auth command | FtpAuthorizationCommand | Authorization command to be sent to server to request an explicit SSL session. Options are:
|
| Versions | SSLTLSVersionsValue | SSL/TLS version to be used. More than one option can be selected. Default is TLS 1.3, TLS 1.2. For more information, see General information about SSL and TLS. Bindable. |
| SSL mode | SSLMode | Specifies whether explicit or implicit SSL mode is to be used. Default: Implicit Bindable. |
| Certificate | CertificateValue | The client certificate that the server may request. Use browser button to select certificate. To list all available stores, you may need to start the Adapterflow Wizard with elevated privileges. When the Adapterflow is executed, the service must have the appropriate privileges to access the certificate. For more information, see Troubleshooting. Bindable. |
| Use SSL Session Resumption | BoolValue | Specifies if SSL Session Resumption should be used. Default: False Bindable. |
Connection - SSL Certificate validation
| Name | Type | Description |
|---|---|---|
| Trusted storage | CertStoreValue | The certificate storage containing trusted certificates for validation of server certificate, located in Windows system certificate storages. Use browser to select trusted storage. To list all available stores, you may need to start the Adapterflow Wizard with elevated privileges. When the Adapterflow is executed, the service must have the appropriate privileges to access the certificate. For more information, Troubleshooting. Bindable. |
| Host role | FTPSHostRole | The role of the remote host. The Host role is validated when the remote host sends its certificate to the client for validation. Options are:
|
| Enable | BoolValue | Enables/disables validation of remote servers certificate. Disabling validation implies that all received certificates will be accepted without any validation. Default: True Bindable. |
| Options | ServerCertificateValidationOptionsValue | Specifies the validation errors to be ignored. Options are:
|
| Use system storages | BoolValue | Specifies whether Windows system storages will be used during validation. If set to True, Windows system stores will be used when searching for CA and root certificates and when checking if certificate is trusted of blocked. If set to False you have to specify a trusted store through the Trusted storage property. It is possible to specify an additional trusted store besides the stores in the Windows system storages that are considered trusted. Note that it is likely that validation will be slower when using system stores. Default: True Bindable. |
Server side
| Name | Type | Description |
|---|---|---|
| Create temporary file | BoolValue | Specifies whether the file is to be uploaded to a temporary file and then renamed when the upload is complete. True means a temporary file will be created. Default: False Bindable. Note: If there is an existing file with the same name as the temporary file, the activity will fail. |
| Temporary server directory | ActivityComplexValue of FTPSDirectoryPathValue | Temporary directory where the file is to be initially uploaded. Note: The directory path may be case sensitive. Bindable. |
| Temporary extension | ActivityComplexValue of StringValue | Temporary extension to be initially given to the file. if left empty, the file will keep its original extension. Bindable. |
| File size check | BoolValue | Specifies whether the size of the uploaded file is to be compared to the source file when upload is complete. Bindable. |
Standard
| Name | Type | Description |
|---|---|---|
| Source file name | ActivityComplexValue of FilePathValue | Name and full path of file to be uploaded (source file). If left empty, data stream is uploaded. Bindable. |
| Destination directory | ActivityComplexValue of FTPSDirectoryPathValue | Directory where the file is to be uploaded. Note: The directory path may be case sensitive. Bindable. |
| Destination file name | ActivityComplexValue of StringValue | Name that the uploaded file is to get. If left empty, the file will keep its original name. Bindable. |
| Transfer type | FtpTransferMode | Specifies how data is to be transferred. The options are:
|
| Store type | FTPSStoreMode | Specifies what to do if a file with the same name already exists. Options are:
Bindable Note 1: The Store type options refer to the Destination file, and not the temporary file (if such is being used). Note 2: Under very special circumstances, when Overwrite or Append is used in combination with Create temporary file, there might be a slight risk of losing the original file on the server. |
Remark
If Store type is set to 'Append' and the value of Retries is greater than, 0 the first attempt to upload the file will be made using the APPE ftp command. If this attempt fails, any subsequent retry-attempts for this operation will send a REST command followed by the STOR command to the server to attempt to resume the append operation from the original end of the file, ignoring any data that was appended in the failed attempt. This requires that the FTP-server supports the REST command in conjunction with the STOR command.
Out parameters
| Name | Type | Description |
|---|---|---|
| Local filepath Out | FilePathValue | The full path to the file on the client. |
| Local filename Out | FilePathValue | The name of the file on the client (no directory path). |
| Server filepath Out | FilePathValue | The full path to the file on the server. |
| Sever filename Out | FilePathValue | The name of the file on the server (no directory path). |