If you can't find the product or version you're looking for, visit support.ataccama.com/downloads

SFTP Download File

Downloads a remote file or directory from the specified host via the SFTP protocol.

Properties

Name Type Description Expression support

Name	Type	Description	Expression support
File or Directory	mandatory	Remote path to the file or directory for download. A directory is downloaded into the Target Directory including its files (without recursion).	semi-expression
Url Resource	mandatory	Name of the Runtime Configuration to be used. Make sure the `UrlResource` has basic authentication configured.	semi-expression
Private Key Path	mandatory unless `password` in the `UrlResource` is specified	Local path to the private key for SSH authentication.	semi-expression
Known Hosts Path	optional	Local path to the known hosts file.	semi-expression
Target Directory	mandatory	Path to the destination directory. The directory can be local, on Amazon S3 or Azure Data Lake Storage Gen1 server and on HDFS (if your product contains ONE Spark DPE). The remote resources are accessible with the `resource://<resourceName>/<path>/<inputFile>` syntax.	semi-expression
Session Parameters	optional	Set of parameters to customize a JSch session.	none

File or Directory

mandatory

Remote path to the file or directory for download. A directory is downloaded into the Target Directory including its files (without recursion).

semi-expression

Url Resource

mandatory

Name of the Runtime Configuration to be used. Make sure the UrlResource has basic authentication configured.

semi-expression

Private Key Path

mandatory unless password in the UrlResource is specified

Local path to the private key for SSH authentication.

semi-expression

Known Hosts Path

optional

Local path to the known hosts file.

semi-expression

Target Directory

mandatory

Path to the destination directory. The directory can be local, on Amazon S3 or Azure Data Lake Storage Gen1 server and on HDFS (if your product contains ONE Spark DPE). The remote resources are accessible with the resource://<resourceName>/<path>/<inputFile> syntax.

semi-expression

Session Parameters

optional

Set of parameters to customize a JSch session.

none

Session parameters properties

Name	Type	Description	Expression support
Name	mandatory	Parameter name.	none
Value	mandatory	Parameter value.	none

Name

Type

Description

Expression support

Name

mandatory

Parameter name.

none

Value

mandatory

Parameter value.

none

Example

Sample

<executable class="com.ataccama.adt.task.exec.SFTPDownloadFile">
  <file>/data/source.csv</file>
  <urlResource>ConfiguredServer1</urlResource>
  <targetDirectory>/home/user/target</targetDirectory>
</executable>

Was this page useful?