tSCPFileList Standard properties - 7.3

SCP

Version
7.3
Language
English
Product
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 Real-Time Big Data Platform
Module
Talend Studio
Content
Data Governance > Third-party systems > Internet components (Integration) > File Transfer Protocols > SCP components
Data Quality and Preparation > Third-party systems > Internet components (Integration) > File Transfer Protocols > SCP components
Design and Development > Third-party systems > Internet components (Integration) > File Transfer Protocols > SCP components
Last publication date
2024-02-21

These properties are used to configure tSCPFileList running in the Standard Job framework.

The Standard tSCPFileList component belongs to the Internet family.

The component in this framework is available in all Talend products.

Basic settings

Use an existing connection

Select this check box and in the Component List drop-down list, select the desired connection component to reuse the connection details you already defined.

Note: When a Job contains the parent Job and the child Job, if you need to share an existing connection between the two levels, for example, to share the connection created by the parent Job with the child Job, you have to:
  1. In the parent level, register the database connection to be shared in the Basic settings view of the connection component which creates that very database connection.

  2. In the child level, use a dedicated connection component to read that registered database connection.

For an example about how to share a database connection across Job levels, see Talend Studio User Guide.

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.

Advanced settings

tStatCatcher Statistics

Select this check box to collect log data at the component level.

Global Variables

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

Usage rule

This component can be used as a single-component subJob 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.