tSSH Standard properties

Schema and Edit Schema

A schema is a row description, it defines the number of fields to be processed and passed on to the next component. The schema is either Built-in or stored remotely in the Repository.

• Built-in: You create and store the schema locally for this component only. Related topic: see Talend Studio User Guide.
• Repository: You have already created the schema and stored it in the Repository. You can reuse it in various projects and Job flowcharts. Related topic: see Talend Studio User Guide.

Click Edit schema to make changes to the schema. If the current schema is of the Repository type, three options are available:

• View schema: choose this option to view the schema only.

• Change to built-in property: choose this option to change the schema to Built-in for local changes.

• Update repository connection: choose this option to change the schema stored in the repository and decide whether to propagate the changes to all the Jobs upon completion. If you just want to propagate the changes to the current Job, you can select No upon completion and choose this schema metadata again in the Repository Content window.

Click Sync columns to retrieve the schema from the preceding component in the Job.

Host

IP address

Port

Listening port number

User

User authentication information

Authentication method

Select the authentication method to be used: Public key, Password, or Keyboard Interactive.

• Public key: Enter the path to the private key and the passphrase for the key in the Private key and Key Passphrase fields correspondingly. To enter the passphrase, click the [...] button next to the Key Passphrase field, enter the passphrase between double quotes in the pop-up dialog box, and click OK to save the settings.

• Password: Enter the password required. To enter the password, click the [...] button next to the Password field, enter the password in double quotes in the pop-up dialog box, and click OK to save the settings.

• Keyboard Interactive: Enter the required password in the Password field. To enter the password, click the [...] button next to the Password field, enter the password in double quotes in the pop-up dialog box, and click OK to save the settings.

Pseudo terminal

Select this check box to call the interactive shell that performs the terminal operations.

Command separator

Type in the command separator required. Once the Pseudo terminal check box is selected, this field becomes unavailable.

Commands

Type in the command for the relevant information to be returned from the remote computer. When you select the Pseudo terminal check box, this table becomes a terminal emulator and each row in this table is a single command.

Use timeout/timeout in seconds

Define the timeout time period. A timeout message will be generated if the actual response time exceeds this expected processing time.

Standard Output

Select the destination to which the standard output is returned. The output may be returned to:

- to console: the output is displayed in the console of the Run view.

- to global variable: the output is indicated by the corresponding global variable.

- both to console and global variable: the output is indicated both of the two means.

- normal: the output is a standard ssh output.

Error Output

Select the destination to which the error output is returned. The output may be returned to:

- to console: the output is displayed in the console of the Run view.

- to global variable: the output is indicated by the corresponding global variable.

- both to console and global variable: the output is indicated both of the two means.

- normal: the output is a standard ssh output.

tStatCatcher Statistics

Select this check box to gather the processing metadata at the Job level as well as at each component level.

Global Variables

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.

STDOUT: the standard execution output of the remote command. This is an After variable and it returns a string.

STDERR: the error execution output of the remote command. This is an After variable and it returns a string.

EXIT_CODE: the exit code of the remote command. This is an After variable and it returns an integer.

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 rule

This component can be used as standalone component.

Note that for some sensitive information such as password and username, you can define the context variables in the Contexts tab and press Ctrl + Space to access them.

Connections

Outgoing links (from this component to another):

Row: Main

Trigger: Run if; On Component Ok; On Component Error; On Subjob Ok; On Subjob Error.

Incoming links (from one component to this one):

Row: Main; Iterate

Trigger: Run if; On Component Ok; On Component Error; On Subjob Ok; On Subjob Error.

For further information regarding connections, see Talend Studio User Guide.

Limitation

The component use is optimized for Unix-like systems.