Skip to main content
Hitachi Vantara Lumada and Pentaho Documentation

Install the BA Design Tools

Choose an Installation Method

There are two methods for installing the Business Analytics (BA) design tools: the Pentaho Business Analytics Installation Wizard or a manual installation. Review the following table to determine which method is best for you.

Make sure your users can write to the directory where you install the Pentaho suite.

BA Design Tools Installation Decision Table
  Pentaho Wizard Installation Manual Installation


The Pentaho Business Analytics Installation Wizard is the easiest way to install BA design tools on the server or client workstations.

Use this method for evaluating the Pentaho Suite and for rapid development.

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. Basic computer knowledge.

Each method takes approximately 15 minutes to complete.

Explore Considerations


You Supply

As specified in the Components Reference, each of the following items:

  • Computer with a supported operating system and hardware configuration.
  • Oracle Java Runtime Environment (JRE) or Oracle Java Development Kit (JDK).
We Supply
  • Installation Package
Technologies Used


  • Basic computer knowledge.
  • Root or Administrative access.
Approximate Installation Time 5 - 10 minutes per client tool

Use the Pentaho Installation Wizard to Install BA Design Tools

The Pentaho Business Analytics Installation Wizard is the preferred method for installing BA design tools.

  1. 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.
  2. On the Setup Type window, select the Let me decide for myself option.
  3. When the Pentaho Applications window displays during the installation process, select any combination of the following BA design tools: 
  • Reporting Design Tools
  • Analysis Design Tools

Do not select the Pentaho Server option if you are installing the tool on a workstation.

  1. 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.

Perform a Manual Installation of the BA Design Tools

To manually install design tools, follow these steps.

If you want to install Pentaho Analysis Enterprise Edition plugin, skip these steps and see Install Pentaho Analysis Enterprise Edition Plugin section instead.

Step One: Download Files

Download the design tool installation files you want to install from the Pentaho website or the Pentaho Customer Support Portal  (To download the installation .zip file from the Pentaho website, follow the instructions listed on the site.)

  1. On the Customer Portal home page, sign in using the Pentaho support user name and password provided in your Pentaho Welcome Packet.
  2. Click Downloads, then click Pentaho 8.0 GA Release in the 8.x list.
  3. On the bottom of the Pentaho 8.0 GA Release page, click the Client Tools folder in the Box widget. A list of folders appears corresponding to each client tool. Click each folder to access and download the following files.
  • Aggregation Designer Design Tool:
  • Metadata Editor Design Tool:
  • Report Designer Design Tool (For Window and Linux only):
  • Report Designer Design Tool (For Mac OS only):
  • Schema Workbench Design Tool:

Step Two: Unpack the Files

Unpack the files by completing these steps.

  1. 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 at the prompt.

    For Windows:


    For Linux:

  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.

Step Three: Install the Design Tools

To install the Aggregation Designer, Metadata Editor, Report Designer, or Schema Workbench Design Tools, complete the following steps.

  1. Create a directory for installing your design tools.

For publishing reports, models, and schemas created with the design tools, we recommend you install the design tools in a directory on a workstation or server that is on the same network as the Pentaho Server. 

If you are unsure of the directory in which to install the design tools, we suggest that you create a pentaho directory and design-tools subdirectory on your workstation and install the design tools there. If you choose this option, the directory path should look like the following:

  1. Verify that you have the appropriate permissions to read, write, and execute commands in the directories you created.
  2. Extract the design tool installation file(s) to the design-tools directory.  As you extract the installation files, directories which hold the design tools are created.
    pentaho/design-tools/aggregation-designer (Aggregation Designer)
    pentaho/design-tools/metadata-editor (Metadata Editor)
    pentaho/design-tools/report-designer (Report Designer)
    pentaho/design-tools/schema-workbench (Schema Workbench)

Install the Optional Analysis Enterprise Edition Plugin

Audience: Advanced Mondrian users who want to distribute cached data across a self-managed cluster of peers. This plugin is distributed as a set of JAR archives and configuration files which must be deployed alongside an existing Mondrian installation. It contains Analysis engine enhancements for large ROLAP deployments. When this JAR archive is deployed properly, it will register new features and make them available to Mondrian. For more information about using this plugin with Mondrian, see Mondrian Cache Control.

Follow the instructions below to install the Pentaho Analysis Enterprise Edition package.

  1. If you have not already done so, retrieve the file from the Pentaho website.
  2. Unpack the file to a temporary location.
  3. Stop the Pentaho Server if it is running.
  4. Copy the following JARs from the /pentaho-analysis-ee/lib/ directory to the /tomcat/webapps/pentaho/WEB-INF/lib/ directory.
    • pentaho-analysis-ee-5.0.0.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
  5. Copy all the configuration files from /pentaho-analysis-ee/config/ to the /tomcat/webapps/pentaho/WEB-INF/classes/directory.
    • pentaho-analysis-config.xml
    • infinispan-config.xml
    • jgroups-tcp.xml
    • memcached-config.xml
  6. Depending on the installation type, there would not be a pentaho.war (in archive-based installations and executable-based installations, the pentaho.war is already deployed and the application will show as: /tomcat/webapps/pentaho/.)
  7. Remove the temporary pentaho-analysis-ee directory.
  8. To enable the segment cache plugin, first follow the installation steps above. Once complete, open the file WEB-INF/classes/pentaho-analysis-config.xml and set the following property. (See for more details.)
    <entry key="USE_SEGMENT_CACHE">true</entry>

Pentaho Analysis Enterprise Edition is now installed with the default Infinispan configuration.

File Description
Cache Configuration File Descriptions

Defines the global behavior of the Pentaho Analysis Enterprise Edition plugin. Settings in this file enable you to define which segment cache configuration to use, and to turn off the segment cache altogether.


The InfinispanSegmentCache settings file. It configures the Infinispan system.


Configures the cluster backing the Infinispan cache. It defines how the nodes find each other and how they communicate. By default, Pentaho uses TCP and multicast discovery, which enables you to run many instances on a single machine or many instances on many machines. (There are examples of other communication setups included in the JAR archive.) This file is referenced by infinispan as specified in the infinispan-config.xml configuration file.


Configures the Memcached-based segment cache. It is not used by default. To enable it, modify SEGMENT_CACHE_IMPL in pentaho-analysis-config.xml.