Skip to main content
Pentaho Documentation

Prepare Your Windows Environment for Installation

Overview

Explains how to prepare your computers for installation.

Install the BA Repository Host Database

The BA Repository houses data needed for Pentaho tools to provide scheduling and security functions.  It also stores metadata and models for reports that you create.  You can host the BA Repository on these databases.

  • PostgreSQL
  • MySQL
  • Oracle
  • MS SQL Server

To install the BA Repository's host database, do these things.

  1. Check the Supported Technologies section to determine which versions of databases Pentaho supports.
  2. Download and install the database of your choice. 
  3. Verify that the database is installed correctly.

Install Java 

Install a supported version of Java.

  1. Check the Supported Technologies list to see which version of Java Pentaho supports.
  2. Download the supported version of the JRE or JDK from the Oracle site and install it. 

Download and Unpack Installation Files

The Pentaho BA Server software, data files, and examples are stored in pre-packaged .zip files. You will need to manually copy these files to correct directories.

Download Files

Download the following installation and plug-in files from the Pentaho Customer Support Portal in the archive build folder.

Component Zip File
BA Server Installation File biserver-ee-5.4.1-dist.zip
Dashboard Designer Plugin pdd-plugin-ee-5.4.1-dist.zip
Interactive Reporting Plugin pir-plugin-ee-5.4.1-dist.zip
Mobile Plugin pentaho-mobile-plugin-5.4.1-dist.zip
Pentaho Analyzer Plugin paz-plugin-ee-5.4.1-dist.zip
BA Operations Mart Files pentaho-operations-mart-5.4.1-dist.zip

Unpack BA Server Installation File

  1. Unzip the BA Server Installation file.
  2. To unpack the file, run installer.bat.  The IZPak window appears.
  3. Read the license agreement, select I accept the terms of this license agreement, and click Next.
  4. In the Select the installation path text box, enter the place where you want to create the pentaho directory, then click Next.
  5. A message indicating that a target directory will be created appears.  Click Yes.
  6. When the installation progress is complete, click Quit.
  7. Navigate to the pentaho directory and create a server subdirectory.
  8. Move the biserver-ee directory into the server directory.  When you are finished, the directory structure should look like this:
  • pentaho/jdbc-distribution
  • pentaho/license-installer
  • pentaho/server/biserver-ee

Unpack Plugin Files

  1. ​Unzip the file.
  2. Unpack the file by running install.bat.
  3. In the IZPack window read the license agreement, select I accept the terms of this license agreement, then click Next.
  4. In the Select the installation path text box, save the file in the pentaho/server/biserver-ee/pentaho-solutions/system directory, then click Next.
  5. A warning message appears.  Click Yes.
  6. When the installation finishes, click Quit.

Unpack Operations Mart DDL Files

  1. ​Unzip the file.
  2. Unpack the file by running install.bat.
  3. In the IZPack window read the license agreement, select I accept the terms of this license agreement, then click Next.
  4. In the Select the installation path text box, save the file in the pentaho/server/biserver-ee/data directory, then click Next.
  5. A warning message appears.  Click Yes.
  6. When the installation finishes, click Quit.
  7. Remove all of the files except the pentaho-operations-mart-ddl-5.4.1.zip file.
  8. Unzip the pentaho-operations-mart-ddl-5.4.1.zip file.  Move the directory for your database into pentaho/server/biserver-ee/data/<database name>.  Delete the others.
If your BA Repository is On:  Copy the contents of this directory into pentaho/server/biserver-ee/data/
PostgreSQL postgresql
MySQL mysql5
Oracle oracle10g
MS SQL Server sqlserver

Verify Directory Structure

After you have finished unpacking all of the plugin and pentaho operations mart files, the pentaho directory structure should contain these subdirectories.

  • pentaho/server/biserver-ee/pentaho-solutions/system/analyzer
  • pentaho/server/biserver-ee/pentaho-solutions/system/dashboards
  • pentaho/server/biserver-ee/pentaho-solutions/system/pentaho-interactive-reporting
  • pentaho/server/biserver-ee/pentaho-solutions/system/pentaho-mobile-plugin
  • pentaho/server/biserver-ee/
  • pentaho/server/biserver-ee/data/<database name>

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.

  1. If you have not already done so, retrieve the pentaho-analysis-ee-5.4.1.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-5.4.1.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
  1. 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
  1. 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/.
  2. Remove the temporary pentaho-analysis-ee directory.
  3. 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.

Set Environment Variables

Set the PENTAHO_JAVA_HOME  and PENTAHO_INSTALLED_LICENSE_PATH environment variables. If you do not set these variables, Pentaho will not start correctly. 

  1. Set the path of the PENTAHO_JAVA_HOME variable to the path of your Java installation, like this.
    PENTAHO_JAVA_HOME=C:\Program Files\Java\jdk7
    
  2. Set the path of the PENTAHO_INSTALLED_LICENSE_PATH variable to the path that contains your installed licenses, like this.
    PENTAHO_INSTALLED_LICENSE_PATH=C:\Users\pentaho\.pentaho\.installedLicenses.xml
  3. Optional: If you are using Instaview, set the path for the MONETDB_INSTALL_DIR variable to the path for the MonetDB location like this.
    MONETDB_INSTALL_DIR=C:\PE0A28~1\monetdb
  4. Verify the variables have been properly set.

Next Step

You've finished preparing your environment.  Go to Configure Your Repository Database to continue.