Skip to main content
Pentaho Documentation

Use MS SQL Server as Your Repository Database (Manual Installation)

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 Prepare Environment step, and consists of the following four components: 

  • Jackrabbit, which contains the solution repository, examples, security data, and content data from reports that you use Pentaho software to create;
  • Quartz, which holds data that is related to scheduling reports and jobs;
  • Hibernate, which holds data that is related to audit logging; and,
  • Optional Pentaho Operations Mart, which reports on system usage and performance.

Initialize MS SQL Server Pentaho Repository Database

To initialize MS SQL Server so that it serves as the Pentaho Repository, you will need to run a few SQL scripts to create the Hibernate, Quartz, and Jackrabbit (JCR) databases.

Use the ASCII character set when you run these scripts. Do not use UTF-8 because there are text string length limitations that might cause the scripts to fail.

The next few sections take you through the steps to initialize the MS SQL Server Pentaho repository database.

Step 1: Adjust MS SQL Server Configuration Settings 

Configure the following MS SQL Server settings in Microsoft SQL Server Management Studio or other tool of your choice. 

  • Select SQL Server and Windows Authentication Mode ​to use mixed authentication.
  • Enable TCP/IP for MS SQL Server.
  • Make sure that MS SQL Server is listening on an external IP, and not localhost.

Step 2: Change Default Passwords

For your production server, we highly recommend that you change the default passwords in the following SQL script files to make the databases more secure. 

If you are evaluating Pentaho, then you might want to skip this step.

To change the passwords, go to the pentaho/server/pentaho-server/data/sqlserver/ directory and use any text editor to change the passwords in these SQL scripts:

  • create_jcr_sqlServer.sql
  • create_quartz_sqlServer.sql
  • create_repository_sqlServer.sql
  • pentaho_mart_sqlServer.sql

Step 3: Run SQL Scripts

You will need to run the SQL scripts in the table below.

These scripts administrator permissions on the server in order to run them. 

If you have a different port or different password, make sure that you change the password and port numbers in these examples to match the ones in your configuration.

Run the scripts from the sqlcmd utility window or from Microsoft SQL Server Management Studio.

Action SQL Script
Create Quartz -i <filepath to DDL>/create_quartz_sqlServer.sql
Create Hibernate repository -i <filepath to DDL>/create_repository_sqlServer.sql
Create Jackrabbit -i <filepath to DDL>/create_jcr_sqlServer.sql
Create Pentaho Operations Mart -i <filepath to DDL>/pentaho_mart_sqlServer.sql

Step 4: Verify MS SQL Server Initialization

After you run the scripts, perform the following steps to verify that databases and user roles have been created:

  1. Open MS SQL Server Management Studio.
  2. In the Object Explorer section of the window, make sure that the Quartz, Jackrabbit (JCR), Hibernate, and Pentaho Operations Mart databases are present.
  3. Navigate to Security > Logins and make sure that the appropriate users have been created. 
  4. Exit from MS SQL Server Management Studio tool.

Configure MS SQL Server 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 MS SQL Server database.

By default, the examples in this section are for a MS SQL Server database that runs on port 1433. The default password is also in these examples.

If you have a different port or different password, make sure that you change the password and port number in these examples to match those in your configuration.

Step 1: Set Up Quartz on MS SQL Server Pentaho Repository Database

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/quartz/quartz.properties file in any text editor.
  2. Locate the #_replace_jobstore_properties section and set the org.quartz.jobStore.driverDelegateClass as shown here.
    org.quartz.jobStore.driverDelegateClass = org.quartz.impl.jdbcjobstore.MSSQLDelegate
    
  3. Locate the # Configure Datasources section and set the org.quartz.dataSource.myDS.jndiURL equal to Quartz, like this.
    org.quartz.dataSource.myDS.jndiURL = Quartz
    
  4. Save the file and close the text editor.

Step 2: Set Hibernate Settings for MS SQL Server

Modify the Hibernate settings file to specify where Pentaho should find the repository’s Hibernate config file.

The Hibernate config file specifies driver and connection information, as well as dialects and how to handle connection closes and timeouts.

The files in this section are located in the pentaho/server/pentaho-server/pentaho-solutions/system/hibernate directory.

  1. Open the hibernate-settings.xml file in a text editor. Find the <config-file> tags and change postgresql.hibernate.cfg.xml to sqlserver.hibernate.cfg.xml as shown.
    From:
    <config-file>system/hibernate/postgresql.hibernate.cfg.xml</config-file>
    
    To:
    <config-file>system/hibernate/sqlserver.hibernate.cfg.xml</config-file>
    
  2. Save and close the file.
  3. Open the sqlserver.hibernate.cfg.xml file in a text editor.
  4. Make sure that the password and port number match the ones you specified in your configuration. Make changes if necessary, then save and close the file.

Step 3: Replace Default Version of Audit Log File with MS SQL Server Version

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

  1. Locate the pentaho-solutions/system/dialects/sqlserver/audit_sql.xml file.
  2. Copy it into the pentaho-solutions/system directory.

Step 4: Modify Jackrabbit Repository Information for MS SQL Server

There are parts of code that you will need to alter in order to change the default JCR repository to MS SQL Server.

  1. Navigate to the pentaho/server/pentaho-server/pentaho-solutions/system/jackrabbit and open the repository.xml file with any text editor.
  2. Following the table below, locate and change the code so that the MS SQL Server lines are not commented out, but the MySQL, PostgreSQL and Oracle lines are commented out.

If you have a different port or different password, make sure that you change the password and port number in these examples to match those in your configuration.

Item: Code Section:
Repository
<FileSystem class="org.apache.jackrabbit.core.fs.db.MSSqlFileSystem">
     <param name="driver" value="com.microsoft.sqlserver.jdbc.SQLServerDriver"/>
     <param name="url" value="jdbc:sqlserver://localhost:1433;DatabaseName=jackrabbit"/>
…
<param name="schema" value="mssql"/>
</FileSystem>
DataStore
<DataStore class="org.apache.jackrabbit.core.data.db.DbDataStore">
    <param name="url" value="jdbc:sqlserver://localhost:1433;DatabaseName=jackrabbit"/>
…
<param name="schema" value="mssql"/>
</DataStore>
Workspaces
<FileSystem class="org.apache.jackrabbit.core.fs.db.MSSqlFileSystem">
      <param name="driver" value="com.microsoft.sqlserver.jdbc.SQLServerDriver"/>
      <param name="url" value="jdbc:sqlserver://localhost:1433;DatabaseName=jackrabbit"/>
…
<param name="schema" value="mssql"/>
</FileSystem>

PersistenceManager

(1st part)

<PersistenceManager class="org.apache.jackrabbit.core.persistence.bundle.MSSqlPersistenceManager">
      <param name="url" value="jdbc:sqlserver://localhost:1433;DatabaseName=jackrabbit"/>
…
<param name="schema" value="mssql"/>
</PersistenceManager>
Versioning
<FileSystem class="org.apache.jackrabbit.core.fs.db.MSSqlFileSystem">
      <param name="driver" value="com.microsoft.sqlserver.jdbc.SQLServerDriver"/>
      <param name="url" value="jdbc:sqlserver://localhost:1433;DatabaseName=jackrabbit"/>
…
<param name="schema" value="mssql"/>
</FileSystem>

PersistenceManager

(2nd part)

<PersistenceManager class="org.apache.jackrabbit.core.persistence.bundle.MSSqlPersistenceManager">
      <param name="url" value="jdbc:sqlserver://localhost:1433;DatabaseName=jackrabbit"/>
      …
<param name="schema" value="mssql"/>
</PersistenceManager>

Database Journal

 

<Journal class="org.apache.jackrabbit.core.journal.MSSqlDatabaseJournal">
    <param name="revision" value="${rep.home}/revision.log"/>
    <param name="url" value="jdbc:sqlserver://localhost:1433;DatabaseName=jackrabbit"/>
    <param name="driver" value="com.microsoft.sqlserver.jdbc.SQLServerDriver"/>
    <param name="user" value="jcr_user"/>
    <param name="password" value="password"/>
    <param name="schema" value="mssql"/>
    <param name="schemaObjectPrefix" value="cl_j_"/>
    <param name="janitorEnabled" value="true"/>
    <param name="janitorSleep" value="86400"/>
    <param name="janitorFirstRunHourOfDay" value="3"/>
</Journal>

Are You Using JBoss?

If you are installing your own JBoss web application server, skip the Tomcat section and move on to Prepare JBoss Connections and Web App Servers.

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 section, you will make JDBC and JNDI connections to the Hibernate, Jackrabbit, and Quartz databases.

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 only the Tomcat context.xml file must be modified.

The next couple of sections guide you through the process of working with the JDBC drivers and connection information for Tomcat.

Step 1: Download Drivers and Apply to the Pentaho Server

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

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

  1. Download a JDBC driver JAR from your database vendor or a third-party driver developer.
  2. Copy the JDBC driver JAR you just downloaded to the pentaho/server/pentaho-server/tomcat/lib folder.
  3. Copy the MS SQL driver to pentaho-server/tomcat/lib .
  4. Copy the hsqldb-2.3.2.jar file to pentaho-server/tomcat/lib .

Step 2: Modify JDBC Connection Information in the Tomcat content.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 to reflect your operating environment. You also modify the values for the validationQuery parameters in this file if you have chosen to use an Pentaho Repository database other than MS SQL.

If you have a different user or password, make sure that you change the user and password in these examples to match those in your configuration environment.

  1. Consult your database documentation to determine the JDBC class name and connection string for your Pentaho Repository database.
  2. Go to the pentaho-server/tomcat/webapps/pentaho/META-INF directory and open the context.xml file with any file editor.
  3. Comment out the resource references that refer to databases other than MS SQL Server, such as PostgreSQL, MySQL, and Oracle. Then, add the following code to the file if it does not already exist. Be sure to adjust the port numbers and passwords to reflect your environment, if necessary.
    <Resource validationQuery="select 1" url="jdbc:sqlserver://localhost:1433;DatabaseName=hibernate" driverClassName="com.microsoft.sqlserver.jdbc.SQLServerDriver" password="password" username="hibuser" maxWaitMillis="10000" maxIdle="5" maxTotal="20" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" type="javax.sql.DataSource" auth="Container" name="jdbc/Hibernate"/>
    <Resource validationQuery="select 1" url="jdbc:sqlserver://localhost:1433;DatabaseName=hibernate" driverClassName="com.microsoft.sqlserver.jdbc.SQLServerDriver" password="password" username="hibuser" maxWaitMillis="10000" maxIdle="5" maxTotal="20" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" type="javax.sql.DataSource" auth="Container" name="jdbc/Audit"/>
    <Resource validationQuery="select 1" url="jdbc:sqlserver://localhost:1433;DatabaseName=quartz" driverClassName="com.microsoft.sqlserver.jdbc.SQLServerDriver" password="password" username="pentaho_user" maxWaitMillis="10000" maxIdle="5" maxTotal="20" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" type="javax.sql.DataSource" auth="Container" name="jdbc/Quartz"/>
    <Resource validationQuery="select 1" url="jdbc:sqlserver://localhost:1433;DatabaseName=hibernate" driverClassName="com.microsoft.sqlserver.jdbc.SQLServerDriver" password="password" username="hibuser" maxWaitMillis="10000" maxIdle="5" maxTotal="20" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" type="javax.sql.DataSource" auth="Container" name="jdbc/pentaho_operations_mart"/>
    <Resource validationQuery="select 1" url="jdbc:sqlserver://localhost:1433;DatabaseName=hibernate" driverClassName="com.microsoft.sqlserver.jdbc.SQLServerDriver" password="password" username="hibuser" maxWaitMillis="10000" maxIdle="5" maxTotal="20" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" type="javax.sql.DataSource" auth="Container" name="jdbc/PDI_Operations_Mart"/>
    
  4. Modify the username, password, driver class information, IP address (or domain name), and port numbers so they reflect the correct values for your environment.
  5. Make sure that the validationQuery variable for your database is set to this: validationQuery="select 1"
  6. Save the context.xml file, then close it.

Start Your Server

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

Learn more