tNamedPipeOutput Standard properties

NamedPipe

author
Talend Documentation Team
EnrichVersion
6.4
EnrichProdName
Talend Open Studio for ESB
Talend Open Studio for MDM
Talend Data Integration
Talend MDM Platform
Talend Open Studio for Data Integration
Talend Real-Time Big Data Platform
Talend ESB
Talend Open Studio for Big Data
Talend Data Services Platform
Talend Data Fabric
Talend Big Data Platform
Talend Big Data
Talend Data Management Platform
task
Data Quality and Preparation > Third-party systems > File components (Integration) > NamedPipe components
Data Governance > Third-party systems > File components (Integration) > NamedPipe components
Design and Development > Third-party systems > File components (Integration) > NamedPipe components
EnrichPlatform
Talend Studio

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

The Standard tNamedPipeOutput component belongs to the File family.

The component in this framework is generally available.

Basic settings

Use existing pipe connection

Select this check box to use an existing named-pipe in the Pipe component list, or clear this check box to specify a named-pipe in Pipe name field.

Pipe component

Select an existing named-pipe component from the list.

Note:

This check box will display only when you select Use existing pipe connection.

Pipe name

Fill in the field with the name of an existing named-pipe.

Note:

This check box will display only when you clear Use existing pipe connection.

Row separator

String (ex: "\n"on Unix) to distinguish rows in the output file.

Field separator

Character, string or regular expression to separate fields of the output file.

CSV options

Select this check box to take into account all parameters specific to CSV files, in particular Escape char and Text enclosure parameters.

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.

Since version 5.6, both the Built-In mode and the Repository mode are available in any of the Talend solutions.

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 previous component connected in the Job.

 

Built-in: The schema will be created and stored locally for this component only. Related topic: see Talend Studio User Guide.

 

Repository: The schema already exists and is stored in the Repository, hence can be reused in various projects and Job flowcharts. Related topic: see Talend Studio User Guide.

Delete pipe if it exists

Select this check box to avoid duplicate named-pipe.

Advanced settings

Boolean type

Select a boolean type from the list.

tStatCatcher Statistics

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

Global Variables

Global Variables

NB_LINE: the number of rows read by an input component or transferred to an output component. This is a Flow variable and it returns an integer.

PIPE_NAME: the name of the named-pipe. This is a Flow variable and it returns a string.

PIPE_NATIVE_NAME: the native name of the named-pipe. This is a Flow variable and it returns a string.

PIPE_OUTPUTSTREAM: the output stream of the named-pipe. This is a Flow variable and it returns an object.

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.

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 is usually connected to another component in a subjob that reads data from a source.

Dynamic settings

Click the [+] button to add a row in the table and fill the Code field with a context variable to choose your pipe connection dynamically from multiple connections planned in your Job.

The Dynamic settings table is available only when the Use existing pipe connection check box is selected in the Basic settings view. When a dynamic parameter is defined, the Pipe component list box in the Basic settings view becomes unusable.

For examples on using dynamic parameters, see Scenario: Reading data from databases through context-based dynamic connections and Scenario: Reading data from different MySQL databases using dynamically loaded connection parameters. For more information on Dynamic settings and context variables, see Talend Studio User Guide.

Limitation

Due to license incompatibility, one or more JARs required to use this component are not provided. You can install the missing JARs for this particular component by clicking the Install button on the Component tab view. You can also find out and add all missing JARs easily on the Modules tab in the Integration perspective of your studio. For details, see Installing external modules.