Writing Sample #2

Software installation instructions.

Prepare your Windows environment for a Manual Installation

Process Overview

Complete the following tasks to prepare your Windows environment for the [Product Name] Server installation.

NOTE: If you have already installed a web application server, you can skip Step 3.

  1. Create a Windows directory structure

  2. Install Java

  3. Install your web application server

  4. Install the [Product Name] Repository host database

  5. Download and unpack the installation files

  6. Set environment variables

  7. Prepare your [Product Name] Repository

Create a Windows directory structure

Choose an installation path. We recommend the path shown in the following steps.

  1. Log on to the machine where you will run the [Product Name] Server.

  2. Create this directory path:

    prod\server\prod-server

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

CAUTION: Make sure your users can write to the directory where you install the [Product Name] Suite.

Install Java

You must install a supported version of Java.

  1. Check the Components Reference list to see which Java version [Product Name] currently supports.

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

Install Your web application server

If you want to install [Product Name] on your own web application server, you must first install your web application server.

NOTE: If you have already installed a Tomcat or JBoss web application server and you want to run the [Product Name] Server on it, you can skip this step.

You can deploy the [Product Name] Server on a Tomcat or JBoss web application server. By default, [Product Name] Server software is configured for Tomcat, so if you choose to install [Product Name] on a Tomcat web app server, you will make fewer configuration changes than a JBoss web app server.

  1. Check the Components Reference to see which version of Tomcat or JBoss [Product Name] supports.

  2. 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 prod\server\prod-server directory.

  3. 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 its documentation before you continue with the [Product Name] Server installation process.

  4. Stop the web application server.

Install the [Product Name] Repository host database

The [Product Name] Repository houses data needed for [Product Name] tools to provide scheduling and security functions. It also stores metadata and models for reports that you create. You can host the [Product Name] Repository on the following databases:

  • PostgreSQL

  • MySQL

  • Oracle

  • MS SQL Server

To install the [Product Name] Repository’s host database, complete these steps:

  1. Check the Components Reference to verify which versions of these databases [Product Name] 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 [Product Name] Server software, data files, and examples are stored in pre-packaged .war and .zip files. You will need to copy these files to the correct directories manually.

Step 1: Download the files

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

  1. On the Customer Portal home page, sign in using the [Product Name] support username and password provided in your Welcome Packet.

  2. Click Downloads, then click 8.0 GA Release in the 8.x list.

  3. On the bottom of the 8.0 GA Release page, click the Server > Manual Build (No Web Application Server) folder in the Box widget and download each file listed below.

NOTE: Optionally, on the bottom of the 8.0 GA Release page, click the Operations Mart folder in the Box widget and download the Operations Mart .zip file.

Component

Zip File

Analyzer Plugin

paz-plugin-ee-8.0.0-dist.zip

Dashboard Designer Plugin

pdd-plugin-ee-8.0.0-dist.zip

Server Installation File

prod-server-manual-ee-8.0.0-dist.zip

Interactive Reporting Plugin

pir-plugin-ee-8.0.0-dist.zip

(Optional) BA Operations Mart Files

prod-operations-mart-8.0.0-dist.zip

Step 2: Unpack the [Product Name] Server Installation file

  1. Unzip the [Product Name] Server Installation file. The packaged file is inside.

  2. Unpack the file by running the installer.bat file.

  3. In the IZPack window, read the license agreement, select I accept the terms of this license agreement, and then click Next.

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

  5. A warning message that the directory already exists will appear. Click Yes. Any existing files in the directory are retained.

  6. When the installation progress is complete, click Quit.

  7. In the \prod-server directory, navigate to the \prod-server-manual-ee directory created by the IZPak tool. Unzip the .zip files and place the contents in the appropriate directories listed below.

File

Unzip the Contents of the File to This Directory

license-installer.zip

prod\server

jdbc-distribution-utility.zip

prod\server

pentaho-data.zip

prod\server\prod-server

Step 3: Unpack the plugin files

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

  2. Unpack the plugin by running the install.bat file.

  3. In the IZPack window, read the license agreement, select I accept the terms of this license agreement, and then click Next.

  4. In the Select the installation path text box, save the file in the prod\server\prod- server\prod-solutions\system directory and then click Next.

  5. A warning message that the directory already exists will appear. Click Yes. Any existing files in the directory are retained.

  6. When the installation finishes, click Quit.

Step 4: (Optional) Unpack the Operations Mart DDL files

  1. Unzip the [Product Name] Operations Mart file. The packaged file is inside.

  2. Unpack the file by running the install.bat file.

  3. In the IZPack window, read the license agreement, select I accept the terms of this license agreement, and then click Next.

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

  5. A warning message that the directory already exists will appear. Click Yes. Any existing files in the directory are retained.

  6. When the installation finishes, click Quit.

  7. Unzip the prod-operations-mart-ddl-8.0.0.zip file.

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

The appropriate database names are shown in the following table:

If your [Product Name] Repository is On:

Copy the contents of this directory into prod\ server\prod-server\data\

PostgreSQL

postgresql

MySQL

mysql5

Oracle

oracle10g

MS SQL Server

sqlserver

Step 5: Verify directory structure

Verify that the files have been placed in the following locations by comparing the following directory structures with yours.

NOTE: If your web application server is located in a directory other than the prod\server\prod-server directory, the prod.war and prod-style.war files should appear where you have chosen to install your web application server.

[Product Name] subdirectories

After you have finished unpacking all of the plugins and [Product Name] Operations Mart files, the [Product Name] directory structure should contain these subdirectories:

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

Set environment variables

Set the PROD_JAVA_HOME environment variable. If you do not set these variables, [Product Name] will not start correctly.

NOTE: If you are using a JRE, also set the JRE_HOME home environment variable.

  1. Set the path of the PROD_JAVA_HOME variable to the path of your Java installation, as shown in this example:

    SET PROD_JAVA-HOME=C:\Program Files\Java\jdk8

  2. Restart your application server.

  3. Verify the variables have been properly set.

Prepare your [Product Name] Repository

Once you have finished preparing your environment, you can initialize and configure your [Product Name] Repository. Select the database that you are using as your [Product Name] Repository:

  • PostgreSQL

  • MySQL

  • Oracle

  • MS SQL Server

PreviousWriting Sample #1NextWriting Sample #3

Last updated