Skip to main content

Pentaho+ documentation has moved!

The new product documentation portal is here. Check it out now at docs.hitachivantara.com

 

Hitachi Vantara Lumada and Pentaho Documentation

Prepare your Windows environment for an archive install

Parent article

This article helps you to prepare your Windows environment for an archive installation. The archive process installs the Pentaho Server on a Tomcat web application server, which is provided by Pentaho.

For installation of the Pentaho Server on an existing web application server, see Manual installation.

Process overview

You will complete these tasks to prepare your Windows environment for an archive installation. The archive process installs the Pentaho Server on a Tomcat web application server, which is provided by Pentaho.

  1. Create Windows Directory Structure.
  2. Install Java.
  3. Install the Database that will host the Pentaho Repository.
  4. Download and Unpack the Installation Files.
  5. Set Environment Variables.

Create Windows directory structure

Choose an installation path for installing Pentaho on a Windows system. Pentaho recommends the directories and subdirectories listed in this topic.

  1. Log on to the machine on which you will run the Pentaho Server.

  2. Create the following directory path:

    pentaho\server
  3. Verify that you have the appropriate permissions to read, write, and execute commands in the directories you created.

  4. Verify that your users can write to the directory where you install the Pentaho Suite.

Install Java

To install Pentaho, you need to install a supported version of Java.

  1. Check the Components Reference to identify which version of Java Pentaho supports.

  2. Download the supported version of the JRE or JDK from the Oracle website and install it.

  3. Set an environmental variable to point to your Java installation directory:

    • On Linux: echo $JAVA_HOME=/usr/lib/jvm/jdk8.x.x.x
    • On Windows: SET $JAVA_HOME=C:\Program Files\Java\jdk8.x.x.x

Install the Pentaho Repository host database

The Pentaho Repository houses data needed for Pentaho tools to provide scheduling and security functions. The repository also stores metadata and models for reports that you create.

Before you begin

Choose which type of database to use for the Pentaho Repository's host database, then install it. Pentaho supports these databases:
  • PostgreSQL
  • MySQL
  • Oracle
  • MS SQL Server

Procedure

  1. Check the Components Reference to section to determine which versions of the databases Pentaho currently 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 software and some of its components are delivered in compressed files that need to be unpacked prior to starting the Pentaho archive installation process.

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

Step 1: Download files

The first step for an archive installation of the Pentaho system is to download the compressed files that contain the software.

Download the following installation and plugin files from the Pentaho Customer Support Portal.

Procedure

  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 9.1 GA Release in the 9.x list.

  3. At the bottom of the Pentaho 9.1 GA Release page, click the Pentaho Server folder and then click the Archive Build (Suggested Installation Method) folder in the Box widget and download each of the files listed below.

    ComponentZIP File
    Pentaho Server Installation Filepentaho-server-ee-9.1.0-dist.zip
    Dashboard Designer Pluginpdd-plugin-ee-9.1.0-dist.zip
    Interactive Reporting Pluginpir-plugin-ee-9.1.0-dist.zip
    Pentaho Analyzer Pluginpaz-plugin-ee-9.1.0-dist.zip
    Pentaho Operations Mart Filespentaho-operations-mart-9.1.0-dist.zip
    NoteOn the bottom of the Pentaho 9.1 GA Release page, click the Operations Mart folder in the Box widget and download the ZIP file named: Pentaho Operations Mart.

Step 2: Unpack the Pentaho Server installation files

The Pentaho Server installation file is a package file and needs to be unpacked.

  1. Unzip the Pentaho Server installation file. Inside is the packaged file.

  2. Run the install.bat file to unpack the installation file.

    The IZPak window appears.
  3. Read the license agreement in the IZPack window.

    1. Select the I accept the terms of this license agreement check box

    2. Click Next.

  4. In the Select the installation path text box, browse to or enter the directory where you created the \pentaho\server directory, and then click Next.

    A warning message appears informing you that the directory already exists.
  5. Click Yes.

    Any existing files in the directory will be retained.
  6. Click Done when the installation progress is complete.

Step 3: Unpack the plugin files

Since the plugin files are package files, they must be unpacked.

  1. Unzip the plugin file you would like to install. Inside is the packaged file.

  2. Run the install.bat file to unpack the plugin file.

    The IZPak window appears.
  3. Read the license agreement in the IZPack window.

    1. Select the I accept the terms of this license agreement check box

    2. Click Next.

  4. In the Select the installation path text box, browse to or enter the directory where you created the \pentaho\server\pentaho-server\pentaho-solutions\system directory, and then click Next.

    A warning message appears informing you that the directory already exists.
  5. Click Yes.

    Any existing files in the directory will be retained.
  6. Click Done when the installation progress is complete.

Step 4: Unpack the Operations Mart DDL files

The Pentaho Operations Mart distribution file is a package file and needs to be unpacked.

Procedure

  1. Unzip the Pentaho Operations Mart distribution file to a folder.

    The packaged installation file is in the folder.
  2. Run the install.bat file to unpack the installation file.

    The IZPak window appears.
  3. Read the license agreement in the IZPack window. Select the I accept the terms of this license agreement check box, and then click Next.

  4. In the Select the installation path text box, browse to and save the file in the pentaho\server\pentaho-server\data directory, then click Next.

    A warning message appears informing you that the directory already exists.
  5. Click Yes.

    Any existing files in the directory will be retained.
  6. Click Quit when the installation progress is complete.

  7. Unzip the pentaho-operations-mart-ddl-9.1.0.zip file.

  8. Move the directory for your database into pentaho\server\pentaho-server\data\<database name> and delete the others.

    The appropriate database names are shown in the following table:
    If your Pentaho Repository is on:Copy this directory into pentaho\server\pentaho-server\data\
    PostgreSQLpostgresql
    MySQLmysql5
    Oracleoracle10g
    MS SQL Serversqlserver
  9. Complete the steps for installing Data Integration Operations Mart before installing your database.

Step 5: Verify directory structure

After you have finished unpacking all the plugin and Pentaho Operations Mart files, the newly created Pentaho directory structure should contain these pentaho directories and subdirectories.

Procedure

  1. Verify that the Pentaho files are placed in the correct locations by comparing the pentaho directory structure, as shown, with yours.

    • pentaho\server\pentaho-server\pentaho-solutions\system\analyzer
    • pentaho\server\pentaho-server\pentaho-solutions\system\dashboards
    • pentaho\server\pentaho-server\pentaho-solutions\system\pentaho-interactive-reporting
    • pentaho\server\pentaho-server\
    • pentaho\server\pentaho-server\data\<database name>

Set environment variables

If you do not set the HOME environment variables, Pentaho will not start correctly. Complete the steps in this topic to ensure that you have set the HOME environment variables properly.

Procedure

  1. Set the path of the PENTAHO_JAVA_HOME variable to the path of your Java installation, as shown:

    SET PENTAHO_JAVA_HOME=C:\Program Files\Java\jdk8.x.x.x
  2. (Optional) If you are using a JRE, then also set the JRE_HOME home environment variable.

  3. Log off and log on again, then verify the variables have been properly set by using a command similar to the following example:

    ECHO %PENTAHO_JAVA_HOME%

Prepare your Pentaho Repository

Once you have finished preparing your environment, you can initialize and configure your Pentaho Repository.

Select the database that you are using as your Pentaho Repository: