SFTP writer

Description

Writes a file to an SFTP server and allows renaming etc of file. If source is not specified, the file is uploaded from the data stream.

note

All server paths are absolute in the "/path/to/directory"-form.

Note that directory paths on server side may be case sensitive.

Impact on Adapterflow data stream: No

SFTP writer as entrypoint

In parameters

Activity 

Name	Type	Description
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.
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.

Authentication

Name	Type	Description
Password	PasswordValue	Specifies a password to enable password authentication. Bindable
Private key file	FilePathValue	File containing client's private key. Specifies a key to enable public key authentication. Note that the file must be accessible at run time. Bindable
Private key password	PasswordValue	Password of the file containing the private key. Bindable
Implicit interactive logon	BoolValue	To be set to True when client needs to support interactive logon. The client will try to resolve server prompts for Username and Password. For more details, see SFTP - General information. Bindable
Interactive logon	NameValueList	To be used when client needs to support interactive logon but cannot implicitly resolve server prompts. Named values where each name/value pair is server prompt and client response. For example username: 'User: ' and 'user001'. Use the Set value to list activity to create a list of named values and bind the InteractiveLogon property to its output. For more details, see SFTP - General information. Bindable

Connection

Name	Type	Description
Server	ActivityComplexValue of StringValue	Name or IP address of SFTP server. Bindable
Port	IntegerValue	Port that the server listens to for incoming connections. Default: 22 Bindable
Server validation	SFTPServerValidation	Specifies how the server is validated. Turning validation off by selecting 'None' is not recommended. The options are: None Public_key(default) Bindable
Servers public key file	FilePathValue	File containing the public ssh key of the server. Used for validating the server. Note that the file must be accessible at run time. Bindable
User	StringValue	User name to use log on to the SFTP server. Bindable

Connection - advanced

Name	Type	Description
Socket timeout	IntegerValue	The socket timeout specifies, in milliseconds, the maximum time of inactivity after which socket operation is cancelled and is considered as expired. A value of 0 implies that operation will never expire. Default: 0 Bindable
Retries	IntegerValue	Number of retries allowed before an error is raised. Default: 0 Bindable
Time between retries	IntegerValue	Time, in seconds, to wait between each retry. Default: 0 Bindable
Upload block size	IntegerValue	Controls the size, in bytes, of the single request for data writing to the remote server. Default: 0, which means "use optimal value". Optimal value is set to 32Kb - 256b since there are servers that do not support larger values. Bindable
Auto adjust transfer block	BoolValue	Specifies whether the block sizes and pipeline length is adjusted for optimal performance. The default value is True, which means that block sizes and pipeline length are adjusted to an optimal value. Default: True. Bindable
Pipeline length	IntegerValue	Specifies the pipeline length, i.e. the number of concurrent read/write operations sent within a single download/upload. A high value will improve performance but will require more resources (memory). Default: 10. Bindable
Force compression	BoolValue	Specifies whether to force compression. True means that the client will explicitly request compression. Default: False Bindable
SFTP Versions	SFTPVersionsValue	Specifies the SFTP versions that can be used during the connection. Default: 2,3,4,5,6 Bindable
Use UTF8	BoolValue	Specifies whether the transfer should use UTF8 for parsing the filename. Bindable
Initialize KEX	BoolValue	Set to True if you want the client to send KEX (key exchange) initialization to the server immediately after the connection is established. Doing so can solve issues with some SFTP servers that expect the client to initialize KEX. Bindable

Connection - HTTP Proxy

Name	Type	Description
Use HTTP proxy	BoolValue	Enables to use SFTP with HTTP proxy. Bindable
Server	ActivityComplexValue of StringValue	Name or IP address of the SOCKS server. Bindable
Port	IntegerValue	Port that the HTTP proxy server listens to for incoming connections. Bindable
Authentication method	HttpProxyAuthentication	What authentication method should be used for the HTTP proxy connection. No authentication Basic authentication Digest Authentication NTLM authentication (Windows Integrated authentication) Bindable
Enable authentication	BoolValue	If set to True, the socks connection will use authentication. Default: False Bindable
Username	StringValue	Username for the HTTP proxy authentication. Bindable
Password	PasswordValue	Password for the HTTP proxy authentication. Bindable

Connection - SOCKS

Name	Type	Description
Use SOCKS	BoolValue	Enables the use of SFTP with SOCKS. True means that communication will go through a SOCKS proxy. Bindable
Server	ActivityComplexValue of StringValue	Name or IP address of the SOCKS server. Bindable
Port	IntegerValue	Port that the SOCKS server listens to for incoming connections. Default: 1080 Bindable
Version	SocksVersionValue	The version of the SOCKS protocol. The options are: Version 4 Version 5 (default) Bindable
Use IPv6	BoolValue	If set to True, SOCKS connection will use IPv6. Default: False Bindable
Resolve address on server	BoolValue	If set to True, the SOCKS server should try to resolve the hostname of the SFTP destination server. Default: False Bindable
Enable authentication	BoolValue	If set to True, the SOCKS connection will use authentication. Default: False Bindable
Username	StringValue	Username for the SOCKS authentication. Bindable
Password	PasswordValue	Password for the SOCKS authentication. 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
Temporary server directory	ActivityComplexValue of SFTPDiretoryValue	Absolute path to 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. Default: False 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 SFTPDirectoryPathValue	Absolute path to 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: ASCII Binary (default) Bindable
Store type	SFTPStoreType	Specifies what to do if a file with the same name already exists. The options are: Overwrite (default) existing files. Append to existing files. Note. see below Skip transfer if file exists. Bindable
Suppress additional operations	BoolValue	Set to True to suppress any additional file operations, which lets you overcome problems which may occur with some SFTP servers. True means all operations except uploading a file are discarded. If the target directory does not exist, an exception is thrown. When set to True, Store type is set to Overwrite. The value is reset after operation. Bindable

note

If Store type is set to Append and the value of Retries is greater than 0, and the attempt to upload the file fails, an error is generated. This will happen because a partial append has been made and it is not possible to restart the append operation from the original position using the SFTP protocol.

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).

See Also

SFTP - General information

SFTP reader