Use PostgreSQL as your repository database (Manual installation)
This article includes the steps for installing PostgreSQL as the host database for the Pentaho Server in a manual installation of Pentaho.
Before you begin
Before you prepare your Pentaho Repository, you must prepare either a Windows or Linux environment.
The Pentaho Repository resides on the database that you installed during the Windows or Linux environment preparation step, and consists of the following components:
Jackrabbit
Contains the solution repository, examples, security data, and content data from reports that you use Pentaho software to create.
Quartz
Holds data that is related to scheduling reports and jobs.
Hibernate
Holds data that is related to audit logging.
(Optional) Pentaho Operations Mart
To report on system usage and performance.
Initialize PostgreSQL Pentaho Repository database
To initialize PostgreSQL so that it serves as the Pentaho Repository, you will need to run several SQL scripts to create the Hibernate, Quartz, Jackrabbit (JCR), and Pentaho Operations Mart components.
The sections in this article take you through the steps to initialize the PostgreSQL Pentaho Repository database.
Step 1: Change default passwords
Procedure
Browse to the pentaho/server/pentaho-server/data/postgresql directory.
Use any text editor to change the passwords in these SQL scripts:
- create_jcr_postgresql.sql
- create_quartz_postgresql.sql
- create_repository_postgresql.sql
- pentaho_mart_postgresql.sql
Step 2: Run SQL scripts
Run the SQL scripts in the table below.
Run these scripts from the PSQL Console window in the pgAdminIII tool:
Action | SQL Script |
Create Quartz | \i <your filepath>/data/postgresql/create_quartz_postgresql.sql |
Create Hibernate repository | \i <your filepath>/data/postgresql/create_repository_postgresql.sql |
Create Jackrabbit | \i <your filepath>/data/postgresql/create_jcr_postgresql.sql |
Create Pentaho Operations mart | \i <your filepath>/data/postgresql/pentaho_mart_postgresql.sql |
Step 3: Verify PostgreSQL initialization
After you run the scripts, perform the following steps to verify that databases and user roles have been created:
Procedure
Open the pgAdminIII tool.
Verify that you can log on as: hibuser
Once logged on, check that the Quartz, Jackrabbit (JCR), Hibernate, and Pentaho Operations Mart are present.
Exit from the pgAdminIII tool.
Configure PostgreSQL Pentaho Repository database
Now that you have initialized your repository database, you will need to configure Quartz, Hibernate, Jackrabbit, and Pentaho Operations Mart for a PostgreSQL database.
By default, the examples in this section are for a PostgreSQL database that runs on port 5432. The default password is also in these examples.
Step 1: Set up Quartz on PostgreSQL
Event information, such as scheduled reports, is stored in the Quartz JobStore. During the installation process, you must indicate where the JobStore is located by modifying the quartz.properties file.
Open the pentaho/server/pentaho-server/pentaho-solutions/system/quartz/quartz.properties file in any text editor.
Locate the #_replace_jobstore_properties section and set the org.quartz.jobStore.driverDelegateClass as shown:
org.quartz.jobStore.driverDelegateClass = org.quartz.impl.jdbcjobstore.PostgreSQLDelegate
Locate the # Configure Datasources section and set the org.quartz.dataSource.myDS.jndiURL equal to Quartz, as shown:
This setting varies depending on the web server you have chosen for this installation:- If using JBoss, this setting should be:
org.quartz.dataSource.myDS.jndiURL = jboss/datasources/Quartz
- If using Tomcat, this setting should be:
org.quartz.dataSource.myDS.jndiURL = Quartz
- If using JBoss, this setting should be:
Save the file and close the text editor.
Step 2: Set Hibernate settings for PostgreSQL
The files in this section are located in the pentaho/server/pentaho-server/pentaho-solutions/system/hibernate directory.
Perform the following steps to specify where Pentaho can find the Hibernate configuration file.
Procedure
Open the hibernate-settings.xml file in a text editor. Find the <config-file> tags and confirm that it is configured for PostgreSQL.
From:
<config-file>system/hibernate/postgresql.hibernate.cfg.xml</config-file>
Save the file if you made changes, then close the file.
Step 3: Modify Jackrabbit repository information for PostgreSQL
Procedure
Navigate to the pentaho/server/pentaho-server/pentaho-solutions/system/jackrabbit and open the repository.xml file with any text editor.
In each of the sections, comment out any resource references that refer to other databases.
Item Code Section Repository <FileSystem class="org.apache.jackrabbit.core.fs.db.DbFileSystem"> <param name="driver" value="javax.naming.InitialContext"/> <param name="url" value="java:comp/env/jdbc/jackrabbit"/> <param name="schema" value="postgresql"/> <param name="schemaObjectPrefix" value="fs_repos_"/> </FileSystem>
DataStore <DataStore class="org.apache.jackrabbit.core.data.db.DbDataStore"> <param name="driver" value="javax.naming.InitialContext"/> <param name="url" value="java:comp/env/jdbc/jackrabbit"/> <param name="databaseType" value="postgresql"/> <param name="minRecordLength" value="1024"/> <param name="maxConnections" value="3"/> <param name="copyWhenReading" value="true"/> <param name="tablePrefix" value=""/> <param name="schemaObjectPrefix" value="ds_repos_"/> </DataStore>
Workspaces <FileSystem class="org.apache.jackrabbit.core.fs.db.DbFileSystem"> <param name="driver" value="javax.naming.InitialContext"/> <param name="url" value="java:comp/env/jdbc/jackrabbit"/> <param name="schema" value="postgresql"/> <param name="schemaObjectPrefix" value="fs_ws_"/> </FileSystem>
PersistenceManager (1st part) <PersistenceManager class="org.apache.jackrabbit.core.persistence.bundle.PostgreSQLPersistenceManager"> <param name="driver" value="javax.naming.InitialContext"/> <param name="url" value="java:comp/env/jdbc/jackrabbit"/> <param name="schema" value="postgresql"/> <param name="schemaObjectPrefix" value="${wsp.name}_pm_ws_"/> </PersistenceManager>
Versioning <FileSystem class="org.apache.jackrabbit.core.fs.db.DbFileSystem"> <param name="driver" value="javax.naming.InitialContext"/> <param name="url" value="java:comp/env/jdbc/jackrabbit"/> <param name="schema" value="postgresql"/> <param name="schemaObjectPrefix" value="fs_ver_"/> </FileSystem>
PersistenceManager (2nd part) <PersistenceManager class="org.apache.jackrabbit.core.persistence.bundle.PostgreSQLPersistenceManager"> <param name="driver" value="javax.naming.InitialContext"/> <param name="url" value="java:comp/env/jdbc/jackrabbit"/> <param name="schema" value="postgresql"/> <param name="schemaObjectPrefix" value="pm_ver_"/> </PersistenceManager>
DatabaseJournal <Journal class="org.apache.jackrabbit.core.journal.DatabaseJournal"> <param name="revision" value="${rep.home}/revision.log" /> <param name="driver" value="javax.naming.InitialContext"/> <param name="url" value="java:comp/env/jdbc/jackrabbit"/> <param name="schema" value="postgresql"/> <param name="schemaObjectPrefix" value="cl_j_"/> <param name="janitorEnabled" value="true"/> <param name="janitorSleep" value="86400"/> <param name="janitorFirstRunHourOfDay" value="3"/> </Journal>
Using JBoss
Perform Tomcat-specific connection tasks
After your repository has been configured, you must configure the web application servers to connect to the Pentaho Repository. In this step, you will make JDBC and JNDI connections to the Hibernate, Jackrabbit, and Quartz components.
The next couple of sections guide you through the process of working with the JDBC drivers and connection information for Tomcat.
Step 1: Download driver and apply to the Pentaho Server
Procedure
Download a JDBC Driver JAR from your database vendor or a third-party driver developer.
Copy the JDBC driver JAR you just downloaded to the pentaho/server/pentaho-server/tomcat/lib folder.
Copy the hsqldb-2.3.2.jar file to pentaho-server/tomcat/lib if you want to retain the sample provided by Pentaho.
Step 2: Modify JDBC connection information in the Tomcat context.xml File
If you have chosen to use an Pentaho Repository database other than PostgreSQL, you also need to modify the values for the validationQuery parameters in this file.
Procedure
Consult your database documentation to determine the JDBC class name and connection string for your Pentaho Repository database.
Navigate to the pentaho-server/tomcat/webapps folder and use a ZIP extraction utility (such as 7-Zip, Winzip, or Archive) to view the contents of the pentaho.war file.
Open the context.xml file with any text editor.
Add the following code to the file if it does not already exist.
<Resource name="jdbc/Hibernate" auth="Container" type="javax.sql.DataSource" factory="org.pentaho.di.core.database.util.DecryptingDataSourceFactory" maxActive="20" minIdle="0" maxIdle="5" initialSize="0" maxWait="10000" username="hibuser" password="password" driverClassName="org.postgresql.Driver" url="jdbc:postgresql://localhost:5432/hibernate" validationQuery="select 1" jdbcInterceptors="ConnectionState" defaultAutoCommit="true"/> <Resource name="jdbc/Audit" auth="Container" type="javax.sql.DataSource" factory="org.pentaho.di.core.database.util.DecryptingDataSourceFactory" maxActive="20" minIdle="0" maxIdle="5" initialSize="0" maxWait="10000" username="hibuser" password="password" driverClassName="org.postgresql.Driver" url="jdbc:postgresql://localhost:5432/hibernate" validationQuery="select 1" /> <Resource name="jdbc/Quartz" auth="Container" type="javax.sql.DataSource" factory="org.pentaho.di.core.database.util.DecryptingDataSourceFactory" maxActive="20" minIdle="0" maxIdle="5" initialSize="0" maxWait="10000" username="pentaho_user" password="password" testOnBorrow="true" driverClassName="org.postgresql.Driver" url="jdbc:postgresql://localhost:5432/quartz" validationQuery="select 1"/> <Resource name="jdbc/PDI_Operations_Mart" auth="Container" type="javax.sql.DataSource" factory="org.pentaho.di.core.database.util.DecryptingDataSourceFactory" maxActive="20" minIdle="0" maxIdle="5" initialSize="0" maxWait="10000" username="hibuser" password="password" driverClassName="org.postgresql.Driver" url="jdbc:postgresql://localhost:5432/hibernate" validationQuery="select 1"/> <Resource name="jdbc/pentaho_operations_mart" auth="Container" type="javax.sql.DataSource" factory="org.pentaho.di.core.database.util.DecryptingDataSourceFactory" maxActive="20" minIdle="0" maxIdle="5" initialSize="0" maxWait="10000" username="hibuser" password="password" driverClassName="org.postgresql.Driver" url="jdbc:postgresql://localhost:5432/hibernate" validationQuery="select 1"/> <Resource name="jdbc/live_logging_info" auth="Container" type="javax.sql.DataSource" factory="org.pentaho.di.core.database.util.DecryptingDataSourceFactory" maxActive="20" minIdle="0" maxIdle="5" initialSize="0" maxWait="10000" username="hibuser" password="password" driverClassName="org.postgresql.Driver" url="jdbc:postgresql://localhost:5432/hibernate?searchpath=pentaho_dilogs" validationQuery="select 1"/> <Resource name="jdbc/SampleData" auth="Container" type="javax.sql.DataSource" factory="org.pentaho.di.core.database.util.DecryptingDataSourceFactory" maxActive="20" minIdle="0" maxIdle="5" initialSize="0" maxWait="10000" username="pentaho_user" password="password" driverClassName="org.hsqldb.jdbcDriver" url="jdbc:hsqldb:hsql://localhost/sampledata" validationQuery="select 1"/> <Resource name="jdbc/SampleDataAdmin" auth="Container" type="javax.sql.DataSource" factory="org.pentaho.di.core.database.util.DecryptingDataSourceFactory" maxActive="20" minIdle="0" maxIdle="5" initialSize="0" maxWait="10000" username="pentaho_admin" password="password" driverClassName="org.hsqldb.jdbcDriver" url="jdbc:hsqldb:hsql://localhost/sampledata" validationQuery="select 1"/> <Resource name="jdbc/jackrabbit" auth="Container" type="javax.sql.DataSource" factory="org.pentaho.di.core.database.util.DecryptingDataSourceFactory" maxActive="20" minIdle="0" maxIdle="5" initialSize="0" maxWait="10000" username="jcr_user" password="password" driverClassName="org.postgresql.Driver" url="jdbc:postgresql://localhost:5432/jackrabbit" validationQuery="select 1" jdbcInterceptors="ConnectionState" defaultAutoCommit="true"/>
Modify the username, password, driver class information, IP address (or domain name), and port numbers so they reflect the correct values for your environment.
Make sure that the validationQuery parameter for your database is set to this: validationQuery="select 1"
Save the context.xml file, then close it.
Next steps
After installing the database that will host the Pentaho Repository, the next step depends on which type of web application server you are using, either JBoss or Tomcat.
- If you are using the JBoss web application server, follow the procedures in the article Prepare JBOSS connections and web app servers.
- If you are using the Tomcat web application server, follow the procedures in the article Configure and start the Pentaho Server after manual installation.