Hitachi Vantara Pentaho Community Wiki
Child pages
  • Get a file with SFTP
Skip to end of metadata
Go to start of metadata

Description

Use the Get a file with SFTP job entry to retrieve one or more files from an FTP server using the Secure FTP protocol.

Options

General Tab

Option

Description

Job entry name

The name of the job entry. This name has to be unique in a single job. A job entry can be placed several times on the canvas, however it will be the same job entry.

SFTP-server name / IP

The name of the SFTP server or the IP address

Port

The TCP port to use. This is usually 22

User name

The user name to log into the SFTP server

Password

The password to log into the SFTP server

Use private keyfile

Indicates whether or not a private keyfile is to be used.

Private key filename

If "Use private keyfile" is checked then this field is enabled. The file can be browsed to using the browse button to the right of the field.  The Private Key should be in the PEM file format.  For PuTTY-based Private Keys, use PuTTYgen to convert the file into "OpenSSH" format.

Key passphrase

If "Use private keyfile" is checked then this field is enabled. If a passphrase is required then enter it here.

Remote directory

The remote directory on the SFTP server from which we get the files

Target directory

The directory on the machine on which Kettle runs in which you want to place the transferred files

Wildcard

Specify a regular expression here if you want to select multiple files. For example: 

.*txt$   : get all text files
A.*[ENG:0-9].txt  : files tarting with A ending with a number and .txt


|

Remove files after retrieval?

Remove the files after they have been successfully transferred. 

Files Tab

Source (remote) files

Option

Description

Copy previous results to args

If files to send are dynamically generated by another transformation or if you want to identify files to sent, check this option. 
PDI will select files list from previous result rows (not result files) and send theses files.

Remote Directory

The remote directory on the SFTP server from which we get the files. Use the "test folder" button to connect to the remote server and validate that the folder exists.

Wildcard (regular expression)

Specify a regular expression here if you want to select multiple files. For example:

 {code}
 .*txt$   : get all text files
A.*[ENG:0-9].txt  : files tarting with A, ending with a number and .txt
{code}

Remove files after retrieval

Delete the remote file after the file is transferred.



Target (local) files

Option

Description

Target Directory

The directory on the machine on which Kettle runs in which you want to place the transferred files

Create target folder

Check this option if the destination folder does not exist and should be created.

Add filenames to result

{code}
If checked the name of the file is added to the result stream.
{code}



  • No labels