tGroovyFile - 6.1

Talend Components Reference Guide

English (United States)
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
Talend Studio
Data Governance
Data Quality and Preparation
Design and Development

tGroovyFile properties

Component Family

Custom Code



tGroovyFile allows you to call an existing Groovy script.


tGroovyFile broadens the functionality of Talend Jobs using the Groovy language which is a simplified Java syntax.

Basic settings

Groovy File

Name and path of the file containing the Groovy code.



This table contains two columns.

Name: Name of the variable called in the code.

Value: Value associated with this variable.

Advanced settings

tStatCatcher Statistics

Select this check box to collect the log data at 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.


This component can be used alone or as a sub-job along with another component.


Knowledge of the Groovy language is required.

Scenario: Calling a file which contains Groovy code

This scenario uses tGroovyFile, on its own. The Job calls a file containing Groovy code in order to display the file information in the Console.

Setting up the Job

Open the Custom_Code folder in the Palette and drop a tGroovyFile component onto the workspace.

Configuring the tGroovyFile component

  1. Double-click the component to display the Component view.

  2. In the Groovy File field, enter the path to the file containing the Groovy code, or browse to the file in your directory. In this example, it is D:/Input/Ageducapitaine.txt, and the file contains the following Groovy codes:

    println("The captain is " + age +  " years old")
  3. In the Variables table, add a line by clicking the [+] button.

  4. In the Name column, enter "age", and then in the Value column, enter 50.

Executing the Job

  1. Press Ctrl+S to save your Job.

  2. Press F6 or click Run on the Run tab to execute the Job.

    The Console displays the information contained in the input file, to which the variable result is added.