Internal variables

The following variables are always defined:

Variable Name
Sample Value

Internal.Kettle.Build.Date

2010/05/22 18:01:39

Internal.Kettle.Build.Version

2045

Internal.Kettle.Version

4.3

These variables are defined in a transformation:

Variable Name
Sample Value

Internal.Transformation.Filename.Directory

D:\Kettle\samples

Internal.Transformation.Filename.Name

Denormaliser - 2 series of key-value pairs.ktr

Internal.Transformation.Name

Denormaliser - 2 series of key-value pairs sample

Internal.Transformation.Repository.Directory

/

These are the internal variables that are defined in a job:

Variable Name
Sample Value

Internal.Job.Filename.Directory

file:///home/matt/jobs

Internal.Job.Filename.Name

Nested jobs.kjb

Internal.Job.Name

Nested job test case

Internal.Job.Repository.Directory

/

These are the internal variables that are defined in a transformation or job within a project:

Variable Name
Sample Value

Internal.Project.Data.Directory

pvfs://Repository/home/admin/projects/myproject/

Internal.Project.Execution.Directory

/home/admin/projects/myproject

Internal.Project.Name

My project

Internal.Project.Description

Description of my project

Note: Although both of the project directory variables specify the path to a project, they are used in different situations.

  • Internal.Project.Data.Directory: Used by steps that are not aware of the repository, such as steps that access files as data, like Text File Input and Create File. You can use this variable in fields that allow you to select VFS connections while connected to the repository.

  • Internal.Project.Execution.Directory: Used by steps that are aware of the repository, such as steps that execute other transformations and jobs, like Transformation Executor, Transformation (job entry) and Job (job entry). You can use this variable in fields that allow you to select a Pentaho repository, but not VFS connections.

These variables are defined in a transformation running on a slave server, executed in clustered mode:

Variable Name
Sample Value

Internal.Slave.Transformation.Number

0..<cluster size-1> (0,1,2,3 or 4)

Internal.Cluster.Size

<cluster size> (5)

Notes:

  • In addition to the above, there are also System parameters, including command line arguments. These can be accessed using the Get System Info step in a transformation.

  • Additionally, you can specify values for variables in the Execute a transformation dialog box. If you include the variable names in your transformation they will appear in this dialog box.

Last updated

Was this helpful?