Setting up an Oracle database for Rational Engineering Lifecycle Manager and the Lifecycle Query Engine

Set up an Oracle database to work with the Rational® Engineering Lifecycle Manager Jazz™ Team Server, the Rational Engineering Lifecycle Manager, and the Configuration Management application.

Before you begin

To create and set up an Oracle database, it is assumed that the user who is preparing the database must have database administration authority over the database and that the database, tablespace storage, and appropriate storage configuration is created by a user with system administration authority. Also one of the following supported Oracle editions must be installed on a computer to be used as the database server. This computer can be different from the one that the Jazz Team Server runs on:
Note: The required Java™ Database Connectivity (JDBC) driver for both Oracle 10g and 11g is ojdbc6.jar 11.2.0.3 or higher. Also always update the database to the latest database version. For example, if the database server is 11.2, then you should be running 11.2.0.3 or later.
Important: The following configuration parameters and tablespace options are examples and might not entirely apply to your environment. For example, if you cannot use the AUTOEXTEND setting, then the files must be large enough to allow for growth. Or if you cannot use the UNLIMITED size quota for the Jazz Team Server database user, then make sure to allow enough space for rapid growth.
Important: If you install the Rational Engineering Lifecycle Manager applications on the same computer or distributed platforms, you can either create separate databases for each application or you can use the same database for all applications. However, you must create a separate tablespace and a database user who is associated with that tablespace for each application.

The examples in this topic are for one Oracle database with separate database users who are dedicated to each application.

Note: The database that you create for the Jazz Team Server and all Rational Engineering Lifecycle Manager applications must be formatted to use UTF-8 as the character set. By default, Oracle does not create a database with the UTF-8 character set. When you create a new database, ensure that you select AL32UTF8 in the Oracle DB setup.

Procedure

  1. As a system administrator, create a database with UTF8 encoding for the Jazz Team Server and all applications.
  2. Open an SQL *Plus window, and create the database tablespaces:
    CREATE TABLESPACE <relmjts user tablespace> 
    DATAFILE '<path and name of .dbf file>' 
    SIZE 1G AUTOEXTEND ON EXTENT MANAGEMENT LOCAL AUTOALLOCATE;
    CREATE TEMPORARY TABLESPACE <relmjts user temp tablespace> 
    TEMPFILE '<path and name of the temp .dbf file>' 
    SIZE 20M AUTOEXTEND ON EXTENT MANAGEMENT LOCAL UNIFORM SIZE 1M;
  3. If you are installing all Rational Engineering Lifecycle Manager applications, you must repeat the previous step 2 times to create a separate tablespace for Rational Engineering Lifecycle Manager JTS (relmjts), Rational Engineering Lifecycle Manager (relm), and Configuration Management application (vvc). In the Oracle Enterprise Manager Database Control, verify the tablespaces you created are displayed and accessible.
  4. Create an Oracle database user for each new tablespace.

    After the table spaces are created, a special Oracle user must be created for each application to use the Oracle database. For multiple Jazz servers that run on one Oracle database, an Oracle database user must be created for each application. The Oracle database user must be able to create database objects in its tablespace (either unlimited or with a space quota) with privileges to create session, table, procedure, and views.

    In these examples replace the phrases in the angle brackets.
    CREATE USER <relmjts db user> IDENTIFIED BY <password> DEFAULT TABLESPACE <relmjts user tablespace> QUOTA UNLIMITED ON <relmjts user tablespace> TEMPORARY TABLESPACE <relmjts user temp tablespace>;
    After the user is created, give the user the necessary permissions needed to initialize the Jazz database. The following SQL command can be used to grant the appropriate permissions:
    GRANT CREATE PROCEDURE, CREATE SESSION, CREATE TABLE, CREATE VIEW TO <relmjts db user>;
    Note: The creation of the warehouse on Oracle requires more permissions as compared to other databases. When you specify the database user in the connection spec for data warehouse, ensure that the database user has DBA permissions. For more information, see Completing the installation. Also, it is assumed that a tablespace named "USERS" already exists. This is a default Oracle tablespace. If this tablespace does not exist in your Oracle database, use the following command to create it.
    CREATE TABLESPACE USERS 
    DATAFILE '<path and name of .dbf file>' 
    SIZE <tablespace size> AUTOEXTEND ON EXTENT MANAGEMENT LOCAL AUTOALLOCATE;
  5. Create an environment variable named ORACLE_JDBC_DRIVER_FILE and point to the ojdbc6.jar JDBC driver. The location can vary depending on the Oracle product and operating system. You can download the supported Oracle JDBC driver (ojdbc6.jar 11.2.0.3) from www.oracle.com.
    1. Click Start > Control Panel > System.
    2. Click the Advanced tab, and then click Environment Variables.
    3. In the System variables list, click New.
    4. In the Variable name enter ORACLE_JDBC_DRIVER_FILE, and in the Variable value enter C:\Path_to_JDBC_dirver\ojdbc6.jar.
    1. On Linux systems, add the following environment variable declaration:
      ORACLE_JDBC_DRIVER_FILE =.;Path_to_JDBC_dirver/ojdbc6.jar
      Note: Rational Engineering Lifecycle Manager does not support JRE 5.0. The version of supported JREs are 6.0 and 7.0. The ojdbc5.jar class library requires JRE 5.0 and the ojdbc6.jar class library requires JRE 6.0 or later. You must use ojdbc6.jar.

      If you are using WebSphere® Application Server, you must also add a custom property that points to the ojdbc6.jar JDBC driver. For more information, see Setting up WebSphere Application Server for Rational Engineering Lifecycle Manager.

  6. To configure your database connection and create database tables complete one of these steps:
    1. If you are using Tomcat, start the server and continue with Running the Jazz Team Server setup wizard for Rational Engineering Lifecycle Manager applications.
    2. If you are deploying WebSphere Application Server, see Running the Jazz Team Server setup wizard for Rational Engineering Lifecycle Manager applications.

Manually configuring an Oracle database

About this task

Running the setup wizard is the recommended method to configure the database connections and create the database tables. To run the setup wizard, follow the instructions in: Running the Jazz Team Server setup wizard for Rational Engineering Lifecycle Manager applications

If you prefer to do this procedure manually, use this topic to edit the teamserver.properties file to set up an Oracle database connection and run the -createTables command to create database tables.

Procedure

  1. For each application, there is a separate teamserver.properties file that you must open and modify. These files are located in their own directories (relmjts, relm, and vvc) in the <JazzInstallDir>/server/conf directory. Open each teamserver.properties file, and specify the database and connection details.
    1. Comment out the following lines under Derby Configuration by placing a number sign (#) before each line:
      # com.ibm.team.repository.db.vendor = DERBY
      # com.ibm.team.repository.db.jdbc.location=conf/relmjts/derby/repositoryDB
    2. Uncomment the following lines under Oracle Configuration by removing the number sign (#) beside each line:
      Note: There are 2 lines for database location provided for each of the repository. One for local systems and one for database servers on remote systems. Only uncomment a line that applies to your environment. The examples here are for a remote server with 2 forward slashes before the server URL, @//oracleserver.example.com:1521/ORCL.
      com.ibm.team.repository.db.vendor = ORACLE
      com.ibm.team.repository.db.jdbc.location=thin:relmjtsDBuser/{password}@//oracleserver.example.com:1521/ORCL
      com.ibm.team.repository.db.jdbc.password=relmjtsDBpswd
    3. Edit the following values in the com.ibm.team.repository.db.jdbc.location and com.ibm.team.datawarehouse.db.jdbc.location lines:
      • //oracleserver.example.com:1521: Type the fully qualified host name of the database server.
      • jtsDBuser: Type the database user.
      • jazzDBuser: Type the data warehouse database user. Must be a DBA.
      • ORCL: Type the Oracle service name. When connecting to an Oracle DB, ensure that the ORCL service name exists on the server computer.
      Remember: Oracle location URLs can take several forms. The examples here work under most circumstances. Consult the Oracle JDBC documentation for more details.
      Note: Do not change the password={password} text in the com.ibm.team.repository.db.jdbc.location and com.ibm.team.datawarehouse.db.jdbc.location properties.
    4. Specify the user password in the com.ibm.team.repository.db.jdbc.password and com.ibm.team.datawarehouse.db.jdbc.password properties.
    5. Change the value of the com.ibm.team.fulltext.indexLocation=conf/relmjts/indices/workitemindex line to the full path location of the full text index. For example, type com.ibm.team.fulltext.indexLocation=c:/Progra~1/IBM/JazzTeamServer/server/conf/relmjts/indices/workitemindex.
    6. Change the value of the com.ibm.team.jfs.index.root.directory=indices line to the full path location of Jazz Foundation Service index root directory. For example, type com.ibm.team.jfs.index.root.directory=c:/Progra~1/IBM/JazzTeamServer/server/conf/relmjts/indices.
  2. After the database is created, run a repository tools command to create database tables.
    Important: Run the createTables command only if this is a new installation.
    Note: The user who runs the -createWarehouse command must have DBA permissions. .
    Note: When you run the repotools command, the teamserver.properties file will be updated and the original file with the original content will be saved in the same directory. You might also see a warning that the Public URI has not been set. You can ignore this warning at this time because the Public URI will be set when Running the Jazz Team Server setup wizard for Rational Engineering Lifecycle Manager applications.
    1. To create the database tables for Jazz Team Server, go to the JazzInstallDir/server directory and run these commands:
      repotools-relmjts -createTables
    2. To create the database tables for the Rational Engineering Lifecycle Manager application, go to the RELMInstallDir/server directory and run these commands:
      repotools-relm -createTables
    3. To create the database tables for the Configuration Management application, go to the VVCInstallDir/server directory and run these commands:
      repotools-vvc -createTables

Feedback