Use Oracle as Your Repository Database (Archive installation)

This article includes the steps for installing Oracle as the host database for the Pentaho Server in an archive installation of Pentaho.

Before you begin

Prerequisite

Before you prepare your Pentaho Repository, prepare either a Windows or Linux environment.

Components

The Pentaho Repository resides on the database that you installed during the Windows or Linux environment preparation step. It 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 Oracle Pentaho Repository database

The sections in this article take you through the steps to initialize the Oracle Pentaho Repository database.

To initialize Oracle 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.

Use the ASCII character set when you run these scripts. Do not use UTF-8. UTF-8 may cause script failures due to text string length limits.

If you use different users or passwords, update the examples to match your environment.

Pentaho 10.2.0.0 and earlier use the Quartz 1.x library. Those tables use the QRTZ5_ prefix.

Pentaho 10.2.0.1 and later use Quartz 2.x. Those tables use the QRTZ6_ prefix.

If you upgrade from an earlier version to 10.2.0.1 or later, create the QRTZ6_ tables by repeating the Quartz database creation step. You can optionally migrate existing schedules with the migration script.

Back up your data before you run any scripts.

Important: Failure to complete the Quartz upgrade results in a Pentaho Server error at start-up. In addition to the server error, the following exception message is generated in the catalina.log file:

Missing Quartz library database error

Steps

1. Step 1: Change default passwords

2. Step 2: Run SQL scripts

3. Step 3: Verify Oracle initialization

Step 1: Change default passwords

For production systems, follow best practices and change the default passwords in the SQL scripts.

Note: If you are evaluating Pentaho, you can skip this step.

1. Browse to the <*your pentaho directory*>/pentaho-server/data/oracle folder.

2. Use a text editor to update the scripts as needed for your user, password, database, and other settings:

   • create_jcr_ora.sql

   • create_quartz_ora.sql

   • create_repository_ora.sql

   • pentaho_mart_oracle.sql

3. Save and close the files.

Step 2: Run SQL scripts

When upgrading from previous Pentaho versions, including 10.2.0.0 GA to 10.2.0.1 and later, you must manually initialize a new Quartz database. A new Quartz library is created in the repository database as a result.

Always follow best practices and back up your data before you proceed. If you want to keep existing Quartz schedules, you can migrate the existing tables to the new tables.

Note: You may need administrator permissions to run these scripts on the host OS server.

1. Back up your data. See Back up your existing Pentaho products and install Pentaho 11.0.

2. If the Pentaho Server is running, stop it.

   For instructions, see Stop and start the Pentaho Server and repository.

3. Make sure that your Oracle instance is running.

4. Open a Command Prompt or terminal window that runs SQL*Plus, then run the following scripts in this order:

   1. <*your pentaho directory*>/pentaho-server/data/oracle/create_jcr_ora.sql

   2. <*your pentaho directory*>/pentaho-server/data/oracle/create_quartz_ora.sql

   3. <*your pentaho directory*>/pentaho-server/data/oracle/create_repository_ora.sql

   4. <*your pentaho directory*>/pentaho-server/data/pentaho_mart_oracle.sql

   This creates the Quartz database, Jackrabbit repository, Hibernate repository, and Pentaho Operations Mart.

   The QRTZ6_ tables are created. Any existing QRTZ5_ tables remain. If you start the Pentaho Server now, the schedule is empty.

5. If you want to retain your existing schedule data, open migrate_old_quartz_data_oracle.sql in a text editor.

6. Update the script for your user, password, database, and other settings, then save it.

7. Run the migration script:

   <*your pentaho directory*>/pentaho-server/data/oracle/migrate_old_quartz_data_oracle.sql

Note: The original QRTZ5_ data remains available. Delete it only after you verify a successful migration.

Note: You unpacked the Pentaho Operations Mart SQL file while preparing your environment for the archive installation.

For details, see Prepare your Windows environment for an archive install or Prepare your Linux environment for an archive install.

Step 3: Verify Oracle initialization

Note: Unless you changed it in Step 1, the default password for each username below is password.

After you run the scripts, verify that databases and user roles were created correctly:

1. Open a Terminal or Command Prompt window running SQL*Plus (or a similar client) and connect to the Oracle database.

2. Log in as hibuser.

3. Verify that you can see the tables under hibernate.

4. If you installed Pentaho Operations Mart, verify that you can see the tables under pentaho_operations_mart.

5. Log in as jcr_user.

6. Verify that you can see the tables under jackrabbit.

   The Jackrabbit tables may not appear until you start Pentaho for the first time.

7. Log in as pentaho_user.

8. Verify that you can see the tables under quartz.

9. Exit the tool.

You have initialized the Oracle Pentaho Repository database.

Configure Oracle Pentaho Repository database

Now that you have initialized your repository database, you will need to configure Quartz, Hibernate, Jackrabbit, and Pentaho Operations Mart for an Oracle database.

By default, the examples in this section are for an Oracle database that runs on port 1521. The default password is also in these examples.

If you use a different port or password, update the examples to match your environment.

Step 1: Set up Quartz on Oracle

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.

1. Open the pentaho/server/pentaho-server/pentaho-solutions/system/scheduler-plugin/quartz/quartz.properties file in any text editor.

2. Locate the #_replace_jobstore_properties section and set the org.quartz.jobStore.driverDelegateClass as shown:

   org.quartz.jobStore.driverDelegateClass = org.quartz.impl.jdbcjobstore.oracle.OracleDelegate

3. Save the file and close the text editor.

Step 2: Set Hibernate settings for Oracle

Modify the Hibernate settings file to specify where Pentaho should find the Pentaho Repository’s Hibernate configuration file. The Hibernate configuration file specifies driver and connection information, as well as dialects and how to handle connection closes and timeouts.

Note: The Hibernate database is also where the Pentaho Server stores the audit logs that act as source data for the Pentaho Operations Mart.

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.

1. Open the hibernate-settings.xml file in a text editor. Find the tags and change postgresql.hibernate.cfg.xml to oracle10g.hibernate.cfg.xml as shown.

   From:

   <config-file>system/hibernate/postgresql.hibernate.cfg.xml</config-file>

   To:

   <config-file>system/hibernate/oracle10g.hibernate.cfg.xml</config-file>

2. Save and close the file.

Step 3: Replace default version of audit log file with Oracle version

Since you are using Oracle to host the Pentaho Repository, you need to replace the audit_sql.xml file with one that is configured for Oracle.

1. Locate the pentaho-solutions/system/dialects/oracle10g/audit_sql.xml file.

2. Copy it into the pentaho-solutions/system directory.

Step 4: Modify Jackrabbit repository information for Oracle

Edit the following code to change the default Jackrabbit repository to Oracle.

1. Navigate to the pentaho/server/pentaho-server/pentaho-solutions/system/jackrabbit and open the repository.xml file with any text editor.

2. As shown in the table below, locate and verify or change the code so that the Oracle lines are not commented out, but the MySQL, PostgreSQL, and MS SQL Server lines are commented out.

Item	Code Section
Repository	<FileSystem class="org.apache.jackrabbit.core.fs.db.OracleFileSystem"> <param name="driver" value="javax.naming.InitialContext"/> <param name="url" value="java:comp/env/jdbc/jackrabbit"/> <param name="schemaObjectPrefix" value="fs_repos_"/> <param name="tablespace" value="pentaho_tablespace"/> </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="oracle"/> <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.OracleFileSystem"> <param name="driver" value="javax.naming.InitialContext"/> <param name="url" value="java:comp/env/jdbc/jackrabbit"/> <param name="schemaObjectPrefix" value="fs_ws_"/> <param name="tablespace" value="pentaho_tablespace"/> </FileSystem>
PersistenceManager (1st part)	<PersistenceManager class="org.apache.jackrabbit.core.persistence.bundle.OraclePersistenceManager"> <param name="driver" value="javax.naming.InitialContext"/> <param name="url" value="java:comp/env/jdbc/jackrabbit"/> <param name="schema" value="oracle"/> <param name="schemaObjectPrefix" value="${wsp.name}_pm_ws_"/> <param name="tablespace" value="pentaho_tablespace"/> </PersistenceManager>
Versioning	<FileSystem class="org.apache.jackrabbit.core.fs.db.OracleFileSystem"> <param name="driver" value="javax.naming.InitialContext"/> <param name="url" value="java:comp/env/jdbc/jackrabbit"/> <param name="schemaObjectPrefix" value="fs_ver_"/> <param name="tablespace" value="pentaho_tablespace"/> </FileSystem>
PersistenceManager (2nd part)	<PersistenceManager class="org.apache.jackrabbit.core.persistence.bundle.OraclePersistenceManager"> <param name="driver" value="javax.naming.InitialContext"/> <param name="url" value="java:comp/env/jdbc/jackrabbit"/> <param name="schema" value="oracle"/> <param name="schemaObjectPrefix" value="pm_ver_"/> <param name="tablespace" value="pentaho_tablespace"/> </PersistenceManager>
DatabaseJournal	<Journal class="org.apache.jackrabbit.core.journal.OracleDatabaseJournal"> <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="oracle"/> <param name="schemaObjectPrefix" value="J_C_"/> <param name="janitorEnabled" value="true"/> <param name="janitorSleep" value="86400"/> <param name="janitorFirstRunHourOfDay" value="3"/> </Journal>

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.

Note: By default, the Pentaho Server software is configured to be deployed and run on the Tomcat server. As such, connections have already been specified and the Tomcat context.xml file must be modified ONLY if you have changed the default ports or passwords.

Use these steps to set up the JDBC driver and update the Tomcat connection settings.

Step 1: Download driver and apply to the Pentaho Server

To connect to a database, including the Pentaho Repository database, you must download and copy a JDBC driver to the appropriate places for the Pentaho Server and the web application server.

Note: Due to licensing restrictions, Pentaho cannot redistribute some third-party database drivers. You must download and install the file yourself.

1. Download a JDBC Driver JAR from your database vendor or a third-party driver developer.

   The JDBC drivers reference has a list of supported drivers.

2. Copy the JDBC driver JAR you downloaded to the pentaho/server/pentaho-server/tomcat/lib folder.

3. 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 XML file

Database connection and network information, such as the username, password, driver class information, IP address or domain name, and port numbers for your Pentaho Repository database are stored in the context.xml file. Modify this file to reflect the database connection and network information for your operating environment.

Caution: If you have a different port, password, user, driver class information, or IP address, change the values in these examples to match your environment.

1. Consult your database documentation to determine the JDBC class name and the connection string for your Pentaho Repository database.

2. Navigate to the server/pentaho-server/tomcat/webapps/pentaho/META-INF directory and open the context.xml file with any text editor.

3. Add the following code to the file if it does not already exist. Replace XE in the URL setting with your schema name.

   <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="oracle.jdbc.OracleDriver"
           url="jdbc:oracle:thin:@localhost:1521/XE" validationQuery="select 1 from dual"
           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="oracle.jdbc.OracleDriver"
           url="jdbc:oracle:thin:@localhost:1521/XE" validationQuery="select 1 from dual"/>
   <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="quartz" password="password" testOnBorrow="true"
           driverClassName="oracle.jdbc.OracleDriver"
           url="jdbc:oracle:thin:@localhost:1521/XE" validationQuery="select 1 from dual"/>
   <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="pentaho_operations_mart" password="password"
           driverClassName="oracle.jdbc.OracleDriver"
           url="jdbc:oracle:thin:@localhost:1521/XE" validationQuery="select 1 from dual"/>
   <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="pentaho_operations_mart" password="password"
           driverClassName="oracle.jdbc.OracleDriver"
           url="jdbc:oracle:thin:@localhost:1521/XE" validationQuery="select 1 from dual"/>
   <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="pentaho_dilogs" password="password"
           driverClassName="oracle.jdbc.OracleDriver"
           url="jdbc:oracle:thin:@localhost:1521/XE" validationQuery="select 1 from dual"/>
   <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 from dual"/>
   <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 from dual"/>
   <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="oracle.jdbc.OracleDriver"
           url="jdbc:oracle:thin:@localhost:1521/XE"
           validationQuery="select 1 from dual"/>

4. Modify the username, password, driver class information, IP address (or domain name), and port numbers to match your environment.

5. Comment out any resource references that refer to other databases.

6. Verify that the validationQuery variable for your database is set to validationQuery="select 1 from dual".

7. Save the context.xml file, then close it.

Start Your Server

Now that you have completed the initial Pentaho Archive installation steps, you are ready to start the Pentaho Server.

Learn more