This chapter explains how to use Oracle Database as the ManualWorks database.

If you use Oracle Database, back up your data with the database's own backup features.

ManualWorks stores strings that need Unicode and long text in NVARCHAR2 and NCLOB columns, and other strings in VARCHAR2 columns. When you create the database, we recommend setting the database character set to AL32UTF8 and the national character set to AL16UTF16.

Adding the Oracle JDBC Driver

3RABBITZ_HOME refers to the directory where ManualWorks is installed.

Add the JDBC driver for your Oracle Database version to the 3RABBITZ_HOME/web/WEB-INF/lib directory.

Download the Oracle JDBC driver from the Oracle website. Choose the driver that matches your database and Java versions. For example, use ojdbc8.jar for Java 8 or later, and ojdbc11.jar for Java 11 or later.

Changing the Configuration File

Configure ManualWorks to use Oracle Database as follows.

Open the 3RABBITZ_HOME/tomcat/conf/server.xml file.

<Context docBase="${3rabbitz.home}/web" path=""
  reloadable="false" backgroundProcessorDelay="3">
  <CookieProcessor className="org.apache.tomcat.util.http.LegacyCookieProcessor" />
  <!-- H2 -->
  <Resource name="jdbc/Base" auth="Container" type="javax.sql.DataSource"
    driverClassName="org.h2.Driver" url="jdbc:h2:h2/database;"
    username="database" password="database"
    maxTotal="100" maxIdle="30" maxWaitMillis="10000"/>
  <!-- for Oracle -->
  <!--
  <Resource name="jdbc/Base" auth="Container" type="javax.sql.DataSource"
    maxTotal="100" maxIdle="30" maxWaitMillis="10000"
    username="username" password="password"
    driverClassName="oracle.jdbc.OracleDriver"
    url="jdbc:oracle:thin:@127.0.0.1:1521:rabbitz" />
  -->
</Context>

Comment out the H2 settings.
Uncomment the Oracle settings.
Change username, password, url, and other values.
Start ManualWorks.

ManualWorks creates its tables automatically during installation and software updates. The Oracle account set in username must have privileges to create tables, alter columns, and create and drop indexes.

The server.xml file contains the database account password in plain text. Restrict the file permissions so that only the account that runs ManualWorks can read it. To encrypt the connection information, see Encrypting Database Connection Information.