To use an Oracle database, configure it to work with the Jazz™ Team
Server.
Before you begin
Ensure that the following prerequisites are met. Consult your
Oracle documentation or an Oracle database administrator (DBA) for
help.
- Oracle is installed on a machine to be used as the database
server. This machine can be a different one from that on which the Jazz Team
Server runs.
- A default database exists on the Oracle server.
Tip: When
you install Oracle, you have the option to create a database automatically.
Important: To ensure proper handling of Unicode content, the
database character set must be UTF-8 encoding.
- The user who performs these instructions has system administration
authority on the Oracle database.
When running Jazz Team
Server on Oracle, create an Oracle tablespace to improve performance.
You must create a user linked to that tablespace.
Remember: Neither of these steps are performed by the database
builder with the repository tools.
About this task
To set up an Oracle database:
Procedure
- Create a tablespace. The
tablespace location must be appropriate to the machine and disk drive.
Note: The
tablespace can have any of these properties:
- A name other than oracle_tbs
- A location in another directory
- A size larger than 1GB. For large installations, you need to allocate
more space.
The example below shows a create statement
executed on a Windows® machine: CREATE BIGFILE TABLESPACE oracle_tbs DATAFILE 'D:\oracle_tbs\oracle_tbs.dbf' SIZE 1G AUTOEXTEND ON EXTENT MANAGEMENT LOCAL AUTOALLOCATE;
Important: The directory path (in this example D:\oracle_tbs)
must exist. It is not necessary to create a separate special tablespace.
You can use the Oracle default USERS tablespace,
but Oracle performs better with a pre-allocated space on the disk
that it manages.
- Create an Oracle user.
After the tablespace
is created, a special Oracle user must be created for Jazz to
use the Oracle database.
In this example, the
user has the name jazzDBuser and password (IDENTIFIED
BY in Oracle terms) jazzDBpswd and
exists in the tablespace created in 1.
CREATE USER jazzDBuser IDENTIFIED BY jazzDBpswd DEFAULT TABLESPACE oracle_tbs;
After
the user is created, the user should be given the necessary permissions
needed to initialize the Jazz database. The following SQL commands
can be used to grant the appropriate permissions:GRANT CREATE SESSION TO jazzDBuser;
GRANT CREATE TABLE, ALTER ANY TABLE, DROP ANY TABLE, CREATE ANY INDEX, ALTER ANY INDEX, DROP ANY INDEX TO jazzDBuser;
GRANT INSERT ANY TABLE, UPDATE ANY TABLE, DELETE ANY TABLE TO jazzDBuser;
GRANT CREATE PROCEDURE TO jazzDBuser;
GRANT CREATE VIEW TO jazzDBuser;
- Locate the file teamserver.properties in
the directory JazzInstallDir/server/conf/jazz and
rename it to teamserver.OtherDBProvider.properties.
- Locate the file teamserver.oracle.properties in
the directory JazzInstallDir/server/conf/jazz and
rename it to teamserver.properties.
Tip: Renaming the original teamserver.properties file
enables you to restore the file to the previous working version. By
default, the DB Provider is derby.
- Configure the server
- Edit the server configuration file if you used a different
user name, password, or db name, installed Oracle server on a different
machine than Jazz Team
Server,
or are using a port other than the default. Open the file teamserver.properties in JazzInstallDir/server/conf/jazz directory,
and change the information listed below to match your setup.
com.ibm.team.repository.db.vendor
= ORACLE
com.ibm.team.repository.db.jdbc.location=thin:jazzDBuser/{password}@localhost:1521/ORCL
Change
jazzDBuser with the user created for Jazz to
use the Oracle database. If you are using localhost, uncomment this
line by removing # from the beginning of the line and comment the
next location line. Localhost connection strings should not include
the preceding //. Change 1521 with your Oracle server machine TCIP
port. Change ORCL with your Oracle database name.
com.ibm.team.repository.db.jdbc.location=thin:jazzDBuser/{password}@//oracleserver.example.com:1521/ORCLRemember: Oracle location URLs can take several forms. The examples
here work under most circumstances. Consult the Oracle JDBC documentation
for more details.
If you are using a non-localhost connection,
uncomment this line by removing the # from the beginning of the line
and comment the previous location line. Non-localhost connection strings
must include the preceding //.
com.ibm.team.repository.db.jdbc.password=jazzDBpswd
Change
jazzDBpswd with the password of the user created for Jazz to
use the Oracle database.
Important: Do not change the {password}
text in the property com.ibm.team.repository.db.jdbc.location.
The user password must be specified in the property com.ibm.team.repository.db.jdbc.password.
If
you are using Oracle Express, use 1521 for TCIP port and XE for Oracle
database name:
com.ibm.team.repository.db.vendor = ORACLE
com.ibm.team.repository.db.jdbc.location=thin:jazzDBuser/{password}@localhost:1521/XE
com.ibm.team.repository.db.jdbc.password=jazzDBpswd
- In the same directory as the server
scripts (JazzInstallDir/server), create a directory
named oracle.
- Locate the Oracle JDBC driver JAR file, named ojdbc14.jar.
The location can vary depending on the Oracle product and operating
system. Copy this file to the directory named oracle.
Note: If you are using WebSphere® Application Server,
configure a property named "ORACLE_JDBC"; then set it to the absolute
file path (not URL) to the Oracle JDBC drivers. This task is described
in the WebSphere Application Server setup instructions.
Make a note of the file path for later use in these instructions.
- Open a SQL plus window and type the following command:
GRANT DBA TO jazzDBuser;
What to do next
You have finished setting up your database and can continue
with
Creating database tables.
Alternatively,
return to the Installation roadmaps to
review the next steps in the installation.