tSCPFileList - 6.1

Talend Components Reference Guide

EnrichVersion
6.1
EnrichProdName
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for Big Data
Talend Open Studio for Data Integration
Talend Open Studio for Data Quality
Talend Open Studio for ESB
Talend Open Studio for MDM
Talend Real-Time Big Data Platform
task
Data Governance
Data Quality and Preparation
Design and Development
EnrichPlatform
Talend Studio

tSCPFileList properties

Component family

Internet/SCP

 

Function

This component iterates, over a fully encrypted channel, on files in a given directory on a remote host.

Purpose

This component allows you to list files from the defined SCP server.

Basic settings

Use an existing connection

Select this check box and in the Component List click the relevant connection component to reuse the connection details you already defined.

Host

Specify the host name or IP address of the SCP server.

Port

Specify the listening port number of the SCP server.

Username

Fill in the user name to access the SCP server.

Authentication method

Select one of the SCP authentication methods from the drop-down list, Public key, Password, or Keyboard Interactive.

Password

Enter the password to access the SCP server.

To enter the password, click the [...] button next to the password field, and then in the pop-up dialog box enter the password between double quotes and click OK to save the settings.

This field appears only when Password or Keyboard Interactive is selected from the Authentication method drop-down list.

Key Passphrase

Enter the passphrase for the public key.

To enter the passphrase, click the [...] button next to the passphrase field, and then in the pop-up dialog box enter the passphrase between double quotes and click OK to save the settings.

This field appears only when Public key is selected from the Authentication method drop-down list.

Private key

Browse to or type in the path to the private key.

This field appears only when Public key is selected from the Authentication method drop-down list.

Command Separator

Specify the character used to separate multiple commands.

Filelist

Click the [+] button to add a command or a set of commands to list files in a given directory on the SCP server.

Global Variables

CURRENT_LINE: the file currently being iterated upon. This is a Flow variable and it returns a string.

ERROR_MESSAGE: the error message generated by the component when an error occurs. This is an After variable and it returns a string. This variable functions only if the Die on error check box is cleared, if the component has this check box.

NB_LINE: the number of files iterated upon so far. This is a Flow variable and it returns an integer.

STATUS: the execution result of the component. This is an After variable and it returns a string.

A Flow variable functions during the execution of a component while an After variable functions after the execution of the component.

To fill up a field or expression with a variable, press Ctrl + Space to access the variable list and choose the variable to use from it.

For further information about variables, see Talend Studio User Guide.

Usage

This component can be used as a single-component sub-job or used with other components.

This component is particularly useful when used with tSCPGet to get multiple files in a directory given that tSCPGet does not support wildcarding.

Log4j

If you are using a subscription-based version of the Studio, the activity of this component can be logged using the log4j feature. For more information on this feature, see Talend Studio User Guide.

For more information on the log4j logging levels, see the Apache documentation at http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/Level.html.

Limitation

n/a

Related scenario

For a related scenario using a different protocol, see Scenario: Iterating on a remote directory.