Kettle

The Kettle actions allow for the execution ETL operations within your action sequence using the Kettle open source ETL tool. Supported operations include the execution of Kettle ETL transformation and Kettle jobs. For further information on Kettle refer to http://kettle.pentaho.org.

Kettle Transformation

Executes a Kettle transformation and saves the resulting data into an output result set.

Component Name: KettleComponent

Inputs:

REQUIRED
Monitor Step - The step in the transformation from which to retrieve success and error rows.

OPTIONAL
Transformation Inputs __-- Allows for the inclusion of miscellaneous inputs to the Kettle transformation.
directory -- specified if loading from the kettle repository, used in conjunction with the input "transformation"

Outputs:

Execution Status Output - The execution status of the job or transformation (Success, Failure, etc...).
Execution Log Output - The execution log of the given job or transformation.
Transform Success Output - The name of the result set containing the successfully processed data from executing the Kettle transformation.
Transform Success Count Output - The number of rows in the Transform Success Output result set.
Transform Error Output - The name of the result set containing the data that failed processing from executing the Kettle transformation.
Transform Error Count Output - The number of rows in the Transform Error Output result set.

Resources:

REQUIRED
Transformation File -- The kettle transformation file that is be executed.

Kettle Job

Executes a Kettle Job.

Component Name: KettleComponent

Inputs:

OPTIONAL
Job Inputs -- Allows for the inclusion of miscellaneous inputs miscellaneous inputs to the Kettle job.
directory -- specified if loading from the kettle repository, used in conjunction with the input "job"

Outputs:

Execution Status Output - The execution status of the job or transformation (Success, Failure, etc...).
Execution Log Output - The execution log of the given job or transformation.

Resources:
REQUIRED
Job File - The Kettle job file to be executed.

Kettle Repository Configuration

To configure the kettle repository, modify the pentaho-solutions/system/kettle/settings.xml file:

repository.type -- files or rdbms
repository.name -- the name of the repository
repository.userid --the username to access the repository
repository.password -- the password to access the repository

Support for Parameters, Variables and Arguments

Parameters, variables and arguments may be passed into PDI Jobs and Transformations by mapping KettleComponent inputs. All values to be sent to the PDI Job / Transformation MUST be included in the 'action-inputs' section of the KettleComponent's 'action-definition' element.

Once the desired values are in the 'action-inputs' section they may be mapped by adding either a 'set-parameter', 'set-variable', or 'set-argument' element into the 'component-definition' section of the KettleComponent's 'action-definition'.

Format for: 'set-parameter':
<set-parameter>
  <name>parameterOne</name>
  <mapping>inputOne</mapping>
</set-parameter>

Format for: 'set-variable':
<set-variable>
  <name>variableOne</name>
  <mapping>inputOne</mapping>
</set-variable>

Format for: 'set-argument':
<set-argument>
  <name>1</name>
  <mapping>inputOne</mapping>
</set-argument>
<set-argument>
  <name>2</name>
  <mapping>inputTwo</mapping>
</set-argument>

In the above three examples, the 'name' element maps to the name in the PDI Job / Transformation (Except in the case of argument it is, consecutively 1-10, mapping to the expected command line arguments). The 'mapping' element maps to the parameter in 'action-inputs'.

Please see: http://jira.pentaho.com/browse/BISERVER-257 for a more complete example.