Install the PDI tools and plugins
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.
Method | Summary | Expertise |
Pentaho Wizard Installation | 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. | Basic computer knowledge. |
Manual Installation | 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. | Basic computer knowledge. |
Each method takes about 15 minutes to complete.
Explore Considerations | Requirements |
You Supply | As specified in the Components Reference each of the following items:
|
We Supply |
|
Expertise |
|
Use the Pentaho installation wizard to install PDI client, utilities, and plugins
Perform the following steps to use the Pentaho Business Analytics Installation Wizard to install the PDI client, utilities, and plugins:
Procedure
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.On the Setup Type window, select the Let me decide for myself option.
When the Pentaho Applications window displays during the installation process, select the Data Integration (ETL) check box.
(Optional) If you are planning to perform any of the following tasks with the PDI client, also select the Pentaho Data Integration Hadoop add-on:
- Connect to a Hadoop cluster. See Use Hadoop with Pentaho for information on Hadoop connections with Pentaho. Also see PDI steps and entries included in the Hadoop add-on installation for further details of what transformation steps and job entries are included in the add-on.
- Inspect your data with the Data Exploration tool. See Inspect your data for information on the Data Exploration tool.
- Create or use a Pentaho Data Service. See Pentaho Data Services for information on creating and publishing a Pentaho Data Service.
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.
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 the PDI Marketplace in PDI. See Step 4: Install PDI plugins for further details.
Step 1: Download files
Procedure
If downloading from the Customer Portal home page, sign in using the Pentaho support user name and password provided in your Pentaho Welcome Packet.
Click Downloads, then click Pentaho 9.4 GA Release in the 9.x list.
On the bottom of the Pentaho 9.4 GA Release page, click the pdi-ee-client-9.4.0-dist.zip file.
folder in the Box widget and download the(Optional) If you are planning to perform any of the following tasks with the PDI client, also download the pdi-ee-client-9.4.0-xxx-hadoop-addon-dist.zip file:
- Connect to a Hadoop cluster. See Use Hadoop with Pentaho for information on Hadoop connections with Pentaho. Also see PDI steps and entries included in the Hadoop add-on installation for further details of what transformation steps and job entries are included in the add-on.
- Inspect your data with the Data Exploration tool. See Inspect your data for information on the Data Exploration tool.
- Create or use a Pentaho Data Service. See Pentaho Data Services for information on creating and publishing a Pentaho Data Service.
Step 2: Unpack the files
- Connect to a Hadoop cluster. See Use Hadoop with Pentaho for information on Hadoop connections with Pentaho. Also see PDI steps and entries included in the Hadoop add-on installation for further details of what transformation steps and job entries are included in the add-on.
- Inspect your data with the Data Exploration tool. See Inspect your data for information on the Data Exploration tool.
- Create or use a Pentaho Data Service. See Pentaho Data Services for information on creating and publishing a Pentaho Data Service.
Procedure
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.Open a Command Prompt or Terminal window and navigate to the folder that contains the files you just extracted.
Enter one of the following at the prompt.
- For Windows: install.bat
- For Linux: ./install.sh
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.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.Click the Next button.
The Installation in Progress window appears.When the installation progress is complete, click Quit to exit the Unpack Wizard.
Step 3: Install PDI
Procedure
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 following example:pentaho/design-tools
Verify that you have the appropriate permissions to read, write, and execute commands in the directories you created.
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)
Step 4: Install PDI plugins
If you have the PDI client already installed, you can manually download and install the plugins via a ZIP file, or you can install the plugins through the PDI Marketplace in PDI client.
Perform a manual installation of the PDI plugins
Procedure
Download the plugin you want to install.
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
Start Pentaho Data Integration (PDI).
Select
The . PDI Marketplace window appears.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.Click the name of the plugin to expand it.
Information about the plugin, including the documentation, source code, and support information appears.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).Click OK.
Restart PDI.
To verify that the plugin was installed, open the PDI Marketplace window again.
The plugin should be listed as installed.
Results
PDI steps and entries included in the Hadoop add-on installation
If you want to use the PDI client to access and manipulate your data on a Hadoop cluster, you must also apply the Hadoop add-on installation. See Install the PDI tools and plugins for instructions to include the add-on.
With the Hadoop add-on, you can also use the following transformation steps and job entries from your PDI client:
- Transformation steps
- Job entries