Skip to main content
Pentaho Documentation

Install DI Design Tool and Plugins

Overview

Provides design tool and plugin installation steps.

Guidepost graphic.

There is one DI design tool (Spoon) and many plugins, including Instaview and 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.

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 and Instaview Plugin

The easiest way to install the DI design tool, utilities, and Instaview plugin 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

  1. Download the pdi-ee-client-5.2.0-dist.zip file.
  2. Extract the pdi-ee-client-5.2.0-dist.zip file to the design-tools directory.   A data-integration directory should appear.The design tool, utilities and plugins appear in these paths.
    pentaho/design-tools/data-integration (Spoon, Kitchen, Pan, Carte and Instaview)
    pentaho/design-tools/data-integration/plugins/pentaho-big-data-plugin (Big Data Plugin)
    pentaho/design-tools/data-integration/plugins/mongodb-plugin (MongoDB Plugin)
    pentaho/design-tools/data-integration/plugins/market (Marketplace Plugin)   

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.

Configuring MonetDB for Instaview

The Pentaho Data Integration and Business Analytics Wizard Installers configure the Instaview plugin to work properly with the MonetDB database. However, if you chose to install the DI Server using another method, you need to configure Monetdb to work with Instaview.
Note: If you have already installed Instaview in the past, the steps that follow might have already been completed. If so, then review the steps to verify that they have been performed.
  1. Download the "Jul2012-SP2" version of MonetDB and install it on your computing environment. See MonetDB's documentation if you need help completing this step.
  2. Configure Instaview/Kettle to use Monetdb.

    For Windows

    1. In <user home>/.kettle/spoonrc, add these properties.
      MonetDBDatabaseName=pentaho-instaview
      MonetDBDefaultBufferSize=100000
      MonetDBDefaultEncoding=UTF-8
      MonetDBDefaultLogFile=
      
      MonetDBDefaultSchemaName=
      MonetDBDefaultTableName=tmp_agile_data
      
      #port that monet db is running on, 50000 is the default for Monetdb
      MonetDBPort=50000
      
      MonetDBProcessName=mserver5.exe
    2. In <user home>/.kettle/kettle.properties, add these properties:
      AgileBIDatabase=AgileBI
      
      #path to the Instaview templates folder
      InstaviewTemplates=C:\\PROGRA~1\\pentaho\\design-tools\\data-integration\\plugins\\spoon\\agile-bi\\platform\\pentaho-solutions\\system\\instaview\\templates
    For Mac or Linux
    1. In <user home>/.kettle/.spoonrc, add these properties, verifying that the paths are correct for your system.
      #Full path to the monetdb process/executable 
      MonetDBCmd=/usr/local/monetdb/bin/monetdb
                               
                                  
      #Name of the database used for instaview
      MonetDBDatabaseName=pentaho-instaview
                                  
      MonetDBDefaultBufferSize=100000
      MonetDBDefaultEncoding=UTF-8
      MonetDBDefaultLogFile=
                                  
      MonetDBDefaultSchemaName=
      MonetDBDefaultTableName=tmp_agile_data
                                  
      #port that monet db is running on, 50000 is the default for MonetDB
      MonetDBPort=50000
    2. In <user home>/.kettle/kettle.properties, add these properties:
      AgileBIDatabase=AgileBI
                                  
      #path to the Instaview templates folder
      InstaviewTemplates=/home/joe/pentaho/design-tools/data-integration/plugins/spoon/agile-bi/platform/pentaho-solutions/system/instaview/templates
    For any OS
    1. Create a .monetdb file in your user home folder, /home/<userName>/.monetdb.
    2. Add these two entries:
      user=monetdb
      password=monetdb