Installing IBM Rational Team Concert Standard Edition or Enterprise Edition using IBM Installation Manager


This version was built 26 Oct 2009.

The latest version of this installation procedure, along with helpful planning information, can be found online at http://publib.boulder.ibm.com/infocenter/rtc/v2r0m0/index.jsp.

Contents

Installing Rational Team Concert Standard edition and Enterprise edition
Upgrading to Rational Team Concert 2.0
Standard and Enterprise editions installation overview
Preparing to install the Standard or Enterprise edition
Special instructions for Linux
Installing the Standard or Enterprise edition from the IBM Installation Manager
Setting up the database
Setting up a DB2 database
Special DB2 instructions
Setting up an Oracle database
Setting up a SQL Server database
Starting the server
Starting the Apache Tomcat server
Starting the server on Windows
Starting the server on Linux
Setting up a WebSphere Application Server
Running the setup wizard
Completing the installation
Installing the client using the IBM Installation Manager
Installing the Build System Toolkit from the IBM Installation Manager
Installing Rational Team Concert ClearCase Connector using the IBM Installation Manager
Installing Rational Team Concert ClearQuest Connector using the IBM Installation Manager
Installing Rational Team Concert with Security-Enhanced Linux

Installing Rational Team Concert Standard edition and Enterprise edition

Upgrading to Rational Team Concert 2.0

Generally, you can upgrade Rational Team Concert™ clients and servers by either performing a zip or IBM® Installation Manager install.

Note:
If you use the IBM Installation Manager to install Rational Team Concert 2.0 on a computer where Rational Team Concert is not currently installed, the Installation Manager prompts you to select the languages to install. However if you update from an earlier version to 2.0, the IBM Installation Manager assumes that you want to use the current languages and does not prompt you to select languages. To select the additional languages, after you update to 2.0, select Modify from the main screen in the IBM Installation Manager, then select the offering. The next screen shows the list of supported languages. Select the ones you need.

If you start the Jazz™ Team Server after you update to 2.0 and before you select Modify to add or remove languages, you must reset the server as follows:

  1. In a Web browser, navigate to
    https://<server-host>:<jazz-port>/jazz/admin?internal#action=com.ibm.team.repository.admin.serverReset
  2. Click Request Server Reset.
  3. Shut down the server.

Then you can select Modify in the IBM Installation Manager to add or remove languages.

Compatibility of Rational Team Concert clients and servers

The following table shows the compatibility of Rational Team Concert client versions with Jazz Team Server versions.

Table 1. Client and server compatibility
Rational Team Concert Client version Compatible Jazz Team Server version
1.0.x for Eclipse 0.6.x
2.0.x for Eclipse 1.0.x
2.0.0.0 for Microsoft Visual Studio 1.0.0.0
2.0.0.1 for Microsoft Visual Studio 1.0.0.1

Upgrading a Rational Team Concert Client for Eclipse IDE

If you have 1.0, 1.0.1, or 1.0.1.1 versions of the Client for Eclipse IDE, it is required that you obtain the 2.0 client to connect to your new version 2.0 server. You can install this using a zip file, or you can update your prior IBM Installation Manager installs.

Installing a Rational Team Concert Client for Microsoft® Visual Studio IDE

If you have 1.0.1.1 version of the Client for Microsoft Visual Studio IDE, it is required that you obtain the 2.0 client to connect to your new version 2.0 server.

Remember:
A .zip file is not provided for the Client for Microsoft Visual Studio. To install or upgrade to version 2.0, you must use IBM Installation Manager.

Upgrading a Server from a Trial or Early Access release to a Permanent release

If you are running an Early Access release of Rational Team Concert, first upgrade to the 2.0 Trial release.

From the 2.0 Trial release, you can make your server Permanent by purchasing and installing the Server Activation Kit for your edition, which is available here: http://www.ibm.com/software/awdtools/rtc/. The activation kit consists of a JAR file containing the Permanent server key. It is installed using the License Key Management page of your server's administrative Web interface.

Upgrading a Server from 1.0, 1.0.1, or 1.0.1.1

You can upgrade directly to the 2.0 release of Rational Team Concert from the previous releases. A database migration is required for 1.x to 2.x updates. For information on performing a database migration, see Migrating Jazz repository after upgrading Jazz Team Server.

Note:
Before you begin upgrading a WebSphere® Application Server, reset the server by navigating to https://servername:9443/jazz/admin#action=com.ibm.team.repository.admin.serverReset and clicking Request Server Reset.

If you installed the previous release from a zip file, then there is no intersection with the previous install. You can install the 2.0 release from a zip in a new location, or you can use the IBM Installation Manager to install an instance of 2.0.

If you used IBM Installation Manager to install the previous release, you can either install 2.0 as a separate instance or update the previous instance to 2.0. If you install a separate instance of the server for the 2.0 release, select Create a new package group on the Install Packages page of the installation wizard.

Note:
To upgrade a WebSphere Application Server deployment of the Jazz Team Server, remove the previous jazz.war file and deploy the 2.0 jazz.war file.

To complete the upgrade, see Copying the required configuration files from a previous server installation and Installing 2.0 Activation Keys.

Upgrading a Server from one Rational Team Concert edition to another

You can upgrade between Rational Team Concert editions. Typical upgrades include moving from Express-C to Express™, or Express to Standard. You can also downgrade in the opposite direction by following the same process.

Because all Rational Team Concert 2.0 editions support Derby databases, you do not need to migrate from Derby to DB2® or Oracle if you are moving from Express-C to Express or Standard. We recommend that you migrate your server edition first, make sure things work smoothly with the existing database, and then perform a database migration if required. For information on performing a database migration, see Migrating Jazz repository after upgrading Jazz Team Server.

If you have installed a Rational Team Concert 2.0 edition and want to upgrade to another, download and install the new edition, alongside the existing edition, and then copy the required configuration files to run the new edition. The section below describes the configuration files that you require.

If you installed your previous edition from a zip file, then there is no intersection with the previous install. You can install the new edition from a zip in a new location, or you can use the IBM Installation Manager install for the new edition. We recommend that the IBM Installation Manager be used for production servers to enable future updates to be applied.

If you used IBM Installation Manager to perform your previous server install, and want to use IBM Installation Manager to install your new edition, during the new Installation Manager install, do not overlay the previous edition. On the Install Packages page of the installation wizard, select Create a new package group.

This will install the new edition in a different location and create program shortcuts using the new package group name.

If you do not perform this task, the installation will fail with a file collision. This occurs if you see an error dialog titled Installation Failed, and the details show the following text:

Installation failed.
  Error during "install" phase:
    Failed to extract zip standard 1.0.1.I20081018-1820.  File
    D:\JazzTeamServer\server\license-update-site\site.xml already exists.

If this occurs, it is not fatal; you can restart the installation and correctly create a new package group.

WebSphere Application Server configuration updates

The following steps are required to properly configure WebSphere Application Server in Rational Team Concert 2.0.

  1. Ensure that the latest fix packs for WAS and WASDK are installed. If deploying in WAS 7.0, it is critical that at least WebSphere Application Server 7.0.0.3 is installed.
  2. Remove the old custom JVM properties:
    1. com.ibm.team.repository.provision.profile
    2. com.ibm.team.server.configURL
    3. log4j.configuration
  3. Add the new custom JVM property JAZZ_HOME and set the value to:
    file:///<JazzInstallDir>/server/conf
  4. Ensure that the WAS security setting "Use available authentication data when an unprotected URI is accessed" is checked. If you are using the WAS Integrated Solutions Console, you can do this by:
    1. Navigating to Security -> Secure administration, applications, and infrastructure -> Web Security - General Settings.
    2. Selecting the checkbox for "Use available authentication data when an unprotected URI is accessed".

Copying the required configuration files from a previous server installation

Copy the following files from the source server to the target server. First, rename the original files in the upgraded server install to create backups. If you used the IBM Installation Manager to update from 1.0, 1.0.1, or 1.0.1.1 to 2.0, a backup directory containing your 1.0.x configuration files was created with a name, such as backup-config-timestamp in the server subdirectory of the installation location.

If you are upgrading to Standard or Enterprise edition, and you have purchased the Developer Client Activation Kit for Express, purchase and install the Developer Client Activation Kit for Standard or Enterprise Editions, so that you can use those client licenses. Your Developer license assignments will still be in effect, but the Developer licenses will be deactivated until the correct activation kit is installed.

Installing 2.0 Activation Keys

The 2.0 release uses the 2.0 Activation keys. If a server is upgraded from 1.0.x.x to 2.0, it reverts to a trial license after the upgrade, and you need to obtain the 2.0 activation keys from Passport Advantage®. Below are the names of the applicable keys for each kit:

Setting a project timeline

In Rational Team Concert 1.x, projects could have multiple timelines (previously called "development lines") and all of these timelines were considered equal.

In Rational Team Concert 2.0, projects can still have multiple timelines, but one of them can be marked as the "project timeline". When migrating your database to 2.0, the project's primary timeline is not known, so your projects will not have a project timeline set. You can manually update your projects to set the project timeline, after you upgrade to 2.0

Configuring the Source Control snapshot

The Source Control Management (SCM) snapshot for the Data Warehouse collects data on streams, including information about the size of streams and the activity (change set and file/folder changes) within it. In version 1.0, this snapshot automatically collected information about all streams. As this can be a costly operation, in version 2.0, the configurability options are added to the SCM snapshot to let the users decide for which streams the data should be collected. The immediate impact of this change is that, unless you configure it, no data will be collected.

To configure the SCM snapshot:

  1. You must have write permissions for the stream that you want to collect data for.
  2. Go to the Reports page in Web UI.
  3. In the left navigation panel, select Administer SCM Snapshot. A list of streams are displayed.
  4. Select the checkbox for one or more streams, and then select Save Changes.

Data will be collected for the selected streams in all subsequent snapshots.

Incompatible changes to BIRT reports

If you have used the BIRT report designer to create your own report templates, you may run into one or more problems when trying to use these reports in version 2.0. You should be aware of the following issues:

Import of the Work Items data in the data warehouse

In Rational Team Concert 2.0, there are several schema changes to the work items tables in the data warehouse. As a consequence, when migrating from 1.0 to 2.0, the importer will ignore any warehoused work items data. As a result, when you start the 2.0 server for the first time, your work items reports may not function correctly. The workaround is either to wait for the work items snapshot to run for the first time, or to manually cause it to run after you start the server. On the first run after migration, the work items snapshot will reconstitute the entire historical work items information in the data warehouse. This also means that the first run of the snapshot after migration is likely to take much longer than an average nightly run.

Discovering new reports

In Rational Team Concert 2.0, several new reports are added. While these reports appear in the new process templates that ship with the product, they are not automatically added to the existing project areas on migration. We have added a new action that will help you to discover and deploy these new report templates in your existing project areas after migration. To deploy new report templates:

  1. In the rich client, open the Team Artifacts view.
  2. Expand your project area, expand Reports.
  3. Right-click Report Templates and select Deploy New Templates.

The dialog will help you to discover any report templates which are available but not already deployed to your project area. You may select one or more of them and they will be created. After creation, you may create new reports from those templates using the available menu actions.

Customizations

Changes that you make to work item types, attributes, workflows, roles, and event handlers are preserved when you upgrade from 1.x to 2.0. If you customized a predefined process template (such as Scrum), be aware that if you redeploy the predefined template (in the Process Templates view), you will overwrite your customizations. If you need to redeploy the predefined template, you should first change the name and ID of the predefined template that you customized, so it will not be overwritten.

Standard and Enterprise editions installation overview

The installation package includes everything you need to get started.

The default configuration includes:

Note:
An optional is available within the online help to help you choose your configuration and record your decisions.

Preparing to install the Standard or Enterprise edition

Before installing the server verify the special considerations are met.

Special instructions for Linux

Review the following special instructions when the Jazz Team Server is installed on Linux.

Installing the Standard or Enterprise edition from the IBM Installation Manager

After obtaining the installation files, start the installation.

About this task

The Jazz Team Server, Rational Team Concert client, Build System Toolkit, ClearCase® Connector, ClearQuest® Connector and other incubator files can be downloaded from http://jazz.net. To purchase Rational Team Concert, go to http://www.ibm.com/software/awdtools/rtc/, where you can download an installable image or order a DVD.

  1. Download one of the following installation packages. Choose the platform you are installing on.

    There are two methods to install Rational Team Concert Standard edition or Enterprise Edition by using IBM Installation Manager.

  2. Start the launchpad program.

    If the Installation Manager is not running, start it.

    Note:
    You must have administrator privileges to run the launchpad program.
  3. When the launchpad program starts, you see a list of items to install. Install each package that you want to use in the order listed.
    1. Install the Jazz Team Server.

      When using the IBM Installation Manager, note the Installation Directory on the Location page during the installation process. The directory is referred to as JazzInstallDir.

      Note:
      If you are planning to use an existing application server, instead of the included Apache Tomcat server, clear the Apache Tomcat package check box. Doing so, installs only the files required to use with your existing application server. The Installation Manager prompts you to choose a location to install these files.
    2. Optional: Install DB2 Workgroup Server.
      Note:
      Although a Derby database is included in the default configuration and requires no installation, this database cannot support more than 10 users. If you want to support more than 10 users and do not have access to an existing DB2 or Oracle database, install the bundled DB2 Workgroup Server edition.

      If you install DB2 Workgroup Server, record the user ID, password and port number. This information is needed later. Accepting the defaults during the installation simplifies the Jazz Team Server configuration.

    3. Install the Rational Team Concert client.
    4. Optional: Install the Build System Toolkit.
    5. Optional: Install the ClearCase Connector.
    6. Optional: Install the ClearQuest Connector.

Setting up the database

After your database is installed, configuration work is required.

Fast path:
If you are using the included Derby database no additional setup is necessary. Proceed to Starting the server.

The overview steps for setting up a database are:

  1. Create a database.
  2. Configure the properties files.
  3. Create the database tables.

If you are using any supported DB2 editions, proceed to Setting up a DB2 database.

If you are using Oracle, proceed to Setting up an Oracle database.

If you are using SQL Server, proceed to Setting up a SQL Server database.

Setting up a DB2 database

Set up a supported DB2 or the bundled DB2 Workgroup Server database to work with the Jazz Team Server.

Before you begin

This procedure assumes the following prerequisites have been met. Consult your DB2 documentation or a DB2 database administrator (DBA) for help.

About this task

To set up a DB2 database:

  1. Create the database in the DB2 Command Window. The example commands create a new database called JAZZ. These commands run in the DB2 Command Window. The Command Window can be opened from the application Start menu under the DB2 Command Line Tools menu.
    Note:
    To ensure proper handling of Unicode content, the database character set must be UTF-8 encoding. Because the AUDITABLE_LINKS table does not fit in the default page size of 4K on Windows, set the page size to at least 8K.
    Tip:
    If the database is not running, the command db2start starts DB2.
  2. Locate the file teamserver.properties in the directory JazzInstallDir/server/conf/jazz and rename it to teamserver.derby.properties.
  3. Locate the file teamserver.db2.properties in the directory JazzInstallDir/server/conf/jazz and rename it to teamserver.properties.
  4. Specify the database and connection details in the file teamserver.properties.

    The default connection specification connects to a DB2 database that runs on localhost on port 50000. The database is called JAZZ, and both the user name and password are db2admin. If the default values were used when setting up your database, the teamserver.properties file might already be configured correctly. If not, change this information to match your configuration.

    1. Open the file teamserver.properties in a text editor.
    2. Locate the following lines:
      com.ibm.team.repository.db.vendor = DB2
      com.ibm.team.repository.db.jdbc.location=//localhost:50000/JAZZ:user=db2admin;password={password};
      com.ibm.team.repository.db.jdbc.password=db2admin
    3. Edit the value of com.ibm.team.repository.db.jdbc.location for your DB2 server and database.
      Tip:
      In the DB2 Command Window, run the command db2 get dbm cfg, then find the line that contains SVCENAME, which indicates the DB2 port name or number. If this command displays a number, use it as the port number (in place of 50000 in the example above). If the command returns a non-numeric name, determine what port number was assigned for this name and use that port number. On Linux, the file /etc/services contains the mapping between port names and numbers, and on Windows, the file C:\windows\system32\drivers\etc\services contains the mapping. For more information, ask your database administrator or consult the database documentation.
    4. Edit the value of com.ibm.team.repository.db.jdbc.location for your DB2 user name.
      Note:
      The DB2 user must have permissions to create tables, tablespaces, and modify the database configuration. DB2 users are created by the operating system.
    5. Specify the user password in the property com.ibm.team.repository.db.jdbc.password.
      Note:
      Do not change the password={password} text in the com.ibm.team.repository.db.jdbc.location property.
    6. If necessary, change the property com.ibm.team.repository.db.db2.content.tablespace.location to a path on your Jazz Team Server where the main tablespace can be created.
      Note:
      If this value is not changed from the default of content_tablespace, the tablespace is created under the database storage location. On Windows, if a new path is specified, it must be specified by using double backslashes, for example: com.ibm.team.repository.db.db2.content.tablespace.location=c:\\db2\\jazz\\content_tablespace.

Special DB2 instructions

Review the following information when using a DB2 database.

Note:
Commands listed in this topic are only examples. Consult your product documentation for details.
Note:
An 8 KB page size is required when creating a database in DB2.

Review the DB2 documentation to verify your system meets the requirements and is configured correctly.

To take advantage of state-selection fetching optimization, which can improve performance on large databases, DB2 users must set DB2_OPTPROFILE. Run the following commands to set DB2_OPTPROFILE.

db2set DB2_OPTPROFILE=YES
db2stop
db2start
Note:
After the command runs, stop and restart the database. A later step in the installation process requires you to stop and start the database. If you are just beginning the installation, you can restart the database then.

Make sure all the above succeed. To see if it is set run the command:

db2set DB2_OPTPROFILE

Setting up an Oracle database

Set up an Oracle database to work with the Jazz Team Server.

Before you begin

This assumes the following prerequisites have been met. Consult your Oracle documentation or an Oracle database administrator (DBA) for help.

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:

  1. Create a tablespace. The tablespace location must be appropriate to the machine and disk drive. This step must be performed by a user with DBA privileges.
    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.
  2. 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;
  3. Locate the file teamserver.properties in the directory JazzInstallDir/server/conf/jazz and rename it to teamserver.OtherDBProvider.properties.
  4. 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.
  5. Configure the server
    1. 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/ORCL

      Remember:
      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
    2. In the same directory as the server scripts (JazzInstallDir/server), create a directory named oracle.
    3. 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 directory path (not URL) that contains the Oracle JDBC drivers, for example, if your ojdbc14.jar is located under JazzInstallDir/server/oracle. This task is described in the WebSphere Application Server setup instructions. Make a note of the file path for later use in these instructions.
  6. Open a SQL plus window and type the following command:
    GRANT DBA TO jazzDBuser;

Setting up a SQL Server database

Set up a SQL Server database to work with the Jazz Team Server.

This procedure assumes that the following prerequisites have been met:

Remember:
The default login name defined in JazzInstallDir/server/teamserver.properties file for a SQL Server database is jazzDBuser and the default password is jazzDBpswd. These values are used in the steps below for creating a database. You can substitute these values with the user name and password for your database.

Setting up a database

This section describes how to set up the SQL Server database by using the command line tool sqlcmd, which is provided with the SQL Server installation. You can also use a visual tool, such as SQL Server Studio Management, which is also available for the Express version as SQL Server Studio Management Express. See the SQL Server documentation or an SQL Server database administrator (DBA) for more information.

To set up an SQL Server database by using the command tool sqlcmd:

  1. Create a Jazz Team Server database. From the command line tool, type:
    CREATE DATABASE jazz 
    GO 
  2. Create a user and password and change the ownership of the Jazz Team Server database. From the command line tool, type:
    CREATE LOGIN jazzDBuser
    WITH PASSWORD = 'jazzDBpswd';
    USE jazz;
    exec sp_changedbowner 'jazzDBuser'
    GO 
  3. Change the collation of the Jazz Team Server database. From the command line tool, type:
    ALTER DATABASE jazz COLLATE SQL_Latin1_General_CP437_CS_AS 
    GO

Configuring the server

Remember:
By default, the teamserver.properties file in JazzInstallDir/server directory is not set up to connect to a SQL Server database. All default settings, along with SQL Server-specific settings, are contained in the teamserver.sqlserver.properties file in the same directory.

To configure the server:

  1. Rename the following files:
    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.
  2. Edit the server configuration file if you used a different user name, password, or db name, installed SQL 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 = SQLSERVER
    com.ibm.team.repository.db.jdbc.location=//SQL SERVER MACHINE IP:SQL SERVER TCIP PORT;databaseName=JAZZ DATABASE NAME;user=JAZZ USERNAME;password={password}
    com.ibm.team.repository.db.jdbc.password=JAZZ LOGIN PASSWORD
    Important:
    Do not change the password={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.
Important:
For Windows only. Ensure that your server security is in mixed mode. You can verify this by checking the server security. It should be set to "SQL Server and Windows Authentication Mode".

To specify the jar file location for JDBC:

  1. In the same directory as the server scripts (JazzInstallDir/server), create a directory named sqlserver.
  2. Locate the SQL Server JDBC driver JAR file, named sqljdbc.jar. The location can vary depending on where the drivers were installed, as noted in the prerequisites section. Copy the file into the newly created sqlserver directory.
  3. Specify the JDBC JAR file location for JDBC by completing the following task:

Troubleshooting

If the repotools command does not succeed, check the log file named repotools_createTables.log, located in the JazzInstallDir/server directory.

Also, verify the following:

Note:
The database code for Jazz Team Server was designed to be generic and standard in order to run on multiple database platforms; however, differences between the enterprise database vendors exist in syntax, optimization strategies, and locking semantics. The server has been tested on SQL Server using a combination of automated tests and simulations of normal workloads and stress testing. The simulation of normal workloads showed acceptable performance. In some instances database deadlocks have been observed in automated concurrency tests; however, these have not been consistently reproduced on different server hardware.

The server is designed to service a large number of simultaneous requests. In exceptional cases, deadlocks can occur in the repository database, as similar or equal objects are updated concurrently in transactions associated with the requests. These are rare, but normal events. The system is designed to be defensive against this, and data integrity is maintained; there is no loss of data. Occasionally, deadlocks are logged by tasks, such as build engine execution. Generally, the condition is detected, and the task is re-tried. The deadlock can result in a failed build. In very rare cases, it can be a user action, such as working with work items or source code, that is aborted to resolve a deadlock. In that case, the user action fails and an error with details regarding a deadlock is displayed to the user. The user can then retry the action.

All deadlocks encountered are logged on the server to provide information about what happened when the deadlock occurred. The log entry has text similar to the following: com.ibm.team.repository.common.RetryableDatabaseException: Serialization failure.

If your system encounters deadlocks, see the error log, which is available at https://servername:9443/jazz/service/com.ibm.team.repository.common.internal.IFeedService?category=SystemLog.

If you encounter frequent deadlock exceptions, contact your product support, or check the forums on jazz.net for the latest information, updates, or mitigating techniques.

Starting the server

This topic describes the different options for running the server startup scripts.

About this task

If you plan to use the included Apache Tomcat application server, you are ready to start the Jazz Team Server.

If you plan to use the WebSphere Application Server, set up your server environment as described in Setting up a WebSphere Application Server.

Starting the Apache Tomcat server

You are now ready to start the Apache Tomcat server.

Apache Tomcat has been installed in the directory JazzInstallDir/server/tomcat. The Web application (jazz.war) has been installed in the Apache Tomcat directory webapps. In a command window, set your current directory to JazzInstallDir/server. The server startup and shutdown scripts are located in this directory.

Starting the server on Windows

Run the startup file to start your server on Windows.

About this task

  1. To start the server, from the JazzInstallDir/server directory, run this command:
    server.startup.bat
    Note:
    A separate Apache Tomcat console window opens. Do not close this window or the server will stop working. Also, several informational messages launch, including a message about the Apache Tomcat Native Library. These informational messages do not affect the Jazz Team Server functionality.
  2. To stop the server, from the JazzInstallDir/server directory, run this command:
    server.shutdown.bat

What to do next

Note:
The example above runs the start and stop scripts directly from the directory JazzInstallDir/server. If you installed Jazz Team Server using IBM Installation Manager, you can also run the commands from the Jazz Team Server Windows start menu.

After the server is started, proceed to Running the setup wizard.

Starting the server on Linux

Run the startup file to start server on Linux.

About this task

  1. To start the server, from the JazzInstallDir/server directory, as user root, run this command:
    ./server.startup
    If your user ID has administrator access, run this command:
    sudo ./server.startup

    A separate Apache Tomcat console window is not visible. You can check the server startup progress by viewing the log file at JazzInstallDir/server/logs/jazz.log.

  2. To stop the server, from the JazzInstallDir/server directory, as user root, run this command:
    ./server.shutdown
    If your user ID has administrator access, run this command:
    sudo ./server.shutdown

What to do next

Note:
This example runs the start and stop scripts directly from the directory JazzInstallDir/server. If you installed Jazz Team Server by using IBM Installation Manager, you can also run the commands from the Jazz Team Server application start menu.

After the server is started, proceed to Running the setup wizard.

Setting up a WebSphere Application Server

This topic describes how to set up the Jazz Team Server to work with WebSphere Application Server. This setup assumes that you are installing the Jazz Team Server on the same machine as the Websphere Application Server.

Before you begin

Before beginning these steps, you should have the following completed:

Tip:
When using the IBM Installation Manager the Jazz Team Server files can be installed into a Web application directory. During the installation process, you should not install the included Apache Tomcat application server; this makes the Installation Manager ask for a Web Application directory and install only the files needed for WebSphere. The default directory is C:\Program Files\IBM\JazzTeamServer on Windows or /opt/IBM/JazzTeamServer on Linux. The installation directory is referred to as JazzInstallDir in this procedure. If you use the IBM Installation Manager to install the files into the WebSphere Application Server Web applications directory, then you do not need to manually move the files as described above.

About this task

Note:
This document does not teach the configuration of WebSphere authentication or SSL, which is a complex topic. Detailed information about the various authentication and encryption options for WebSphere is covered in the WebSphere Information Center. For more information, go to the WebSphere Information Center and search for Securing applications and their environment. The Jazz Web UI requires that authentication be configured in order to perform authorization and personalize the application.

  1. Review and update the database location in the teamserver.properties file
    com.ibm.team.repository.db.vendor = DB2
    com.ibm.team.repository.db.jdbc.location=//localhost:50000/JAZZ:user=db2admin;password={password};
    com.ibm.team.repository.db.jdbc.password=db2admin
    Note:
    This is a sample DB2 configuration. The teamserver.properties should be updated depending on the database vendor (Oracle/MS-SQL).
  2. Verify or update the WebSphere Application Server level.

    Jazz Team Server requires WebSphere Application Server Version 6.1 with the IBM Java SDK 1.5 SR5 or later Cumulative Fix applied or WebSphere Application Server Version 7.0 with at least 7.0.0.3 installed. The IBM Java SDK 1.5 SR6 SDK update is available from http://www-1.ibm.com/support/docview.wss?rs=180&uid=swg24017492. With WebSphere 6.1 and the GA IBM Java SDK, Jazz starts to report "proxy errors" after some number of operations.

    You must obtain the corresponding WebSphere Application Server i-fixes for fixes to IBM Java SDK 1.5 SR9 or IBM Java SDK 1.6 SR4 that are necessary for IBM Rational Team Concert 2.0 to run correctly. Otherwise, some services in the server might not start correctly. The i-fixes are available under their corresponding WebSphere Application Server APARs. For IBM Java SDK 1.5/WebSphere Application Server 6.1, the APAR is PK85942 and you can download the files from ftp://ftp.software.ibm.com/software/websphere/appserv/support/fixes/PK85942/. Install at least WebSphere Application Server 6.1 fixpack 19 before installing the JRE i-fix. For IBM Java SDK 1.6/WebSphere Application Server 7.0, the APAR is PK 86771 and you can download the files from ftp://ftp.software.ibm.com/software/websphere/appserv/support/fixes/PK86771/.

  3. Update the JVM arguments.

    The Jazz Team Server needs some specific settings on the Java Virtual Machine in which it is run.

    First, it needs to know where to find some configuration files. This is done by setting a system property JAZZ_HOME. This property uses a URL rather than a simple path, so the value should be specified as a file://-style URL.

    The second property which is required for the Jazz JVM is to provide it with more than the default maximum memory allocation, using the -Xmx setting. This should be set based on the size of the team supported by the server and the memory capacity of the server where Jazz Team Server is running. A typical medium-size team can use a value of -Xmx1536M, providing 1536 MB of heap memory for the Jazz Team Server process.

    If you are connecting to an Oracle or SQL Server database then you need to add a property named "ORACLE_JDBC" or "SQLSERVER_JDBC". Set the property to the absolute file path (not a URL) to the appropriate jdbc drivers.

    There are a couple other system properties which need to be set to control some behavior of the server, they are included below. Here are the specifics of setting these JVM properties in the WebSphere Administrative Console, substitute JazzInstallDir with your Jazz Team Server installation directory:

    1. Click on Servers -> Application Servers.
    2. Click on server1.
    3. Click on Java and Process Management -> Process Definition.
    4. Click on Java Virtual Machine.
    5. Add the value 100 to the Initial Heap.
    6. Add the value 1000 to the Maximum Heap Size.
    7. Click Apply.
    8. Click Logging and Tracing. Click Change Log Detail Levels. The Jazz Team Server uses the BIRT reporting engine. To prevent BIRT informational entries from being written to the WebSphere log file, set the logging level to severe for the org.eclipse.birt.* packages. Click Apply.
    9. Click Custom Properties
    10. Add the following properties: Click New; enter the Name and Value; then click OK.
      • Name: java.awt.headless Value: true
      • Name: org.eclipse.emf.ecore.plugin.EcorePlugin.doNotLoadResourcesPlugin Value: true
      • Name: JAZZ_HOME Value: file:///JazzInstallDir/server/conf
    11. Click Save directly to the master configuration.
    Important:
    For Solaris only, you must also add the following Java command line argument:
    -XX:MaxPermSize=256m
    For additional information, see Chapter 2, "Configuring a Solaris environment for WebSphere Application Server" of the IBM WebSphere Application Server V6.1 on the Solaris 10 Operating System redbook.
  4. Restart Websphere to install the Jazz Application

    In the following command line examples, WASInstallDir represents the location where WebSphere Application Server is installed on your server.

    1. Open the Admin console for your WebSphere Application Server.
    2. Click on Applications -> Install New Application.
    3. Under Path to new Application, click Local file system.
    4. Under Full path enter:
      JazzInstallDir/server/jazz.war
    5. Set Context Root to /jazz.
    6. Click Next and continue through the remaining Install New Application steps.
    7. Click Finish.
    8. Click Save directly to the master configuration.
    9. Click on Applications -> Enterprise Applications.
    10. Select the box next to jazz_war; click Start.

      A green arrow should appear indicating the application started successfully.

What to do next

After the server is started, proceed to Running the setup wizard.

For more information about this topic visit the following links:

http://jazz.net/library/techtip/95

https://jazz.net/wiki/bin/view/Main/WASSetupFAQ

Running the setup wizard

Running the setup wizard verifies that the server is operating properly and guides you through the steps configure the server.

About this task

To verify that the Jazz Team Server is connecting to the database, look at the server log or console output. The connection and database information is echoed on its first access. The directory JazzInstallDir/server/logs is used for the server log files.

This procedure assumes your server is available using the hostname localhost and the default ports 9443. If necessary, replace localhost with your server hostname and replace the port 9443.

Start the setup wizard to configure your server. Use the URL https://localhost:9443/jazz/setup.
The default user name and password are case-sensitive:

If you configured the LDAP directory Web container, log in with a JazzAdmin user that is defined in your LDAP directory.

Choose a setup path. The setup wizard has two main paths.



When the initial setup is complete, additional options can be configured from the Jazz Team Server Admin Web user interface by using the URL https://localhost:9443/jazz/admin.

What to do next

If the server setup wizard does not load, check the following items:

Completing the installation

After the server is installed, you must consider some configuration options before continuing.

About this task

After the installation, there are a few additional actions to take.

Installing the client using the IBM Installation Manager

The client is distributed as a downloadable file via the IBM Installation Manager.

About this task

Note:
If you want to install the client into an existing Eclipse workbench, use the IBM Installation Manager. The IBM Installation Manager install prompts you for the workbench you want to extend and takes care of managing future workbench updates, rollbacks, and modifications
Note:
If Security-Enhanced Linux (SELinux) is enabled, you must disable it or change the security context of the Java Runtime Environment (JREs) to allow text relocation in order to install and run Rational Team Concert. For more information, see Installing Rational Team Concert with Security-Enhanced Linux.

  1. Download one of the following installation packages.

    There are three methods to install theRational Team Concert client.

  2. Start the launchpad program.

    If the Installation Manager is not already running, complete the following steps to start it.

    Note:
    You must have administrator privileges to run the launchpad program.
    Note:
    The Linux commands to start the launchpad program are only for the Rational Team Concert for Eclipse IDE.
    To start the launchpad program file on:
  3. You can install the following clients: The Installation Manager wizard is displayed. The wizard guides you through to install the client.
  4. Start the client by clicking the Rational Team Concert shortcut created by the installation.
  5. Connect to the server. The easiest way to connect to a server is using the Team Invitation. If you do not have an invitation you can connect manually.
    1. Click File -> Accept team invitation. The wizard guides you through the process.
      Note:
      If you do not have an invitation you need the URI or URL from your server admin. (an example format is: https://example.com:9443/jazz). Click on the connecting to an existing project area hyperlink that appears in the bottom right corner of the Accept Team Invitation window.
    2. Follow the instructions in the wizard to set up your connection.

Example

Trouble Shooting: Here are some suggested problem management techniques.

What to do next

After you have successfully installed the client, you should refer to the following topics to help you get started with Rational Team Concert.

Installing the Build System Toolkit from the IBM Installation Manager

The Build System Toolkit can be installed on the build machines using the IBM Installation Manager.

About this task

  1. Start the launchpad program.

    If the Installation Manager is not running, start it.

    Note:
    You must have administrator privileges to run the launchpad program.
  2. When the launchpad program appears, click on the Build System Toolkit to start the installation process.
  3. After the installation is complete, you can configure a build. More information about the Build System Toolkit can be found in About Jazz team build.

Installing Rational® Team Concert ClearCase Connector using the IBM Installation Manager

The ClearCase Connector can be installed on the build machines using the IBM Installation Manager.

About this task

  1. Start the launchpad program.

    If the Installation Manager is not running, start it.

    Note:
    You must have administrator privileges to run the launchpad program.
  2. When the launchpad program appears, click on the ClearCase Connector to start the installation process.
  3. After the installation is complete configure the ClearCase Connector. See Deploying ClearCase Connector.

Installing Rational Team Concert ClearQuest Connector using the IBM Installation Manager

The ClearQuest Connector can be installed on the build machines using the IBM Installation Manager.

About this task

  1. Start the launchpad program.

    If the Installation Manager is not running, start it.

    Note:
    You must have administrator privileges to run the launchpad program.
  2. When the launchpad program appears, click on the ClearQuest Connector to start the installation process.
  3. After the installation is complete configure the ClearQuest Connector. See Deploying ClearQuest Connector.

Installing Rational Team Concert with Security-Enhanced Linux

If Security-Enhanced Linux (SELinux) is enabled, you must either disable it or change the security context of the Java Runtime Environments (JREs) used for installing and running Rational Team Concert to allow text relocation.

About this task

If you have setup a machine for the sole purpose of evaluating Rational Team Concert and the SELinux features are not important to you, then the easiest way to proceed is to disable SELinux.

Note:


Feedback

Did this help? You can provide feedback at Jazz.net (registration required): Comment in the forums or submit a bug