Step 4: Install Pentaho plugins

If you have the Pentaho Data Integration (PDI) client or Pentaho User Console (PUC) installed, you can use the Plugin Manager to install plugins.

Important: While installing a plugin, the Plugin Manager may prompt you to confirm changes. Review each dialog carefully before proceeding.

Before you begin

• Back up your environment before making any changes to plugins. This is a recommended best practice.

• Verify that you meet the following requirements:

  • You have internet access.

  • You have administrative privileges to install plugins.

  • You have write permissions to the plugin directory.

• If you want to install plugins in a custom location, set the custom paths in the system properties. By default, the Plugin Manager detects writable plugin directories and avoids restricted locations, such as tomcat/bin.

Install plugins in PUC

To install plugins in PUC, complete the following steps:

1. Log into PUC.

2. Open the Plugin Manager by taking one of the following actions:

   • If you are using the Modern Design of PUC, in the menu on the left side of the page, click Plugin Manager.

   • If you are using the Classic Design of PUC, click Home > Administration, and then select Plugin Manager.

   The Plugin Manager page opens with a list of plugins shown in a table.

3. Search for or browse to the plugin you want to install.

4. Install the plugin by taking one of the following actions:

   • To install the latest version of the plugin, click Install.

   • To install an earlier version of the plugin, complete the following steps:

     1. Click the table row for the plugin. The Plugin name dialog box opens.

     2. Select the plugin from the Select the plugin version list and then click Install.

   The plugin is installed.

5. Restart the Pentaho Server.

6. Refresh PUC in the browser.

7. To verify that the plugin is installed, complete the following steps:

   1. In the Plugin Manager page of PUC, search for or browse to the plugin you installed.

   2. Verify the version you installed is listed in the Installed Version column.

Install plugins in PDI

To install plugins in the PDI client, complete the following steps:

1. Log into the PDI client.

2. Click Tools > Plugin Manager. The Plugin Manager tab opens with a list of plugins shown in a table.

3. Search for or browse to the plugin you want to install.

4. Install the plugin by taking one of the following actions:

   • To install the latest version of the plugin, click Install.

   • To install an earlier version of the plugin, complete the following steps:

     1. Click the table row that contains the plugin. The Plugin name dialog box opens.

     2. Select the plugin from the Select the plugin version list and click Install.

   The plugin is installed.

5. Restart the Pentaho Server and PDI client.

6. To verify that the plugin is installed, complete the following steps:

   1. Log into the PDI client.

   2. Click Tools > Plugin Manager. The Plugin Manager tab opens.

   3. Search for or browse to the plugin you installed.

   4. Verify the version you installed is listed in the Installed Version column.

Notes:

• If you cannot use Plugin Manager, you can download plugin installation files and documentation from the Customer Portal.

• Plugins installed outside of the Plugin Manager might not be listed in the Plugin Manager and must be maintained manually.