Page Comparison

h1. Substituting variable references in Job Parameter values

*Abstract*: Kettle does not automatically replace variable references in parameter values. Here's a transformation that grabs all parameters of the containing job, substitutes and variable references inside the parameter values, and then overwrites the original parameters.

*Authors*: Roland Bouman

*License*: LGPL

*Kettle version*: Kettle 3.2.0 and up

h2. Attachments

* [substitute-variables-in-parameters.ktr|http://wiki.pentaho.com/download/attachments/20283718/substitute-variables-in-parameters.ktr] \- A transformation that grabs the parameters from the containing job and overwrites their original value with a variable substituted value. Simply include this transformation as the first job entry in your main job to support variable references in job parameter values. No further configuration required.
* [test-substitute-variables-in-parameters.kjb|http://wiki.pentaho.com/download/attachments/20283718/test-substitute-variables-in-parameters.kjb] \- A sample job that illustrates how to use {color:#999900}\[{color}{color:#999900}substitute-variables-in-parameters.ktr{color}\|http://wiki.pentaho.com/download/attachments/20283718/substitute-variables-in-parameters.ktr\]{color} and demonstrates its behavior.
* [test-dump-variables.ktr|http://wiki.pentaho.com/download/attachments/20283718/test-dump-variables.ktr] \- a helper transformation used by the test job to prove the variable substitution works.

[Download all|http://wiki.pentaho.com/pages/downloadallattachments.action?pageId=20283718]



h2. Background

{color:#000000}Kettle jobs and transformations offers support for {color}{color:#000000}[named parameters|http://wiki.pentaho.com/display/EAI/Named+Parameters]{color}{color:#000000}(as of version 3.2.0). Named parameters form a special class of ordinary {color}{color:#000000}[variables|http://wiki.pentaho.com/display/COM/Using+Variables+in+Kettle]{color}{color:#000000} and are intended to clearly and explicitly define for which variables the caller should supply a value.{color}



{color:#000000}Kettle doesn't automatically substitute variable references in parameter values (nor in ordinary variable values). So, if you need to support variable references inside parameter values, you have to substitute the variables yourself.{color}

{color:#000000}As of Kettle version 4.01, the {color}{color:#000000}[Calculator|http://wiki.pentaho.com/display/EAI/Calculator]{color}{color:#000000} supports a calculation type called "variable substitution in string A" that is intended exactly for that purpose. I have tested this but unfortunately in 4.01 it doesn't seem to work, at least not for the built-in variable {color}${Internal.Transformation.Filename.Directory}{color:#000000} which I used in my test. In the latest stable version, Kettle 4.10 it does work as advertised, I would recommend using this method if you're a user of Kettle 4.10 (or later). {color}In Kettle 3.2.0 (and up) you can use the javascript step to work with variables. With the built-in function getVariable(name, type) you can get the value of a variable, and with the built-in function setVariable(name, value, type) you can set the value of a variable.

{color:#000000}The getVariable() built-in javascript function, plus some standard regular expression magic allow you to create a generic javascript function to replace all variables in a give value passed in by the incoming stream. With the Get Data from XML step, we can analyze any kettle job or transformation file and extract the names of the parameters defined by that job or transformation.{color}

{color:#000000}Putting these things together, we can create a transformation that reads the parameters from the job that contains the current transformation (using the built-in variables ${color}{Internal.Job.Filename.Directory}{color:#000000} and ${color}{Internal.Job.Filename.Name}{color:#000000}). By feeding the parameter names into the javascript step, we can get their runtime value, and substitute any variable references inside the parameter values. Finally, also in he javascript step, we can overwrite the original parameter value with the variable substituted one using the built-in setVariable() function.{color}

{color:#000000}The result is a self-contained transformation that you can drop inside any job to support variable references in job parameters. Obviously, the transformation should appear in the job before any other contained job or transformation that needs to read the substituted parameter values.{color}

h2. See also

[http://rpbouman.blogspot.com/2010/12/substituting-variables-in-kettle.html]