Skip to main content
Pentaho Documentation

Embed and Extend PDI Functionality

You may want to develop custom plugins to extend Pentaho Data Integration (PDI) functionality or to embed the PDI engine into your own Java applications. To aid experienced Java developers, we provide Java classes and methods, as well as sample Eclipse-based projects with detailed code-level documentation. These instructions will show you how to approach your plugin project. We recommended that you open the related sample project and follow along.

When reading these instructions, we recommended that you open the related sample project and follow along. This article provides Java classes and methods, as well as sample Eclipse-based projects with detailed code-level documentation.

Unless specifically stated otherwise, developing custom plugins and extending or embedding PDI is not covered under the standard Pentaho customer support agreement.

Get Started with the Sample PDI Project

This project is for experienced Java developers who want to create customized PDI plugins. To help you get started, we provide a sample Eclipse-based project with detailed code-level documentation for:

  • Extending Pentaho Data Integration (PDI) functionality
  • Embedding the PDI engine into your own Java applications

Unless specifically stated otherwise, developing custom plugins and extending or embedding PDI is not covered under the standard Pentaho customer support agreement.

Download the Sample Project

The sample PDI project file is distributed in a .zip file named kettle-sdk-plugin-assembly-7.0.0.0-25-dist.zip

Click the following link to download the sample project:

kettle-sdk-plugin-assembly-7.0.0.0-25-dist.zip

The sample PDI project is provided "as is" and is subject to the warranty disclaimer contained in the applicable project license. The sample project is informational only and is not recommended for use in production. Use in production is at your own risk.

Set Up a Development Environment

We recommend adapting the sample PDI project to your development environment. The sample PDI project comes preconfigured as an Eclipse project, complete with dependencies to a stable release of PDI. If you are developing for a specific version of PDI, you must replace the dependency jar files to match your version of PDI. The PDI classes and methods are stable for any major version of PDI, so you can safely replace the jar files and develop for any PDI 7.x release.

Get PDI Sources

When developing with PDI (also known as the Kettle project to the open source community), it is helpful to have the Kettle sources close by. Including them in development projects makes it possible to trace and step through core PDI code, which helps when debugging your solution.

It is not necessary to modify or compile any of the PDI sources when embedding or extending PDI. Including the PDI sources in your projects is optional and is not supported.

PDI follows the standard project layout for GitHub repositories. The version currently in development is hosted in the trunk folder, patch branches are hosted in the branch folders, and released versions are tagged in the tags folder.

If you are developing for a specific version of PDI, for instance 8.0.0 , it is important to check-out or export the corresponding tag. To check which version you need to match your installation, select Help > About from the Spoon menu.

The Build version shows you which tag to use to match your installation.

Attach Source to PDI JAR Files

If you checked out PDI sources, you may want to associate the source to the matching PDI jar files against which you are compiling your plugin. This optional step may improve the debugging experience, as it allows you to trace into PDI core code.

Additional Developer Documentation

  • Javadoc
    The javadoc documentation reflects the most recent stable release of PDI and is available at http://community.pentaho.com/javadoc/.
  • Pentaho PDI Community Wiki
    Additional developer documentation is available in the PDI community wiki: Pentaho PDI Community Wiki. The “Documentation for (Java) Developers" section has additional information for extending PDI with plugins or embedding the PDI engine.

Embed Pentaho Data Integration

Build and run transformation and jobs in other applications.

Learn more

Extend Pentaho Data Integration

Develop custom plugins to extend the standard PDI functionality.

Learn more