Skip to main content
Pentaho Documentation

Prepare Your Windows Environment for Installation

Create Windows Directory Structure

  1. Log into the machine on which you will run the BA Server.
  2. Create this directory path.
    pentaho\server\biserver-ee
    
  3. Verify that you have the appropriate permissions to read, write, and execute commands in the directories you created.

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

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. 

Install the Web Application Server

The BA Server can be deployed on either the Tomcat or JBoss web application server. By default, BA Server software is configured for Tomcat. This means that if you choose to use Tomcat, you will need to make fewer configuration changes than you would if you choose to use JBoss.

You must install the web application server yourself. If you already have a Tomcat or JBoss web application server installed and you want to deploy the BA Server on it, please skip this step.

  1. To download and install the web application software, use the instructions in the documentation for the web application server of your choice. We recommend that you install the web application server in the pentaho\server\biserver-ee directory.
  2. Verify the web application server is installed correctly by starting it and viewing the default page. If the web application server does not start, troubleshoot it using the web application server's documentation before you continue with the BA Server installation process.
  3. Stop the web application server.

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.

Download and Unpack Installation Files

The Pentaho BA Server software, data files, and examples are stored in pre-packaged .war and .zip files. These files need to be manually placed into the correct directories.

Step 1: Download Files

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

Component Zip File
BA Server Installation File biserver-manual-ee-6.0.1-dist.zip
Dashboard Designer Plugin pdd-plugin-ee-6.0.1-dist.zip
Interactive Reporting Plugin pir-plugin-ee-6.0.1-dist.zip
Mobile Plugin pentaho-mobile-plugin-6.0.1-dist.zip
Pentaho Analyzer Plugin paz-plugin-ee-6.0.1-dist.zip

Step 2: Unpack Files

  1. Unzip the BA Server Installation file.
  2. To unpack the file, run install.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 OK.
  6. When the installation progress is complete, click Quit.

Step 3: Put Files in Directories

  1. Navigate to the pentaho directory where you unpacked the files, unzip the zip files and place their contents in the appropriate directories listed below.
    File Unzip the Contents of the File to This Directory
    license-installer.zip pentaho\server
    jdbc-distribution-utility.zip pentaho\server
    pentaho-data.zip pentaho\server\biserver-ee
    pentaho-solutions.zip pentaho\server\biserver-ee
  2. Copy these files to the following directories.​
    File Copy Files to This Directory
    pentaho.war
    • Tomcat: pentaho\server\biserver-ee\<your tomcat installation directory>\webapps
    • JBoss: pentaho\server\biserver-ee\<your jboss installation directory>\standalone\deployments
    pentaho-style.war
    • Tomcat: pentaho\server\biserver-ee\<your tomcat installation directory>\webapps
    • JBoss: pentaho\server\biserver-ee\<your jboss installation directory>\standalone\deployments
    PentahoBIPlatform_OSS_Licenses.html pentaho\server\biserver-ee

Step 4: ​Unpack and Unzip Plugin Files

Do the following for each of the plugin files.

  1. To unpack a file, run the install.bat script.  The IZPak window appears.​
  2. Read the license agreement, select I accept the terms of this license agreement, and click Next.
  3. In the Select the installation path text box, enter the pentaho\server\biserver-ee\pentaho-solutions\system directory, then click Next.
  4. A message appears.  Click YES.
  5. When the installation progress is complete, click Quit.

Step 5: Verify Directory Structure

Verify that the files have been placed in the following places by comparing the following directory structure with yours.

If your web application server is not in the pentaho\server\biserver-ee directory, the pentaho.war and pentaho-style.war files should appear where you've chosen to install your web application server.

Tomcat File Locations:

  • <your home directory>\pentaho
  • pentaho\server\license-installer
  • pentaho\server\license-installer\lib
  • pentaho\server\biserver-ee\<your tomcat installation directory>\webapps\pentaho.war
  • pentaho\server\biserver-ee\<your tomcat installation directory>\webapps\pentaho-style.war
  • pentaho\server\biserver-ee\data
  • pentaho\server\biserver-ee\pentaho-solutions
  • 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-solutions\systems\default-content\samples.zip

JBoss File Locations:

  • <your home directory>\pentaho
  • pentaho\server\license-installer
  • pentaho\server\license-installer\lib
  • pentaho\server\biserver-ee\<your jboss installation directory>\standalone\deployments\pentaho.war
  • pentaho\server\biserver-ee\<your jboss installation directory>\standalone\deployments\pentaho-style.war
  • pentaho\server\biserver-ee\data
  • pentaho\server\biserver-ee\pentaho-solutions
  • 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-solutions\system\default-content\samples.zip

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. 

If you are using a JRE, set the JRE_HOME home environment variable as well.

  1. Set the path of the PENTAHO_JAVA_HOME variable to the path of your Java installation, like this.
    SET PENTAHO_JAVA_HOME=C:\Program Files\Java\jdk7
    
  2. Set the path of the  PENTAHO_INSTALLED_LICENSE_PATH variable to the path of your installed licenses, like this.
    SET PENTAHO_INSTALLED_LICENSE_PATH=C:\Users\pentaho\.pentaho\.installedLicenses.xml
    
  3. Log out and in again, then verify the variables have been properly set.

Next Step

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