tRouteOutput - 6.3

Talend Components Reference Guide

EnrichVersion
6.3
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

Warning

This component is relevant only when used with one of the Talend solutions with ESB, as it should be used with the Service Repository node and the Data Service creation related wizard(s).

Function

tRouteOutput sends messages from a Job to a Route.

Purpose

tRouteOutput allows you to exchange messages between a Data Integration Job and a Mediation Route.

tRouteOutput properties

Component family

ESB/Route

 

Basic settings

Output Schema

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

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: No property data stored centrally.

 

 

Repository: Select the Repository file where Properties are stored.

 

Camel

Enter the message parameters corresponding to the columns you defined in the schema dialog box via the Edit schema button.

 

Type

Select between:

Body: Used to set the body of a Route, equals the code exchange.getOut().setBody(...).

Property: Used to set the property of a Route, equals the code exchange.setProperty(name, value).

System: Used to set the system property, equals the code System.setProperty(name, value).

Header: Used the set the output header, equals the code exchange.getOut().setHeader(name, value).

 

Name

This column is used to set the name for the parameter when its type is either Property, System or Header. This column is ignored when the type is Body.

Advanced settings

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 

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

This component can be used as the end component and thus requires an input component. It is mandatory that a tRouteInput component is used in the Data Integration Job to be called by a Route using the cTalendJob component. The reason for it is that this will prevent the referenced Job from starting automatically when deployed in Talend Runtime. Instead it will only start when it gets called by the Route. For more information about how to use the cTalendJob component, see Talend ESB Mediation Components Reference Guide.

Limitation

The Job using a tRouteOutput must be launched only within a Route using the cTalendJob component.

Related scenario

For a scenario in which tRouteOutput is used, see Scenario: Exchanging messages between a Job and a Route.