Skip to main content
Pentaho Documentation

Install the PDI tools and plugins

Parent article

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 you can use to install these components:

  • By running the Pentaho Business Analytics Installation Wizard
  • By installing each separate tool manually.

Choose an installation method

Review the following table to determine which installation method is best for you.

NoteMake sure your users can write to the directory where you install the Pentaho suite.
Table 1: Design Tools Installation Decision Table
Method: Pentaho Wizard InstallationManual Installation
Summary:

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

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

The manual method allows you to manually copy design tool 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 about 15 minutes to complete.

Explore ConsiderationsRequirements
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
Expertise
  • Basic computer knowledge.
  • Root or Administrative access.
Approximate Installation Time5 - 10 minutes per client tool

Use the Pentaho installation wizard to install PDI client, utilities, and plugins

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

  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 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:

    • Windows: Select the tool you want to start from the Start menu.
    • 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.
  5. Linux users only: You need to install libwebkitgtk-1.0 on your system. For example, if you are 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 thePDI Marketplace in PDI. See Install PDI plugins for further details.

Install the PDI client

  1. Download the pdi-ee-client-8.3.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.3 GA Release in the 8.x list.

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

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

    CautionDo not use Unarchiver 3.3 to unzip files; it may corrupt the plugin file names.
  3. Open a Command Prompt or Terminal window and navigate to the folder that contains the files you just extracted.

  4. Enter one of the following at the prompt.

    • For Windows: install.bat
    • For Linux: ./install.sh
  5. Read the license agreement that appears. Select Accept, then click Next.

    NoteIf 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.
  6. 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.
  7. Click the Next button.

    The Installation in Progress window appears.
  8. When the installation progress is complete, click Quit to exit the Unpack Wizard.

  9. 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
  10. 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)

Install PDI plugins

There are two ways to install the PDI plugins.

  • If you have the PDI client already installed, you can download just the plugins via the ZIP file, then install them manually.
  • Optionally, you can install the plugins by using the PDI Marketplace in PDI.

Perform a manual installation of the PDI plugins

To install the PDI plugins manually, follow these steps.

  1. Download the plugin you want to install.

  2. 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

Procedure

  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.

    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).
  6. Click OK.

  7. Restart PDI.

  8. To verify that the plugin was installed, open the PDI Marketplace window again.

    The plugin should be listed as installed.

Results

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 within the Output Steps category.