Preparing Oracle Database for Installation

This page describes how to use codebeamer 8.0 or higher with an Oracle 19.3c database.

Prerequisites

To use this document, familiarity is need with Oracle databases and with database administration.

For the installation/migration, Oracle DBA permissions are needed. Backup all data! Before doing anything, backup the existing database. Also ensure that nobody uses the database during migration, as this may result in data loss.

Prepare new Oracle Schema

1. codebeamer requires UTF8 (AL32UTF8) encoding. Verify the encoding of the database by executing the following query as 'sys'user:
   

   SQL> SELECT value$ FROM sys.props$ WHERE name = 'NLS_CHARACTERSET';
   VALUE$
   
   -----------------------------------------------
   
   AL32UTF8

2. Carefully plan and design the database tablespace allocation schema. Decide which tablespace to use for codebeamer.
   
   
   For extensive documentation, see: http://download.oracle.com/docs/cd/B10501_01/server.920/a96521/tspaces.htm#636
   In this guide, the USERS tablespace is used.
   
   
3. Create the cbroot database user. This must be executed by a sys user.
   
   
   
4. Run sqlplus and connect as "sys as sysdba" to execute following script (use desired tablespace instead of USERS):
   • To check whether Oracle 19.3c depends on Multitenant environment or not, run the following SQL:
     

     SELECT cdb FROM v$database;

     • If NO:
       

       CREATE USER cbroot IDENTIFIED BY cbpassword DEFAULT TABLESPACE USERS QUOTA UNLIMITED ON USERS;
       GRANT CREATE SESSION, CREATE TYPE, CREATE TABLE, CREATE CLUSTER, CREATE TRIGGER, CREATE OPERATOR, CREATE SEQUENCE, CREATE INDEXTYPE, CREATE PROCEDURE, CREATE VIEW To cbroot;
       GRANT EXECUTE ON dbms_obfuscation_toolkit TO cbroot;
       GRANT EXECUTE ON DBMS_LOB TO cbroot;
       GRANT UNLIMITED TABLESPACE TO cbroot;

     • If YES
       A common Oracle account is required:
       

       CREATE USER c##cbroot IDENTIFIED BY cbpassword DEFAULT TABLESPACE USERS QUOTA UNLIMITED ON USERS;
       GRANT CREATE SESSION, CREATE TYPE, CREATE TABLE, CREATE CLUSTER, CREATE TRIGGER, CREATE OPERATOR, CREATE SEQUENCE, CREATE INDEXTYPE, CREATE PROCEDURE, CREATE VIEW To c##cbroot;
       GRANT EXECUTE ON dbms_obfuscation_toolkit TO c##cbroot;
       GRANT EXECUTE ON DBMS_LOB TO c##cbroot;
       GRANT UNLIMITED TABLESPACE TO c##cbroot;

   • To use FULL TEXT SEARCH in the Report module, it is necessary to enable this feature in Oracle: Database Specific Configurations
     
     
     
5. Set up full-text indexing. This is a mandatory prerequisite of a successful database preparation. Run the below SQL scripts before starting codebeamer:
   

   GRANT EXECUTE ON DBMS_LOB TO <database user>;

   
   

   GRANT EXECUTE ON CTXSYS.CTX_DDL TO <database user>;

For details, see Database Specific Configurations

Configure codebeamer to Access the New Oracle Database

1. It must be ensured that codebeamer is not running.
2. Edit the configuration file: <cb-installation-dir>/config/configuration.properties
   

   database.driver=oracle.jdbc.driver.OracleDriver
   database.connectionURL=jdbc:oracle:thin:@//localhost:1521/ORCLCDB
   database.username=user
   database.password=pass
   database.passwordStorageType=PLAIN
   
   

3. Start codebeamer.

The database tables are created automatically upon the first start of codebeamer. This startup takes significantly longer than subsequent startups.

Upgrading an Existing codebeamer Oracle Database to a Newer codebeamer Version

Only the new codebeamer installation is to be configured to access the existing Oracle database (see above). All necessary database upgrades are automatically executed when the new codebeamer instance is started for the first time.

To migrate a codebeamer schema from one Oracle instance to another, export the schema from the old instance and import at the new instance. Then (re-)configure codebeamer to access the new instance.