Skip to main content
Version Pentaho
Hitachi Vantara Lumada and Pentaho Documentation

Install PDI Tools and Plugins

  1. Last updated
  2. Save as PDF

Choose Installation Method

Pentaho Data Integration (PDI) has one design tool, the PDI client (formerly known as Spoon), several PDI utilities, and many plugins. There are two methods by which you can install these components: the Pentaho Business Analytics Installation Wizard or a manual installation. Review the table to determine which method is best for you.

Make sure your users can write to the directory where you install the Pentaho Suite.

PDI Design Tools and Plugins Installation Decision Table
  Pentaho Installation Wizard Manual Installation

Summary

The Pentaho Business Analytics Installation Wizard is the easiest way to install the PDI design tool, utilities, and plugins on the server or client workstations.

Use this method for evaluating the Pentaho Suite or for rapid development.

The manual method allows you to manually copy design tool and plugin installation files to any directory on the server or client workstations.

Use this method for rapid development.

Expertise

 Basic computer knowledge. Basic computer knowledge.

Each method takes approximately 15 minutes to complete.

Explore Considerations

 
You Supply

As specified in the Components Reference, each of the following items:

  • Computer with a supported operating system and hardware configuration.
  • Oracle Java Runtime Environment (JRE) or Oracle Java Development Kit (JDK).
We Supply
  • Installation Package
Technologies Used

N/A
Expertise
  • Basic computer knowledge.
  • Root or Administrative access.
Approximate Installation Time 5 - 10 minutes per client tool

Use the Pentaho Installation Wizard to Install the PDI Client, Utilities, and Plugins

The preferred method for installing the PDI client, utilities, and plugins is to use the Pentaho Business Analytics Installation Wizard. 

  1. Run the Pentaho Business Analytics Installation Wizard according to the instructions in the Evaluation Installation of the Pentaho Suite. Be sure to perform the following steps while running the installation wizard.
  2. On the Setup Type window, select the Let me decide for myself option.
  3. When the Pentaho Applications window displays during the installation process, select the Data Integration (ETL) check box. 
  4. When the installation wizard is complete, start the tools using one of the following ways:
    • Linux: Open a Terminal window, then navigate to ~/pentaho/design-tools/ and launch the tool.
    • Mac: Navigate to the Applications/pentaho/design-tools/ and double-click the file.
    • Windows: Select the tool you want to start from the Start menu.
  5. Linux users only: You need to install libwebkitgtk-1.0 on your system.  For example, if running Ubuntu you can use the command sudo apt-get install libwebkitgtk-1.0-0 to install the library.

Perform a Manual Installation of the PDI Client, Utilities, and Plugins

You can install the PDI client, utilities, and plugins by downloading a .zip file and extracting the installation files for each component. If you have the PDI client already installed, you can download just the plugins via the .zip file or by using the PDI Marketplace in PDI. See Installing PDI Plugins for further details.

  1. Download the pdi-ee-client-5.0.0-dist.zip file from the Pentaho website or the Pentaho Customer Support Portal. (If you are downloading the installation .zip file from the Pentaho website, follow the instructions listed on the site.)
    1. If downloading from the Customer Portal home page, sign in using the Pentaho support user name and password provided in your Pentaho Welcome Packet.
    2. Click Downloads, then click Pentaho 8.0 GA Release in the 8.x list.

    3. On the bottom of the Pentaho 8.0 GA Release page, click the Client Tools > PDI Client (Spoon) folder in the Box widget and download the pdi-ee-client-5.0.0-dist.zip  file.

  2. Use a zip tool to extract the file you just downloaded.

Do not use Unarchiver 3.3 to unzip files; it may corrupt the plugin file names.

  1. Open a Command Prompt or Terminal window and navigate to the folder that contains the files you just extracted.
  2. Enter one of the following at the prompt.

    For Windows:

    install.bat

    For Linux:

    ./install.sh
  3. Read the license agreement that appears. Select Accept, then click Next.

If you are unpacking the file in a non-graphical environment, open a Terminal or Command Prompt window and type java -jar install.jar -console and follow the instructions presented in the window.

  1. Specify where you want the file to be unpacked. This location can be temporary because you will be manually placing the files in the appropriate directories later in these instructions.
  2. Click the Next button. The Installation in Progress window appears.
  3. When the installation progress is complete, click Quit to exit the Unpack Wizard.
  4. Create a directory for your tools and utilities. If you are unsure of what directory to create, we suggest that you create a pentaho directory and design-tools subdirectory on your workstation. If you choose this option, the directory path should look like the example shown below: 
    pentaho/design-tools
  5. Copy or move the extracted files to the pentaho/design-tools directory. The design tool, utilities, and plugins appear in the following path: 
    pentaho/design-tools/data-integration (Spoon, Kitchen, Pan, Carte)

Installing PDI Plugins

If you have the PDI client already installed, you can optionally download just the plugins via the .zip file or by using the PDI Marketplace in PDI.

Perform a Manual Installation of the PDI Plugins

Download the plugin and unzip it in the appropriate subdirectory in pentaho/design-tools/data-integration/plugins. To determine the correct subdirectory, see the instructions for the plugin you are installing.

Visit the PDI Marketplace to Install the PDI Plugins

  1. Start Pentaho Data Integration (PDI).
  2. Select Tools > Marketplace. The PDI Marketplace window appears.
  3. The name of the plugin appears in the Detected plugins section of the page. Note which plugins are installed. You can filter the list by typing the name of the plugin in the Detected Plugins text box.
  4. Click the name of the plugin to expand it. Information about the plugin, including the documentation, source code, and support information appears.
  5. Click Install this plugin.
  6. The Progress Information dialog box appears, indicating the operation is in process. When the plugin has been successfully installed, a message appears indicating that you will need to restart your client, which is the PDI client (Spoon).
  7. Click OK.
  8. Restart PDI.
  9. To verify that the plugin was installed, open the PDI Marketplace window again. The plugin should be listed as installed.

The plugin should appear in the logical place in the PDI client interface. For example, if the plugin that you install is the 'CMIS Input' plugin, then it will appear in the Design tab > Output Steps category.