[Collapse]Collaborator 11
 [Expand]General Information/viewarticle/91173/
 [Expand]Getting Started/viewarticle/91524/
 [Collapse]Collaborator Server/viewarticle/91192/
    System Requirements/viewarticle/91535/
   [Collapse]Database Installation/viewarticle/91533/
     SQL Server/viewarticle/91510/
    Server Installation/viewarticle/91241/
   [Expand]Server Upgrades/viewarticle/91207/
    Platform-Specific Notes/viewarticle/91580/
  [Expand]Server Administration/viewarticle/91244/
  [Expand]Collaborator Settings/viewarticle/91193/
 [Expand]Web Client/viewarticle/91304/
 [Expand]Desktop Clients/viewarticle/91320/
 [Expand]Version Control Integrations/viewarticle/91181/
 [Expand]Repository Hosting Service Integrations/viewarticle/91708/
 [Expand]Issue-Tracking Integrations/viewarticle/91689/
 [Expand]External Integrations/viewarticle/91505/
 [Expand]Techniques & Best Practices/viewarticle/91575/
Updated: 5/21/2018 Applies To: Collaborator 11 Rating: No votes Click to rate: PoorNot badAverageGoodExcellent

Collaborator Server > Installation > Database Installation

Top |Previous |Next


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, please see the comparison page.

Supported Versions

The versions we have tested against are:

11gR2 Personal Edition
12c Standard Edition

Your mileage may vary with other versions.

Downloading Oracle Components

Required components

Oracle Database - Oracle database server,
Oracle JDBC drivers - database driver for Java platforms.

Setting up the database

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

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.

Warning: 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 an .ora file. An example would be 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 an .ora file.

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 workaround the problem:
1. Append the following Java VM options to the <collab server install dir>/ccollab-server.vmoptions file:


2. Restart Collaborator server to apply the changes.
3. Open Collaborator Web Client and proceed with database initialization.


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 Oracle's 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:



(ORACLE_HOME = /appl/oracle1/product/

(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.

Also note that 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, and not just the SID (that is, mysid).

© 2018 SmartBear Software. All rights reserved.
Email Send feedback on this document