SFTP connector

When to use this connector

Use this connector to create Flows that work with files in SFTP.

Create a Connection

Step 1. In the Connections window, click +, and select Files. 

Step 2. Select SFTP.

Step 3. Enter Connection parameters.

Connection parameters

• URL: the hostname and optional port of the SFTP server.
• Change current remote directory to: if this parameter is set, the connector will cd to this specific directory after connecting the SFTP site. It is useful if you want to access a folder from a level or two back from the home folder.  
• Directory: the directory with files. This parameter is optional.
• Files: the actual file name or a wildcard file name, for example, *.csv.
• User: username.
• Password: password.
• Private Key File: private key file in the pem or ppk Format used for SSH authentication. Click Upload SSH key to manage SSH keys using GUI. You can also upload the Private Key File manually and use the token {app.data} as a part of the filename, for example, {app.data}/keys/secret.pem. This parameter is optional.

• Passphrase: a passphrase (password) used together with a Private Key File. This parameter is optional.
• Other parameters: additional configuration options for the SFTP connection. 
• Add Suffix When Creating Files in Transformation: you can select one of the predefined suffixes for the files created using this Connection. For example, if you select uuid as a suffix and the original file name is dest.csv, Etlworks Integrator will create files with the name dest_uuid.csv, where uuid is a globally unique identifier such as 21EC2020-3AEA-4069-A2DD-08002B30309D.

This parameter works only when the file is created using source-to-destination-transformation. Read how to add a suffix to the files created when copying, moving, renaming, and zipping files.

• Enable Wildcard File Name: if there are multiple source files in a folder, you can specify an algorithm which will be used to select the next source file to process. For example, if Files is set to *.csv and oldest is selected, Etlworks Integrator will always select the oldest file in the folder which matches the wildcard *.csv.
• Override Wildcard File Name set for Connection: if Wildcard File Names are allowed, Override Wildcard File Name set for Connection is enabled, and the file name entered in the FROM field of the transformation is a wildcard file name, the system will override the file name entered at the Connection level. Otherwise, the default behavior is to use the wildcard file name entered when the Connection was configured.

Decryption

When SFTP Connection is used as a source (FROM) in the source-to-destination transformation, it is possible to configure the automatic decryption of the encrypted source files using the PGP algorithm and private key uploaded to the secure key storage.

If the private key is available, all source files processed by the transformation will be automatically decrypted using the PGP algorithm and given key.  Note that the private key requires a password. 

Read how to generate a pair of public/private keys.