Skip to main content
Pentaho Documentation

Install BA Design Tools and Plugins

Overview

Explains how to install the BA design tools.

Guidepost graphic.

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. BA 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 BA Design Tools 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 Tools and Plugins

Install the design tools and plugins using the Wizard or Manual Methods.

Use the Wizard to Install Design Tools and Plugins

The Wizard is the preferred method to install design tools and plugins.

Use the BA Installation Wizard to Install BA Design Tools and Plugins

The preferred method for installing BA Design Tools is to use the Installation Wizard.

  1. Run the Installation Wizard according to the instructions in the Install All Component documentation. As you follow the instructions, do these things.
    1. When the Pentaho Applications window displays during the installation wizard process, select any combination of Aggregation Designer, Metadata Editor, Report Designer, Schema Workbench, Analyzer, Dashboard Designer, or Pentaho Mobile to install design tools and plugins.
    2. Do not select the BA Server option if you are installing the tool on a workstation.
  2. When complete, to start the tools, do one of these things.
    1. Windows: Select the tool you want to start from the Start menu.
    2. Linux: Open a Terminal window, then navigate to ~/pentaho/design-tools/ and launch the tool.
    3. Mac: Navigate to the Applications/pentaho/design-tools/ and double-click the file.

Use the Manual Method to Install BA Design Tools and Plugins

To manually install design tools and plugins, do these things. If you want to install Pentaho Analysis Enterprise Edition, skip these steps and see Install Pentaho Analysis Enterprise Edition section instead.

  1. Download the design tool and plugin installation files you want to install from the Pentaho website.
    • Aggregation Designer Design Tool: pad-ee-5.1.0-dist.zip
    • Metadata Editor Design Tool: pme-ee-5.1.0-dist.zip
    • Report Designer Design Tool (For Window and Linux only): prd-ee-5.1.0-dist.zip
    • Report Designer Design Tool (For Mac OS only): prd-ee-mac-5.1.0-dist.zip
    • Schema Workbench Design Tool: psw-ee-3.6.0-dist.zip
    • Dashboard Designer Plugin: pdd-plugin-ee-5.1.0-dist .zip
    • Interactive Reporting Plugin: pir-plugin-ee-5.1.0-dist.zip
    • Mobile Plugin: pentaho-mobile-plugin-5.1.0-dist.zip
    • Pentaho Analyzer Plugin: paz-ee-5.1.0-dist.zip
  2. Unpack the file 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.
    2. Open a Command Prompt or Terminal window and navigate to the folder that contains the files you just extracted.
    3. Enter one of the following at the prompt.

      Windows:

      install.bat
      

      Linux:

      ./install.sh
      
    4. Read the license agreement that appears. Select I accept the terms of this license agreement, then click Next. Note: 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.
    5. Indicate where you want the file to be unpacked. It doesn't matter where because you will be manually placing the files in the appropriate directories later in these instructions.
    6. Click the Next button.
    7. The Installation Progress window appears. Progress bars indicate the status of the installation. When the installation progress is complete, click Quit to exit the Unpack Wizard.
  3. To install the Aggregation Designer, Metadata Editor, Report Designer, or Schema Workbench Design Tools, do these things.
    1. You can install design tools in any directory and on any workstation or server. But, if you want to publish reports, models, and schemas generated by the design tools, install them on a workstation or server that is on the same network as the BA 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 this.
      pentaho/design-tools
      
    2. Verify that you have the appropriate permissions to read, write, and execute commands in the directories you created.
    3. Extract the design tool installation file(s) to the design-tools directory.  As you extract the installation files, directories that 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)
      
  4. To install plugins, do these things.
    1. Navigate to the following path: /pentaho/server/biserver-ee/pentaho-solutions/system/.
    2. Copy the plugins to the appropriate folders as indicated in the list.
      biserver-ee/pentaho-solutions/system/analyzer (Pentaho Analyzer)
      biserver-ee/pentaho-solutions/system/dashboards (Pentaho Dashboard Designer)
      biserver-ee/pentaho-solutions/system/pentaho-interactive-reporting (Pentaho Interactive Reporting)
      biserver-ee/pentaho-solutions/system/pentaho-mobile-plugin (Pentaho Mobile)
      

Install the Analysis Enterprise Edition Plugin

Follow the instructions below to install the Pentaho Analysis Enterprise Edition package, which contains Analysis engine enhancements for large ROLAP deployments. This procedure does not cover Pentaho Analyzer installation, which is covered in this section .

  1. If you have not already done so, retrieve the pentaho-analysis-ee---check--5.1.0.zip file from the Pentaho website.
  2. Unpack the file to a temporary location.
  3. Stop the BA 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---check--5.1.0.jar
    • infinispan-core-5.3.0.Final.jar
    • jboss-logging-3.1.1.GA.jar
    • jboss-marshalling-1.3.15.GA.jar
    • jboss-marshalling-river-1.3.15.GA.jar
    • jboss-transaction-api_1.1_spec-1.0.0.Final.jar
    • jgroups-3.3.1.Final.jar
    • staxmapper-1.1.0.Final.jar
  5. Copy all of 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-udp.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, you first follow the installation steps above. Once this is done, open the file WEB-INF/classes/pentaho-analysis-config.xml and set the following property. See http://wiki.pentaho.com/display/analysis/Pentaho+Analysis+EE 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
pentaho-analysis-config.xml 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.
infinispan-config.xml The InfinispanSegmentCache settings file. It configures the Infinispan system.
jgroups-udp.xml Configures the cluster backing the Infinispan cache. It defines how the nodes find each other and how they communicate. By default, Pentaho uses UDP 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.
memcached-config.xml Configures the Memcached-based segment cache. It is not used by default. To enable it, modify SEGMENT_CACHE_IMPL in pentaho-analysis-config.xml.