July 30, 2023

tSCPFileList – Docs for ESB 7.x

tSCPFileList

Lists files from the defined SCP server.

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

tSCPFileList Standard properties

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
click the relevant connection component to reuse
the connection details you already defined.

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

 

Specify the listening port number of the SCP server.

 

Fill in the user name to access the SCP server.

 

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

 

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.

 

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.

 

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.

 

Specify the character used to separate multiple commands.

 

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.

Related scenario

For a related scenario using a different protocol, see Listing and getting files/folders on an FTP directory.


Document get from Talend https://help.talend.com
Thank you for watching.
Subscribe
Notify of
guest
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x