Applies to Collaborator 11.4, last modified on December 3, 2018

This manual assumes you already have Oracle Database Server installed and running.

Note: Oracle database is only supported in Collaborator Enterprise. For a complete list of differences between Collaborator editions, see the comparison page.

Supported Versions

The versions we have tested against are:

  • 11gR2 Personal Edition
  • 12c Standard Edition

Your experience may vary with other versions.

Download Oracle Components

Configure Database

Create a database for Collaborator. It is recommended that you also create a username and password pair just for Collaborator and give this account full access to the database and no access to other databases.

In order to use extended search, your Oracle administrator would need to install the CTX_DDL PL/SQL package on your DB server and grant the EXECUTE privileges on CTX_DDL to your Oracle user of Collaborator Server. Once done, restart your Collaborator server to complete its upgrade.

During the GUI installation screens for the Collaborator server, you will be prompted for the Oracle server host name, TCP/IP port (default is 1521), database service name (not the SID), user name, and password. The installer will not report any connectivity errors.

The database service name is not the same thing as the SID. This change was made by Oracle in version 9iR2.
The database service name is fully-qualified, corresponding to GLOBAL_DBNAME in the .ora file – for example, mysid.mydomain.com. The database service name is also sometimes referred to as TNS alias or connect descriptor.
The SID is the shorter name, corresponding to SID_NAME in the .ora file.

Note: When you first visit the web page for Collaborator, it will detect that you have a new database and will create all tables, indexes, and views for you automatically, or give you an appropriate error message if there is a connectivity problem. Connectivity problems should be resolved by re-running the installer.

To install the driver:

  1. Download the JDBC driver.

  2. Stop the Collaborator server, if it is running.

  3. Copy the downloaded ojdbcN.jar file to the <Collaborator installation directory>/tomcat/lib folder.

  4. Start the Collaborator server.

Oracle Limitations

  • Oracle 11g server with non-English locale: An error may occur when initializing Collaborator database on Oracle 11g servers with non-English locale. To avoid the problem:

    1. Append the following Java VM options to the <Collaborator server installation folder>/ccollab-server.vmoptions file:

      -Duser.country=US
      -Duser.language=en
    2. Restart Collaborator server to apply the changes.

    3. Open the Collaborator web client and proceed with database initialization.

  • Double quote characters (") in custom field names may break Oracle reporting views. Custom field names become column headers in the views, and Oracle does not allow double quotes in column names. Because of this, Collaborator removes double quote characters from the names of custom fields when it creates reporting views for Oracle databases.
    If some custom field names differ only by double quotes, this would result in an "ORA-00957: duplicate column name" error in server logs. To resolve the issue, you may either remove one of duplicate column names from the reporting view, or rename the custom fields to avoid coincidence.

  • Loading large dump files to Oracle may take up to a full day to complete. This appears to be an issue with Oracle driver and is under investigation.

  • On Oracle databases, Collaborator does not search the contents of custom fields by default (since this significantly reduces search performance). Instead, the search results page display additional fields that define in what areas to perform new search. In this panel you can enable searching in custom fields. Also, predefined search scopes can be configured via VM options.

Troubleshooting

We use the Oracle JDBC driver to connect to your Oracle database. The driver has a few undocumented behaviors that may come as a surprise. There are threads on the Oracle tech support forums about this.

Most of the problems arise in the GLOBAL_DBNAME field in your SID_DESC entry from your listener.ora file. A typical entry might look like this:

(SID_DESC =
(GLOBAL_DBNAME = mysid.mydomain.com)
(ORACLE_HOME = /app1/oracle1/product/10.2.0.1)
(SID_NAME = mysid)
)

Most other Oracle-based programs use the SID_NAME field to identify the database, but the JDBC driver uses GLOBAL_DBNAME. This would cause a connection error in the example above.

Note: The database service name is not the same thing as the SID. This change was made by Oracle in version 9iR2. The installer asks for the database service name, not the SID. The database service name is also sometimes referred to as TNS alias or connect descriptor. Typically, this means you should use the GLOBAL_DBNAME in the installer (that is, mysid.mydomain.com) and not just the SID (that is, mysid).

See Also

Installation Steps
Backup and Migration
Database Installation

Highlight search results