This page is superseded by the InfoCenter

Please look at the latest documentation over here http://infocenter.pentaho.com/help/topic/pdi_user_guide/reference_kitchen.html

Index

• What is Kitchen?

• #Installation

• #Launching Kitchen

• #Command line options

• #Path

• #Run a job from file

• #Run a job from Repository

• #Redirecting output

• #Return codes

• #Scheduling

What is Kitchen?

Kitchen is a program that can execute jobs designed by Spoon in XML or in a database repository. Usually jobs are scheduled in batch mode to be run automatically at regular intervals.

Installation

The first step is the installation of Sun Microsystems Java Runtime Environment version 1.5 or higher. You can download a JRE for free at http://www.java.com/.

After this, you can simply unzip the distribution zip-file in a directory of your choice.
In the Kettle directory where you unzipped the file, you will find a number of files.
Under Unix-like environments (Solaris, Linux, OSX, ...) you will need to make the shell scripts executable. Execute these commands to make all shell scripts in the Kettle directory executable:

Launching Kitchen

To launch Kitchen on the different platforms these are the scripts that are provided:

• Kitchen.bat: run Kitchen on the Windows platform.

• kitchen.sh: run Kitchen on Unix platforms and Mac OSX

Kitchen can be run on any platform that has a version of the Java Runtime Environment version 1.5 or higher.

Command line options

These are the command line options that you can use.

IMPORTANT NOTES:
On Windows system, the use of the minus ("-") in the options causes problems as well as the equal sign ("="). Because of this, from version 2.2.2 on, you can also use this format or any combination of /,- and :,=
Fields in italic represent the values that the options use.
It's important that if spaces are present in the option values, you use quotes or double quotes to keep them together. Take a look at the examples below for more info.

Below are the valid options.

Display version information

This option displays the version of the Kettle core library (kettle.jar).
The build version number and build date are shown as well.

Named parameters

You can set the value of a named parameter, for example: -param:FOO=value

List the named parameters (their name, default value and description) that are defined in the specified job.

See also: Named Parameters.

Launch XML File

This option runs the job defined in the XML file. (.kjb : Kettle Job)

Specify named parameters