Important: This document is currently under construction. None of the features described in this document are available; development is in progress.
This section provides you with information and instructions for installing and configuring your Pentaho Open Administration Console. The following topics are covered here:
The Management Services Console requires Java SE runtime version 1.5 or later. The console has been tested with the Sun HotSpot Client VM. The default memory system parameters of the JVM (such as those parameters specifying maximum heap size) are adequate for running the console. Specifically, Pentaho recommends that you have at least 100MBs of free physical memory.
Opening the Installation Zip File
The name of the file.zip file contains all the libraries and script files necessary to run the Pentaho Open Administration Console. To install the Pentaho Open Administration Console, unzip this file into an empty directory.
Securing the Console
Before you start the Pentaho Management Services Console, you must make sure that it is running on a secure server. There are two approaches to securing the Pentaho Open Administration Console. The console runs as a Web server on the device on which it is started. The first approach to securing the console is to only run it locally; the second is to require authentication when accessing the console.
Running the Console Locally
The Pentaho Open Administration Console starts up on port 8099. In most instances servers run with a firewall and this port is blocked from external devices unless explicitly configured. Running the console locally provides the highest degree of security. Pentaho strongly recommends that you have a firewall installed on the server running the console.
Follow the instructions below to configure console authentication:
- Create a directory called pwd in the console root directory.
- In the pwd directory, create a text file named console.pwd.
- In the console.pwd file, create entries for authenticated users in the format user: password.
Note: User passwords are not encrypted so limit read access to the user starting the console.
Starting the Pentaho Open Administration Console
Follow the instructions below to start the Pentaho Open Administration Console in the operating system of your choice.
Stopping the Pentaho Open Administration Console
You can stop the console by halting the process at the command line or by using a Web browser to navigate to http://server:8099/halt where server is the name of the server on which the Pentaho Open Administration Console is running.
To start using the Pentaho Open Administration Console navigate to http://server:8099 where server is the name of the server on which Pentaho Open Administration Console is running.
To stop the server:
- Open a command window.
- Go to the install directory that contains the file, stop.bat (or .sh).
- Type stop.bat and press ENTER to stop the console.
Configuring the Pentaho Open Administration Console
Before you use the Management Services Console to administer a BI Server installation you must configure so that the console can locate the necessary files. The first time you run the Pentaho Management Services Console it displays the Management Services Console Configuration page. The console displays this page any time that the configuration is not correct, for example:
- The console configuration has been manually altered and is no longer valid
- The BI Server installation location has moved or been renamed
Accessing the Configuration Page
To access the configuration page at any time click the configure iconon the toolbar in the Pentaho Management Services Console. The console set up page contains the following settings:
An editable setting that contains the file path to the Pentaho solution folder used by the instance of the BI Server that is being administered
Pentaho Web-App Path
An editable setting that contains the file path to the pentaho.war web-app in JBoss or Tomcat
Configuring the Console for the First Time
Follow the instructions below to configure the Management Services Console for the first time:
- Use a Web browser to navigate to http://server:8099 where server is the name of the server on which the Pentaho Management Services Console is running. You will see the console configuration page:
- Paste the path to the solutions directory of the BI Server you want to administer into the Solution Directory text box, for example: provide path
- Paste the path to the Web application directory of the BI Server you want to administer into the Pentaho Web-App Path text box, for example: provide path
- Click Submit. A success message appears. The console configuration page refreshes and changes any indicator icons.
- When all icons indicate success, click Done.
Establishing a Trusted Proxy
In instances where the Pentaho Pre-Configured Installation (PCI) and the Pentaho Administration Console are running on separate devices, you must edit the web.xml file to establish a trusted proxy between the PCI and the console. Go to x:\\pentaho-demo\name_of_app_server\webapps\pentaho\WEB-INF, where x corresponds to the drive on which the PCI is installed. In the web.xml file, replace the IP address (localhost) of the device running the Administration Console: