KETTLE Variables

The kettle.properties file contains global variables for KETTLE.

Workshop - Kettle Variables

Use variables to avoid hardcoded paths and values.

Use kettle.properties to store global variables for Spoon.

In this workshop, you will create a global variable. You will then use it in a transformation.

What You'll Accomplish:

• Access and edit the kettle.properties configuration file

• Define a global variable for jobs and transformations

• Use both variable formats (${VAR} and %%VAR%%)

• Insert variables with Ctrl+Space

Prerequisites: Pentaho Data Integration installed and configured

Estimated Time: 10 minutes

---

Global Variables - kettle.properties

Variables can be used throughout Pentaho Data Integration, including in transformation steps and job entries. You define variables by setting them with the Set Variable step in a transformation or by setting them in the kettle.properties file in the directory.

Use variables by either retrieving them with the Get Variable step or by using metadata strings like:

• ${VARIABLE}

• %%VARIABLE%%

You can mix both formats. The first is Unix-style. The second is Windows-style.

Fields that support variables show the blue ${} icon.

Press Ctrl+Space to insert a variable in those fields. Hover over the icon to see help.

KETTLE Variables

1KB

kettle.properties

Open

---

1. Start Pentaho Data Integration.

Windows (PowerShell)

Set-Location C:\Pentaho\design-tools\data-integration
.\spoon.bat

macOS / Linux

1. Select Edit -> Edit the kettle.properties file

2. Highlight the first row and right mouse click, and select the following option.

Global variables

1. Add a DIR_SAMPLES variable for your OS.

Windows

Add this line:

DIR_SAMPLES=C:/Temp

Linux/macOS

1. Save.

Spoon loads kettle.properties on startup.

If variables do not show up, restart Spoon.

You can also edit kettle.properties manually.

Default locations:

• Windows: C:\Users\<username>\.kettle\kettle.properties

• Linux/macOS: ~/.kettle/kettle.properties

The PowerShell script uses nano which was installed using scoop

1. Open a terminal.

Windows (PowerShell)

cd \
cd Workshop--Data-Integration\Scripts
.\edit-kettle.properties.ps1

Linux/macOS

kettle.properties - Linux

Verify in Spoon:

1. Open any step property that shows the blue ${} icon.

2. Press Ctrl+Space.

3. Search for DIR_SAMPLES.

4. Insert it into the field.

Global variable in Transformation

Kettle Variables | Pentahodocs.pentaho.com

---