Skip to main content
Pentaho Documentation

Install DI Tools and Plugins

Overview

Provides design tool and plugin installation steps.

There is one DI design tool (Spoon) and many plugins, including Big Data. This step explains how to install them.

Choose Installation Method

There are two methods by which you can install the design tools and plugins: wizard and manual. 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.

Table 1. DI Design Tools and Plugins Installation Decision Table
If You Are Interested In Choose Options
Wizard Manual
  • Summary
The Wizard is the easiest way to install the DI Design Tool and Plugins.  The Wizard allows you to install design tools and plugins on the server or client workstations. The manual method allows you to manually copy design tool and plugin installation files to any directory on the server or client workstations.
  • Expertise
Basic computer knowledge. Basic computer knowledge.
  • Time
15 minutes. 15 minutes.
  • Recommendation
This is the preferred method. Use for the Pentaho Trial Download, evaluating, and rapid development. Use for rapid development. Use this method if you want to manually install design tools in any directory.

Now that you have selected the installation method, follow the instructions in that section to install the design tool and plugins.

Install the Design Tool and Plugins

Install the design tool and plugins using the Wizard or Manual Methods.

Use the Wizard to Install DI Design Tool

The easiest way to install the DI design tool, and utilities is to use the BA Installation Wizard using the custom method.  As you follow the instructions, select the Data Integration (ETL) option when the Pentaho Applications window appears. 

Use the Manual Method to Install DI Design Tool, Utilities, and Plugins

There are three different manual methods.

Use the Manual Method to Install DI Design Tool and Utilities

Perform the following steps to manually install the PDI client and utilities:

  1. Download the pdi-ee-client-6.1.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 commands 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 and utilities appear in the following path:
    pentaho/design-tools/data-integration (Spoon, Kitchen, Pan, Carte)

Use the Manual Method to Install 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 for more instructions.

Use the Marketplace to Install Plugins

  1. Start Spoon.
  2. Select Help > 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 textbox.
  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 Spoon.
  7. Click OK.
  8. Restart Spoon.
  9. To verify that the plugin was installed, open the PDI Marketplace window again. The plugin is listed as installed. The plugin should appear in the logical place in the Spoon interface. For example, if the plugin that you install is the CMIS Input plugin, it will appear in the Design tab in the Output Steps category.

Next Steps

Now that you have installed the Spoon design tool, the utilities, and the plugins, it is now time for you to configure the design tool.

Learn More