# Installation of the Pentaho design tools

If you are installing Pentaho in a production environment, you must manually install design tools on client workstations and install the Pentaho Server on a separate server machine. Data Integration (PDI) plugins, which are needed at design and runtime, should be installed on the server and on client workstations.

### Install Business Analytics design tools

Pentaho Business Analytics design tools include Aggregation Designer, Metadata Editor, Report Designer, and Schema Workbench.

{% stepper %}
{% step %}

### Step 1: Download files

Download the compressed files that contain each design tool.

1. Go to the [Support Portal](https://support.pentaho.com/hc/en-us) and sign in.
2. In the Pentaho card, select **Download**.
3. In the **11.x** list, select **See all \<number> articles**.
4. Select **Pentaho 11.0 GA Release**.
5. Scroll to the bottom of the page.
6. In the file component section, open `Client Tools`.
7. Download the ZIP file for each tool:
   * Aggregation Designer: `pad-ee-11.0.0.0-<build number>.zip`
   * Metadata Editor: `pme-ee-11.0.0.0-<build number>.zip`
   * Report Designer: `prd-ee-11.0.0.0-<build number>.zip`
   * Schema Workbench: `psw-ee-11.0.0.0-<build number>.zip`

{% hint style="info" %}
If you plan to use Hive as a data source, also download:

* `pme-ee-11.0.0.0-<build number>-hadoop-addon.zip`
* `prd-ee-11.0.0.0-<build number>-hadoop-addon.zip`

For `prd-ee` on macOS, the macOS-specific content is included in the main `prd-ee` package.
{% endhint %}
{% endstep %}

{% step %}

### Step 2: Unpack the files

Unpack the files you downloaded in Step 1 into a temporary directory.

{% hint style="warning" %}
Do not use Unarchiver 3.3. It can corrupt plugin file names.
{% endhint %}

1. Locate the downloaded ZIP files.
2. Unpack each ZIP file into a temporary directory.
3. If you downloaded the Hive add-ons, unpack them after unpacking the base tool ZIPs.
   {% endstep %}

{% step %}

### Step 3: Install the design tools

Create an installation directory and move each tool into its own subdirectory.

1. Create a directory with read, write, and execute permissions.

   Example: `Pentaho/design-tools`
2. Create a subdirectory for each tool:
   * Aggregation Designer: `pentaho/design-tools/aggregation-designer`
   * Metadata Editor: `pentaho/design-tools/metadata-editor`
   * Report Designer: `pentaho/design-tools/report-designer`
   * Schema Workbench: `pentaho/design-tools/schema-workbench`
3. Move the unpacked files into the matching directory.
4. If you downloaded Hive add-ons, move their contents into the matching tool directory:
   * `pme-ee-11.0.0.0-<build number>-hadoop-addon.zip` → `pentaho/design-tools/metadata-editor`
   * `prd-ee-11.0.0.0-<build number>-hadoop-addon.zip` → `pentaho/design-tools/report-designer`

{% hint style="info" %}
Install the design tools on a machine on the same network as the Pentaho Server. This simplifies publishing reports, models, and schemas.
{% endhint %}
{% endstep %}
{% endstepper %}

### Install PDI client, utilities, and plugins

Use the PDI client (Spoon) and its utilities and plugins to develop and deploy ETL programs.

{% stepper %}
{% step %}

### Step 1: Download files

1. Go to the [Support Portal](https://support.pentaho.com/hc/en-us) and sign in.
2. In the Pentaho card, select **Download**.
3. In the **11.x** list, select **Pentaho 11.0 GA Release**.
4. Scroll to the bottom of the page.
5. In the file component section, open `Client Tools/PDI (Spoon)`.
6. Download `pdi-ee-client-11.0.0.0-<build number>.zip`.

Optional: Download `pdi-ee-client-11.0.0.0-<build number>-hadoop-addon.zip` if you plan to do either of the following:

* Connect to a Hadoop cluster. See [Use Hadoop with Pentaho](https://docs.pentaho.com/install/use-hadoop-with-pentaho).
* Create or use a Pentaho Data Service.
  {% endstep %}

{% step %}

### Step 2: Unpack the files

{% hint style="warning" %}
Do not use Unarchiver 3.3. It can corrupt plugin file names.
{% endhint %}

1. Unpack `pdi-ee-client-11.0.0.0-<build number>.zip` into a temporary directory.
2. If you downloaded the Hadoop add-on, unpack it into a temporary directory.
   {% endstep %}

{% step %}

### Step 3: Install PDI

1. Create an installation directory with read, write, and execute permissions.

   Example: `Pentaho/design-tools`
2. Move the unpacked PDI files into the installation directory.
3. Verify you have read, write, and execute permissions on the installed files.

Example path:

```
pentaho/design-tools/data-integration (Spoon, Kitchen, Pan, Carte)
```

Optional: If you downloaded the Hadoop add-on, move its contents into:

`pentaho/design-tools/data-integration`
{% endstep %}

{% step %}

### Step 4: Install Pentaho plugins

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

{% hint style="warning" %}
While installing a plugin, Plugin Manager may prompt you to confirm changes. Review each dialog carefully before continuing.
{% endhint %}

#### Before you begin

* Back up your environment.
* Confirm these requirements:
  * Internet access
  * Administrative privileges to install plugins
  * Write permissions to the plugin directory

{% hint style="info" %}
If you need a custom plugin location, set custom paths in system properties. Plugin Manager detects writable plugin directories by default and avoids restricted locations (for example, `tomcat/bin`).
{% endhint %}

#### Install plugins in PUC

1. Sign in to PUC.
2. Open **Plugin Manager**:
   * Modern design: select **Plugin Manager** in the left menu.
   * Classic design: select **Home > Administration > Plugin Manager**.
3. Find the plugin.
4. Install a version:
   * Latest: select **Install**.
   * Earlier: select the plugin row, choose a version, then select **Install**.
5. Restart the Pentaho Server.
6. Refresh PUC.
7. Verify the installed version in **Installed Version**.

#### Install plugins in the PDI client

1. Open the PDI client.
2. Select **Tools > Plugin Manager**.
3. Find the plugin.
4. Install a version:
   * Latest: select **Install**.
   * Earlier: select the plugin row, choose a version, then select **Install**.
5. Restart the Pentaho Server and the PDI client.
6. Verify the installed version in **Installed Version**.

{% hint style="info" %}
If you cannot use Plugin Manager, download plugin installation files and documentation from the [Support Portal](https://support.pentaho.com/hc/en-us).

Plugins installed outside of Plugin Manager might not appear in Plugin Manager and must be maintained manually.
{% endhint %}
{% endstep %}
{% endstepper %}

#### Hadoop add-on: included steps and job entries

If you apply the Hadoop add-on, you can use these items in the PDI client.

* Transformation steps
  * Annotate Stream
  * CouchDB Input
  * Hadoop File Input
  * Hadoop File Output
  * HBase Input
  * HBase Output
  * HBase Row Decoder
  * MapReduce Input
  * MapReduce Output
  * ORC Input
  * ORC Output
  * Parquet Input
  * Parquet Output
  * Shared Dimension
* Job entries
  * Amazon EMR Job Executor
  * Amazon Hive Job Executor
  * Build Model
  * Hadoop Copy Files
  * Hadoop Job Executor
  * Oozie Job Executor
  * Pentaho MapReduce
  * Publish Model
  * Spark Submit
  * Sqoop Export
  * Sqoop Import
  * Start a PDI cluster on YARN
  * Stop a PDI cluster on YARN

### Install the Analysis Enterprise Edition plugin (optional)

Advanced Mondrian users can install the Analysis Enterprise Edition plugin to distribute cached data across a self-managed cluster of peers.

For more information about using this plugin with Mondrian, see [Mondrian cache control](https://docs.pentaho.com/install/legacy-redirects/multidimensional-data-modeling-redirects/mondrian-cache-control).

1. Download `pentaho-analysis-ee-11.0.0.zip`.
2. Unpack the file to a temporary location.
3. Stop the Pentaho Server.
4. Copy these JAR files from `/pentaho-analysis-ee/lib/` to `/tomcat/webapps/pentaho/WEB-INF/lib/`:
   * `pentaho-analysis-ee-core-11.0.0-obf.jar`
   * `infinispan-commons-8.2.5.Final.jar`
   * `infinispan-core-8.2.5.Final.jar`
   * `jboss-logging-3.3.0.GA.jar`
   * `jboss-marshalling-osgi-1.4.10.Final.jar`
   * `jboss-transaction-api_1.1_spec-1.0.1.Final.jar`
   * `jgroups-3.6.7.Final.jar`
   * `memcached-0.0.1-PENTAHO.jar`
5. Copy configuration files from `/pentaho-analysis-ee/config/` to `/tomcat/webapps/pentaho/WEB-INF/classes/`:
   * `pentaho-analysis-config.xml`
   * `infinispan-config.xml`
   * `jgroups-tcp.xml`
   * `memcached-config.xml`
6. In archive-based and executable-based installations, the `pentaho.war` file is already deployed as `/tomcat/webapps/pentaho/`.
7. Remove the temporary `pentaho-analysis-ee` directory.

To enable the segment cache plugin, set `USE_SEGMENT_CACHE` to `true` in `WEB-INF/classes/pentaho-analysis-config.xml`:

```
<entry key="USE_SEGMENT_CACHE">true</entry>
```

See also: [Pentaho Analysis EE](https://pentaho-community.atlassian.net/wiki/spaces/analysis/pages/1790804859/Pentaho+Analysis+EE).