Interactive installation guide

This guide describes installing the Rational solution for Collaborative Lifecycle Management (CLM) and Design Management applications.

For information on installing the CLM applications on z/OS, see Special considerations for installing on z/OS.

Select options that best describe your installation environment

Select the operating system for your application server:

Select the setup method:

Select one or more applications to install:

  • Optional applications (separate license)

  • Design Management (select one)

  • Supporting applications

  • Jazz Reporting Service

Select your database server:

Select your user registry type:

Are you configuring a data warehouse?

To install the Rational solution for CLM applications follow these steps:

Planning checklist

Before you install the Rational solution for Collaborative Lifecycle Management applications, ensure to review the information in the following planning checklist.

  Planning task More information
Verify that your hardware and software meet the minimum system requirements. System requirements
Get the product installation media. For local repository download, you need approximately five gigabytes (5 GB) of hard drive space to download and extract your product installation media. The server installation files can be downloaded from jazz.net
Review your installation topology. Whether you are trying out the CLM solution, or installing the solution in your production environment, click the link at the right to see and study different installation topology examples. The examples include: evaluation topology, departmental topology, and distributed enterprise topology. Installation process and topology examples
Synchronize the clocks on all machines. In a distributed environment, ensure that the clocks on all machines are synchronized using the Network Time Protocol (NTP). For more information about NTP, visit the Network Time Protocol website
Learn about licensing. The licensing scheme for version 6 is role-based. When you purchase a role-based license, you will have read, write, and comment access to some or all of the capabilities of the Change and Configuration Management, Quality Management, and Requirements Management applications. Client access license management
Learn about query and search index management. These Deployment wiki articles discuss different CLM applications index query information and how it is realized in your CLM deployment. In addition, the second part discusses different administering tasks related to index management and index storage details.

Part 1: Query, search and indexing technologies in CLM

Part 2: Indices storage and management (backup, recovery and recreation)

Installation process and topology

Planning your environment is critical during the installation process, particularly if you plan to use this installation for departmental or enterprise development. See Examples: Installation process and topology to learn about different installation process and topologies.

Install the server

Before you begin

Before starting the installation, make sure these tasks are completed:

  • If you used your environment to install a CLM product for trial or demo, you must uninstall and remove any CLM-related application directories before continuing a fresh installation. For more information see, Uninstalling Jazz Team Server and the Rational solution for Collaborative Lifecycle Management applications.
  • To install the servers and applications for the Rational solution for Collaborative Lifecycle Management (CLM) or Design Management, you must obtain the installation files. You can download either the Web Installer or the Installation Manager repository package for your platform from Jazz.net download section.
  • On IBM AIX® platforms, you can use the jar command to extract the package, but you must run the following chmod command to ensure that the launchpad program has the correct execution permission: chmod -R +x launchpad.sh
  • You must have a supported version of IBM® Installation Manager for your platform. The Web Installer downloads contain Installation Manager. The easiest way to proceed is to get the Web Installer download for your platform.
  • You must have an Installation Manager response file that is tailored for the to install. The Web Installer downloads contain sample response files for installing each of the available products.
  • You must have the Installation Manager repositories for each of the products to install. These repositories are available in the All Downloads section of the product downloads page.
  • Extract the downloaded .zip file to a temporary directory. To avoid issues, do not use long paths and directories that have spaces in their names. Extract any other Installation Manager repository files that you download into the same directory as the Web Installer.
  • The response files contain an example command-line invocation that uses the -acceptLicense argument. Before attempting a command-line installation, review the license agreement that is included in the /license directory at the top-level of the product download. Use the -acceptLicense argument on the command-line to indicate acceptance of this license agreement.
  • Each response file contains a line that refers to the Installation Manager repository to be used during installation. Edit the repository location attribute to point to the repository.config file in the directory that you extracted the Installation Manager repository files to.
  • Before you can install and run CLM applications on your IBM AIX® system, you must increase the limit of open files:
    1. Start smit.
    2. Go to Security & Users > Users > Change/Show Characteristics of a User.
    3. Enter the User ID under which the Jazz Team Server is running.
    4. Enter a value of 65536 in the Soft NOFILE descriptors and Hard NOFILE descriptors fields.
    5. Enter a value of 10000 in the Soft NPROC per user and Hard NPROC per user fields.
    6. Log out and log back in to the system.
    7. Before starting Tomcat WebSphere Application Server, run ulimit -n to see if the configuration took effect. The output must be 65536.
    8. Also before starting Tomcat WebSphere Application Server, run ulimit -u to see if the configuration took effect. The output must be 10000.
  • Unless you plan to perform a silent installation, a supported browser is required to install the with a graphical user interface and IBM Installation Manager. You can download the Firefox browser for AIX at Download Firefox.
  • The browser must be included in the $PATH environment variable. If the launchpad.sh program for IBM Installation Manager cannot find the browser, an error message will be displayed.
  • To run WebSphere Application Server 8.0.0.3 on AIX 6.1 or 7.1, you must upgrade your AIX server with the following fixes:
  • Before you can install and run CLM applications on your Linux system, you must increase the limit of open files and user processes:
    1. As a root user add the following lines to the /etc/security/limits.conf file:

      * hard nofile 65536
      * soft nofile 65536
      * hard nproc 10000
      * soft nproc 10000

    2. Restart the Linux system after the limits.conf file is modified.
  • If Security-Enhanced Linux (SELinux) is enabled, you must disable it or change the security context of the Java Runtime Environment (JRE) to allow text relocation. For more information, see Installing with Security-Enhanced Linux.
  • The CLM applications installation path names must not contain spaces. The startup script (JazzInstallDir/server/server.startup) and the repository tools script (JazzInstallDir/server/repotools-app.sh) detect and report this problem.
  • The Reports component requires that 32-bit X11 libraries be installed on the server. On Redhat Enterprise Linux 5, the required packages are libXp, libXinerama, mesa-libGL, and compat-libstdc++-33.
  • You must have the GTK x32 libraries available in your Linux system to be able to open the Installation Manager link from the launchpad program. For more information, see this article on jazz.net.
  • When running the CLM applications, there are logs and other files that can be modified and written in the installation directory. For all users to be able to write to the installation directory, you must manually grant write permissions to the JazzInstallDir.

Important: If you use a system startup script such as /etc/init.d/was or /etc/rc.*/SXXWebSphere to start WebSphere® Application Server at system boot up time, init.d invokes the startup scripts with the maximum number of file descriptors set to 1024 instead of the system default value that is set in /etc/security/limits.conf (65536). To avoid this problem, add the command ulimit -n 65536 to the top of your startup script. This ensures that WebSphere Application Server is started with the correct file descriptor limit.

About this task

There are two ways to download and install CLM applications. The first installation method is a web-based installation that includes a smaller download and connects to the Internet during the installation to get the repository files. If you must install the server in an environment without Internet access, use the second installation method: download and extract the repository files to a local computer to install the server.

If you do not have User Interface libraries installed on your server or just prefer to use the command-line installation method, you can use an IBM Installation Manager response file to install Rational Collaborative Lifecycle Manager. This method is also referred to as silent installation.

There are two sample response files provided to install Jazz Team Server and CLM applications:

  • silent-install-server.xml: Use this script to produce an installation of the Rational Solution for CLM applications in the C:\tmp\silent-install\JazzTeamServer/tmp/silent-install/JazzTeamServer directory that can be compressed and relocated on the file system, or to other computers with the same operating system and architecture. To use this script, you must have Installation Manager installed on your server.
  • silent-install-server2.xml: Use this script to install the Rational Solution for CLM applications in the default installation location. If you do not have Installation Manager, this script will install Installation Manager on your server before continuing with the CLM installation.

In addition to the server sample response files, these additional component sample response files are also included:
  • silent-install-buildsystem.xml: Installs Build System Toolkit
  • silent-install-cc-connector.xml: Installs Rational ClearCase Synchronizer
  • silent-install-client.xml: Installs Rational Team Concert - Client for Eclipse IDE
  • silent-install-cq-connector.xml: Installs Rational ClearQuest Synchronizer
  • silent-install-jazz-msscci.xml: Installs Rational Team Concert MS-SCCI provider
  • silent-install-vs-client.xml: Installs Rational Team Concert - Client for Microsoft Visual Studio
  • silent-install-windows-shell-client.xml: Installs Rational Team Concert Windows Explorer Shell
In addition to the server sample response files, these additional component sample response files are also included:
  • RhapsodyDM_Client_install.xml: Installs Rhapsody Design Manager Client Extension.
  • RhapsodyDM_ImportEngine_install.xml: Installs Rhapsody Design Manager import engine.
  • RhapsodyDM_Manual-Simulink-Importer_install.xml: Installs Rhapsody Design Manager Simulink Importer.
In addition to the server sample response files, these additional component sample response files are also included:
  • RSADM_Client_install.xml: Installs Rational Software Architect Design Manager Client Extension.
  • RSADM_ImportEngine_install.xml: Installs Rational Software Architect Design Manager import engine.
  • RSADM_Client_forRSA9_install.xml: Installs Rational Software Architect Design Manager V9 Client Extension.

Procedure

  1. Extract the downloaded .zip file to a temporary directory. To avoid issues, do not use long paths and directories that have spaces in their names.
  2. Install by using either the web installer or the Installation Manager repository package.
    • To install by using the web installer:
      1. Open the directory that you extracted the .zip file to, and run the launchpad executable file. The launchpad opens.

        Note: If you want to install the product as a non-root usernon-administrator user, from the Select user mode for Installation Manager list, select Non-Administrator. When you select Non-Administrator, the software packages will be installed in the user's directory and the package group will be named My IBM Collaborative Lifecycle Management. Also on Windows operating systems with User Access Control (UAC) enabled, the user who is installing the applications must be able to write to the installation directories.

      2. Follow the steps in the launchpad to continue the installation. As you follow the steps in the launchpad, Installation Manager opens to install the software packages.
    • To install by using the Installation Manager repository package:
      1. Start Installation Manager.

        If you do not have a supported version of Installation Manager, you can obtain it from Jazz.net or download the web installer, which includes Installation Manager.

      2. Click File > Preferences, and then select Add Repository.
      3. To specify the repository location, browse to the directory where you downloaded the .zip file and open the repository.config file.
      4. Click OK, and then click Install to start the installation process.
      5. Follow the instructions in Installation Manager to install the software packages.
  3. During installation, select the Install with WAS Liberty Profile 8.5.x check box.
  4. During installation, clear Install with WAS Liberty Profile 8.5.x and select the Install application WAR files check box. This is to ensure that the application WAR files are copied in the default webapps directory for later deployment. You can also choose a directory of your choice to copy the WAR files.
  1. Open a command prompt and change to the ExtractedDir\im\win32.win32.x86 directory.
  2. Open a command shell and change to the ExtractedDir/im/linux.gtx.x86 directory.
  3. Open a command shell and change to the ExtractedDir/im/linux.gtx.ppc directory.
  4. Open a command shell and change to the ExtractedDir/im/linux.gtx.s390 directory.
  5. Open a command shell and change to the ExtractedDir/im/aix.motif.ppc directory.
  6. To install as an administrator into a shared area, use the installc variant in the following command:

    .\installc -acceptLicense -showVerboseProgress -input silent-install-server2.xml --launcher.ini silent-install.ini

    ./installc -acceptLicense -showVerboseProgress -input silent-install-server2.xml --launcher.ini silent-install.ini

  7. To install into a user-specific location use the userinstc variant in the following command:

    .\userinstc -acceptLicense -showVerboseProgress -input silent-install-server2.xml --launcher.ini user-silent-install.ini

    ./userinstc -acceptLicense -showVerboseProgress -input silent-install-server2.xml --launcher.ini user-silent-install.ini

  8. To remove an application from being installed, search for the application name and comment out or delete the line. For example, if you do not want to install Change and Configuration Management application, search for rtc and delete or comment out the offering line:

    <!--
    <offering id='com.ibm.team.install.jfs.app.rtc'/>
    -->

Installing the server on IBM i

For step-by-step instructions for new installations of Jazz Team Server, see Installing Jazz Team Server and CLM applications on IBM i.

For detailed instructions for installing the Build System Toolkit and the context-aware search engine, see the following resources:

Set up the database

If you are using the included Derby database, no additional setup is necessary. Proceed with the next step.

Note: Although a Derby database is included in the default configuration and requires no installation, this database is limited to 10 users. To enable more users, install a supported enterprise database such as DB2, Oracle, or SQL Server.

To create database tables, see Creating DB2 for z/OS database tables remotely.

The Rational solution for Collaborative Lifecycle Management products support IBM DB2 Enterprise Server Edition. For platforms that do not support Enterprise Server Edition, you can use IBM DB2 Workgroup Server Edition. You can obtain a trial download of one these DB2 editions or the free DB2 Express Server edition for deployments of 50 developers or fewer from ibm.com.

Before you begin

This procedure requires that the following prerequisites are met:

  • The databases are not partitioned. Partitioned databases are not supported in this release and must not be used.
  • You have the correct user password. On the UNIX systems, get the password for the DB2 instance owner, which is typically the db2inst1 user.
  • You have reviewed the DB2 documentation to verify that your system meets the requirements and is configured correctly.
  • DB2 is installed and running 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.

Procedure

  1. Open a DB2 command window.
  2. Enter this command to create a database for Jazz Team Server called JTS with 16K pages and the UTF-8 code set:

    db2 create database JTS using codeset UTF-8 territory en PAGESIZE 16384

  3. Enter this command to create a database for Change and Configuration Management application called CCM with 16K pages and the UTF-8 code set:

    db2 create database CCM using codeset UTF-8 territory en PAGESIZE 16384

  4. Enter this command to create a database for Quality Management application called QM with 16K pages and the UTF-8 code set:

    db2 create database QM using codeset UTF-8 territory en PAGESIZE 16384

  5. Enter this command to create a database for Requirements Management application called RM with 16K pages and the UTF-8 code set:

    db2 create database RM using codeset UTF-8 territory en PAGESIZE 16384

  6. Enter this command to create a database for the Data Collection Component application called DCC with 16K pages and the UTF-8 code set:

    db2 create database DCC using codeset UTF-8 territory en PAGESIZE 16384

  7. Enter this command to create a database for the Lifecycle Query Engine application called LQE with 32K pages and the UTF-8 code set:

    Note: The Lifecycle Query Engine database requires 32K pages.

    db2 create database LQE using codeset UTF-8 territory en PAGESIZE 32768

  8. Enter this command to create a database for the Link Index Provider application called LDX with 32K pages and the UTF-8 code set:

    Note: The Link Index Provider database requires 32K pages.

    db2 create database LDX using codeset UTF-8 territory en PAGESIZE 32768

  9. Enter this command to create a database for the Global Configuration application called GC with 16K pages and the UTF-8 code set:

    db2 create database GC using codeset UTF-8 territory en PAGESIZE 16384

  10. Enter this command to create a database for the Rational Engineering Lifecycle Manager application called RELM with 16K pages and the UTF-8 code set:

    db2 create database RELM using codeset UTF-8 territory en PAGESIZE 16384

  11. Enter this command to create a database for the Design Management application called DM with 16K pages and the UTF-8 code set:

    db2 create database DM using codeset UTF-8 territory en PAGESIZE 16384

  12. Enter this command to create a database for your data warehouse called DW with 16K pages and the UTF-8 code set:

    db2 create database DW using codeset UTF-8 territory en PAGESIZE 16384

  13. Note: If you are creating the database with a user other than the user specified in the teamserver.properties file, you must grant DBADM authority to that user:

    db2 connect to database name
    db2 grant dbadm on database to user user name
    db2 disconnect database name

    Due to the parallel processing that Data Collection Component does with data, the database at a given collection will be very active. The following examples are just for guidelines. Adjust these settings accordingly depending on your data load initially and over time.

  14. The warehouse database must have the MAXAPPLS increased to allow for concurrent connections in Data Collection Component to process data if it is not set to AUTOMATIC. Increase the value to 300.
  15. DB2 UPDATE DB CFG FOR DW USING MAXAPPLS 300

  16. Increase the LOCKLIST if it is not set to AUTOMATIC.
  17. DB2 UPDATE DB CFG FOR DW USING LOCKLIST 20000

  18. The transaction logs will also grow as data is processed in parallel. Increase the LOGFILSIZ to 20000.
  19. DB2 UPDATE DB CFG FOR DW USING LOGFILSIZ 20000

  20. Also increase the number of primary and secondary transactions log files.
  21. DB2 UPDATE DB CFG FOR DW USING LOGPRIMARY 50
    DB2 UPDATE DB CFG FOR DW USING LOGSECOND 200

Verify

If you create all CLM databases on the same database server, verify that the Max number of concurrently active databases is set to a number greater than the number of databases you created. If this value is lower than the number of active databases, you will get the SQL Code 1041 error.

Do these steps to verify and increase the number if necessary:

  1. Open a DB2 command window and enter this command to display the database manager configuration:

    db2 get dbm cfg

  2. Look for the Max number of concurrently active databases line. If this number is lower than the installed databases, increase the number by entering this command:

    db2 update dbm cfg using numdb 32

  3. Stop and start the database manager for these changes to take effect by entering these commands:

    db2stop
    db2start

To create and set up an Oracle database, it is assumed that the user who is preparing the database has 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.

Before you begin

  • The required Java Database Connectivity (JDBC) driver is ojdbc6.jar. For a list of supported database versions and driver versions, see the system requirements link in the Planning checklist section of this document.
  • The configuration parameters and tablespace options used in this step 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.
  • If you install the Rational solution for Collaborative Lifecycle Management (CLM) 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 step are for one Oracle database with separate tablespaces and database users who are dedicated to each application.

  • The database that you create for the Jazz Team Server and all CLM 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.
  • For the Oracle data warehouse database to work efficiently with the Data Collection Component, you must increase the PROCESSES configuration to 3000.

Procedure

  1. As a system administrator, create a database with UTF-8 encoding for the Jazz Team Server and all applications.
    1. Start the Database Configuration Assistant wizard and on the Welcome page click Next.
    2. On the Operations page, select Create a Database and then click Next.
    3. On the Templates page, select Custom Database and click Next.
    4. In both the Global Database Name and SID fields, enter a name for the content storage database, for example, CLMDB. Click Next.
    5. To configure the database control, enter the required information for alert notification and optionally enable the daily disk backup schedule. To continue without database control configuration, clear the check box next to Configure Enterprise Manager and then click Next.
    6. On the Database Credentials page, choose an option for your user account, and then click Next.

      Note: Oracle password complexity policy requires that passwords should have minimum of 8 characters in length. In addition, the password must contain at least one upper-case character, one lower-case character, and one digit.

    7. On the next page, select a storage type and location for database files. Click Next.
    8. On the next page, choose a recovery option for the database, and then click Next.
    9. On the next page, specify whether or not to add the Sample Schemas to your database. Click Next.
    10. On the next page, click the Character Sets tab and select Use Unicode (AL32UTF8). Click Next.

      Note: Setting character set to Unicode (AL32UTF8) enables you to store multiple language groups.

    11. On the Database Storage page verify or change the database objects and click Next.
    12. On the next page click Finish to create the database.
    13. On the Confirmation window that opens, optionally save the page as an HTML file, and then click OK. A progress bar is displayed to show the database creation progress.
  2. Open an SQL Plus window and log in as SYSTEM or SYSDBA.

    To create a tablespace for Jazz Team Server, enter the following command. Replace JTS with the tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, CLMDB with the database name you created in step a, and JTS.DBF with the datafile name that you want to create.

    CREATE TABLESPACE JTS
    DATAFILE 'ORACLE_BASE/oradata/CLMDB/JTS.DBF'
    SIZE 1G AUTOEXTEND ON EXTENT MANAGEMENT LOCAL AUTOALLOCATE;

    To create a temporary tablespace for Jazz Team Server, enter the following command. Replace JTS_TEMP with the temporary tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, CLMDB with the database name you created in step a, and JTS_TEMP.DBF with the temporary file name that you want to create.

    CREATE TEMPORARY TABLESPACE JTS_TEMP
    TEMPFILE 'ORACLE_BASE/oradata/CLMDB/JTS_TEMP.DBF'
    SIZE 20M AUTOEXTEND ON EXTENT MANAGEMENT LOCAL UNIFORM SIZE 1M;

    To create a tablespace for the Change and Configuration Management application, enter the following command. Replace CCM with the tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, CLMDB with the database name you created in step a, and CCM.DBF with the datafile name that you want to create.

    CREATE TABLESPACE CCM
    DATAFILE 'ORACLE_BASE/oradata/CLMDB/CCM.DBF'
    SIZE 1G AUTOEXTEND ON EXTENT MANAGEMENT LOCAL AUTOALLOCATE;

    To create a temporary tablespace for the Change and Configuration Management application, enter the following command. Replace CCM_TEMP with the temporary tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, CLMDB with the database name you created in step a, and CCM_TEMP.DBF with the temporary file name that you want to create.

    CREATE TEMPORARY TABLESPACE CCM_TEMP
    TEMPFILE 'ORACLE_BASE/oradata/CLMDB/CCM_TEMP.DBF'
    SIZE 20M AUTOEXTEND ON EXTENT MANAGEMENT LOCAL UNIFORM SIZE 1M;

    To create a tablespace for the Rational Engineering Lifecycle Manager application, enter the following command. Replace RELM with the tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, CLMDB with the database name you created in step a, and RELM.DBF with the datafile name that you want to create.

    CREATE TABLESPACE RELM
    DATAFILE 'ORACLE_BASE/oradata/CLMDB/RELM.DBF'
    SIZE 1G AUTOEXTEND ON EXTENT MANAGEMENT LOCAL AUTOALLOCATE;

    To create a temporary tablespace for the Rational Engineering Lifecycle Manager application, enter the following command. Replace RELM_TEMP with the temporary tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, CLMDB with the database name you created in step a, and RELM_TEMP.DBF with the temporary file name that you want to create.

    CREATE TEMPORARY TABLESPACE RELM_TEMP
    TEMPFILE 'ORACLE_BASE/oradata/CLMDB/RELM_TEMP.DBF'
    SIZE 20M AUTOEXTEND ON EXTENT MANAGEMENT LOCAL UNIFORM SIZE 1M;

    To create a tablespace for the Quality Management application, enter the following command. Replace QM with the tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, CLMDB with the database name you created in step a, and QM.DBF with the datafile name that you want to create.

    CREATE TABLESPACE QM
    DATAFILE 'ORACLE_BASE/oradata/CLMDB/QM.DBF'
    SIZE 1G AUTOEXTEND ON EXTENT MANAGEMENT LOCAL AUTOALLOCATE;

    To create a temporary tablespace for the Quality Management application, enter the following command. Replace QM_TEMP with the temporary tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, CLMDB with the database name you created in step a, and QM_TEMP.DBF with the temporary file name that you want to create.

    CREATE TEMPORARY TABLESPACE QM_TEMP
    TEMPFILE 'ORACLE_BASE/oradata/CLMDB/QM_TEMP.DBF'
    SIZE 20M AUTOEXTEND ON EXTENT MANAGEMENT LOCAL UNIFORM SIZE 1M;

    To create a tablespace for the Requirements Management application, enter the following command. Replace RM with the tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, CLMDB with the database name you created in step a, and RM.DBF with the datafile name that you want to create.

    CREATE TABLESPACE RM
    DATAFILE 'ORACLE_BASE/oradata/CLMDB/RM.DBF'
    SIZE 1G AUTOEXTEND ON EXTENT MANAGEMENT LOCAL AUTOALLOCATE;

    To create a temporary tablespace for the Requirements Management application, enter the following command. Replace RM_TEMP with the temporary tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, CLMDB with the database name you created in step a, and RM_TEMP.DBF with the temporary file name that you want to create.

    CREATE TEMPORARY TABLESPACE RM_TEMP
    TEMPFILE 'ORACLE_BASE/oradata/CLMDB/RM_TEMP.DBF'
    SIZE 20M AUTOEXTEND ON EXTENT MANAGEMENT LOCAL UNIFORM SIZE 1M;

    To create a tablespace for the Design Management application, enter the following command. Replace DM with the tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, CLMDB with the database name you created in step a, and DM.DBF with the datafile name that you want to create.

    CREATE TABLESPACE DM
    DATAFILE 'ORACLE_BASE/oradata/CLMDB/DM.DBF'
    SIZE 1G AUTOEXTEND ON EXTENT MANAGEMENT LOCAL AUTOALLOCATE;

    To create a temporary tablespace for the Design Management application, enter the following command. Replace DM_TEMP with the temporary tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, CLMDB with the database name you created in step a, and DM_TEMP.DBF with the temporary file name that you want to create.

    CREATE TEMPORARY TABLESPACE DM_TEMP
    TEMPFILE 'ORACLE_BASE/oradata/CLMDB/DM_TEMP.DBF'
    SIZE 20M AUTOEXTEND ON EXTENT MANAGEMENT LOCAL UNIFORM SIZE 1M;

    To create a tablespace for the Data Collection Component application, enter the following command. Replace DCC with the tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, CLMDB with the database name you created in step a, and DCC.DBF with the datafile name that you want to create.

    CREATE TABLESPACE DCC
    DATAFILE 'ORACLE_BASE/oradata/CLMDB/DCC.DBF'
    SIZE 1G AUTOEXTEND ON EXTENT MANAGEMENT LOCAL AUTOALLOCATE;

    To create a temporary tablespace for the Data Collection Component application, enter the following command. Replace DCC_TEMP with the temporary tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, CLMDB with the database name you created in step a, and DCC_TEMP.DBF with the temporary file name that you want to create.

    CREATE TEMPORARY TABLESPACE DCC_TEMP
    TEMPFILE 'ORACLE_BASE/oradata/CLMDB/DCC_TEMP.DBF'
    SIZE 20M AUTOEXTEND ON EXTENT MANAGEMENT LOCAL UNIFORM SIZE 1M;

    To create a tablespace for the Lifecycle Query Engine application, enter the following command. Replace LQE with the tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, CLMDB with the database name you created in step a, and LQE.DBF with the datafile name that you want to create.

    CREATE TABLESPACE LQE
    DATAFILE 'ORACLE_BASE/oradata/CLMDB/LQE.DBF'
    SIZE 1G AUTOEXTEND ON EXTENT MANAGEMENT LOCAL AUTOALLOCATE;

    To create a temporary tablespace for the Lifecycle Query Engine application, enter the following command. Replace LQE_TEMP with the temporary tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, CLMDB with the database name you created in step a, and LQE_TEMP.DBF with the temporary file name that you want to create.

    CREATE TEMPORARY TABLESPACE LQE_TEMP
    TEMPFILE 'ORACLE_BASE/oradata/CLMDB/LQE_TEMP.DBF'
    SIZE 20M AUTOEXTEND ON EXTENT MANAGEMENT LOCAL UNIFORM SIZE 1M;

    To create a tablespace for the Link Index Provider application, enter the following command. Replace LDX with the tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, CLMDB with the database name you created in step a, and LDX.DBF with the datafile name that you want to create.

    CREATE TABLESPACE LDX
    DATAFILE 'ORACLE_BASE/oradata/CLMDB/LDX.DBF'
    SIZE 1G AUTOEXTEND ON EXTENT MANAGEMENT LOCAL AUTOALLOCATE;

    To create a temporary tablespace for the Link Index Provider application, enter the following command. Replace LDX_TEMP with the temporary tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, CLMDB with the database name you created in step a, and LDX_TEMP.DBF with the temporary file name that you want to create.

    CREATE TEMPORARY TABLESPACE LDX_TEMP
    TEMPFILE 'ORACLE_BASE/oradata/CLMDB/LDX_TEMP.DBF'
    SIZE 20M AUTOEXTEND ON EXTENT MANAGEMENT LOCAL UNIFORM SIZE 1M;

    To create a tablespace for the Global Configuration application, enter the following command. Replace GC with the tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, CLMDB with the database name you created in step a, and GC.DBF with the datafile name that you want to create.

    CREATE TABLESPACE GC
    DATAFILE 'ORACLE_BASE/oradata/CLMDB/GC.DBF'
    SIZE 1G AUTOEXTEND ON EXTENT MANAGEMENT LOCAL AUTOALLOCATE;

    To create a temporary tablespace for the Global Configuration application, enter the following command. Replace GC_TEMP with the temporary tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, CLMDB with the database name you created in step a, and GC_TEMP.DBF with the temporary file name that you want to create.

    CREATE TEMPORARY TABLESPACE GC_TEMP
    TEMPFILE 'ORACLE_BASE/oradata/CLMDB/GC_TEMP.DBF'
    SIZE 20M AUTOEXTEND ON EXTENT MANAGEMENT LOCAL UNIFORM SIZE 1M;

    To create a tablespace for the common data warehouse, enter the following command. Replace DW with the tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, CLMDB with the database name you created in step a, and DW.DBF with the datafile name that you want to create.

    CREATE TABLESPACE DW
    DATAFILE 'ORACLE_BASE/oradata/CLMDB/DW.DBF'
    SIZE 1G AUTOEXTEND ON EXTENT MANAGEMENT LOCAL AUTOALLOCATE;

    To create a temporary tablespace for the common data warehouse, enter the following command. Replace DW_TEMP with the temporary tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, CLMDB with the database name you created in step a, and DW_TEMP.DBF with the temporary file name that you want to create.

    CREATE TEMPORARY TABLESPACE DW_TEMP
    TEMPFILE 'ORACLE_BASE/oradata/CLMDB/DW_TEMP.DBF'
    SIZE 20M AUTOEXTEND ON EXTENT MANAGEMENT LOCAL UNIFORM SIZE 1M;

  3. In the Oracle Enterprise Manager Database Control, click Server > Tablespaces and verify that the tablespaces you created are displayed and accessible. Also ensure that the default Oracle tablespace named USERS already exist. If this tablespace does not exist in your Oracle database, create it.

  4. Create an Oracle database user for each new tablespace.

    After the tablespaces 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.

    To create a user for Jazz Team Server tablespace and to grant the required permissions, enter the following commands:

    CREATE USER JTS_DB_USER IDENTIFIED BY Passw0rd DEFAULT TABLESPACE JTS QUOTA UNLIMITED ON JTS TEMPORARY TABLESPACE JTS_TEMP;

    GRANT CREATE PROCEDURE, CREATE SESSION, CREATE TABLE, CREATE VIEW TO JTS_DB_USER;

    To create a user for the Change and Configuration Management application tablespace and to grant the required permissions, enter the following commands:

    CREATE USER CCM_DB_USER IDENTIFIED BY Passw0rd DEFAULT TABLESPACE CCM QUOTA UNLIMITED ON CCM TEMPORARY TABLESPACE CCM_TEMP;

    GRANT CREATE PROCEDURE, CREATE SESSION, CREATE TABLE, CREATE VIEW TO CCM_DB_USER;

    To create a user for the Rational Engineering Lifecycle Manager application tablespace and to grant the required permissions, enter the following commands:

    CREATE USER RELM_DB_USER IDENTIFIED BY Passw0rd DEFAULT TABLESPACE RELM QUOTA UNLIMITED ON RELM TEMPORARY TABLESPACE RELM_TEMP;

    GRANT CREATE PROCEDURE, CREATE SESSION, CREATE TABLE, CREATE VIEW TO RELM_DB_USER;

    To create a user for the Quality Management application tablespace and to grant the required permissions, enter the following commands:

    CREATE USER QM_DB_USER IDENTIFIED BY Passw0rd DEFAULT TABLESPACE QM QUOTA UNLIMITED ON QM TEMPORARY TABLESPACE QM_TEMP;

    GRANT CREATE PROCEDURE, CREATE SESSION, CREATE TABLE, CREATE VIEW TO QM_DB_USER;

    To create a user for Requirements Management application tablespace and to grant the required permissions, enter the following commands:

    CREATE USER RM_DB_USER IDENTIFIED BY Passw0rd DEFAULT TABLESPACE RM QUOTA UNLIMITED ON RM TEMPORARY TABLESPACE RM_TEMP;

    GRANT CREATE PROCEDURE, CREATE SESSION, CREATE TABLE, CREATE VIEW TO RM_DB_USER;

    To create a user for the Design Management application tablespace and to grant the required permissions, enter the following commands:

    CREATE USER DM_DB_USER IDENTIFIED BY Passw0rd DEFAULT TABLESPACE DM QUOTA UNLIMITED ON DM TEMPORARY TABLESPACE DM_TEMP;

    GRANT CREATE PROCEDURE, CREATE SESSION, CREATE TABLE, CREATE VIEW TO DM_DB_USER;

    To create a user for the Data Collection Component application tablespace and to grant the required permissions, enter the following commands:

    CREATE USER DCC_DB_USER IDENTIFIED BY Passw0rd DEFAULT TABLESPACE DCC QUOTA UNLIMITED ON DCC TEMPORARY TABLESPACE DCC_TEMP;

    GRANT CREATE PROCEDURE, CREATE SESSION, CREATE TABLE, CREATE VIEW TO DCC_DB_USER;

    To create a user for the Lifecycle Query Engine application tablespace and to grant the required permissions, enter the following commands:

    CREATE USER LQE_DB_USER IDENTIFIED BY Passw0rd DEFAULT TABLESPACE LQE QUOTA UNLIMITED ON LQE TEMPORARY TABLESPACE LQE_TEMP;

    GRANT CREATE PROCEDURE, CREATE SESSION, CREATE TABLE, CREATE VIEW TO LQE_DB_USER;

    To create a user for the Link Index Provider application tablespace and to grant the required permissions, enter the following commands:

    CREATE USER LDX_DB_USER IDENTIFIED BY Passw0rd DEFAULT TABLESPACE LDX QUOTA UNLIMITED ON LDX TEMPORARY TABLESPACE LDX_TEMP;

    GRANT CREATE PROCEDURE, CREATE SESSION, CREATE TABLE, CREATE VIEW TO LDX_DB_USER;

    To create a user for the Global Configuration Management application tablespace and to grant the required permissions, enter the following commands:

    CREATE USER GC_DB_USER IDENTIFIED BY Passw0rd DEFAULT TABLESPACE GC QUOTA UNLIMITED ON GC TEMPORARY TABLESPACE GC_TEMP;

    GRANT CREATE PROCEDURE, CREATE SESSION, CREATE TABLE, CREATE VIEW TO GC_DB_USER;

    To create a user for common data warehouse tablespace and to grant the required permissions, enter the following commands:

    CREATE USER DW_USER IDENTIFIED BY Passw0rd DEFAULT TABLESPACE DW QUOTA UNLIMITED ON DW TEMPORARY TABLESPACE DW_TEMP;

    GRANT DBA TO DW_USER;

    Note: The creation of the data 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. You can change this permission after the data warehouse is created. For more information, see Completing the installation.

    To create the data warehouse without DBA permissions, see this deployment wiki article.

  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) from the Oracle website.
    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. Open a shell window.
    2. Enter the following environment variable declaration:

      export ORACLE_JDBC_DRIVER_FILE =/Path_to_JDBC_dirver/ojdbc6.jar

Before you begin

This procedure requires that the following prerequisites are met:

  • The service is started.
  • The Java Database Connectivity (JDBC) driver is installed. To download the JDBC driver, go to Microsoft JDBC Driver 4.0 for SQL Server.
  • The TCP protocol is enabled for SQL Server.
  • The user who creates the database table must be a member in the sysadmin fixed server role, or an owner of the database (dbo).
  • Ensure that your server security is in mixed mode. You can verify the mode by checking the server security. It should be set to SQL Server and Windows Authentication Mode.
  • Create an empty directory on your database server to be used as the data warehouse base folder. During the setup wizard, you will be asked to enter this directory.

Procedure

Set up the SQL Server database by using the sqlcmd command line tool, which is provided with the SQL Server installation. You can also use a visual tool, such as SQL Server Studio Management.

Important: If you install Rational solution for CLM applications either on the same computer or distributed platforms, a separate database and a database user who is associated with that database must be created.

  1. Enter the following command to create a database for each application:

    For Jazz Team Server

    CREATE DATABASE jts
    GO

    For Change and Configuration Management

    CREATE DATABASE ccm
    GO

    For Rational Engineering Lifecycle Manager

    CREATE DATABASE relm
    GO

    For Quality Management

    CREATE DATABASE qm
    GO

    For Requirements Management

    CREATE DATABASE rm
    GO

    For Design Management

    CREATE DATABASE dm
    GO

    For Data Collection Component

    CREATE DATABASE dcc
    GO

    For Lifecycle Query Engine

    CREATE DATABASE lqe
    GO

    For Link Index Provider

    CREATE DATABASE ldx
    GO

    For Global Configuration

    CREATE DATABASE gc
    GO

    For common data warehouse

    CREATE DATABASE dw
    GO

  2. Create a user and password and change the ownership of the database by entering these commands:

    For Jazz Team Server

    CREATE LOGIN jtsDBuser
    WITH PASSWORD = 'jtsDBpswd';
    USE jts;
    exec sp_changedbowner 'jtsDBuser'
    GO

    For Change and Configuration Management

    CREATE LOGIN ccmDBuser
    WITH PASSWORD = 'ccmDBpswd';
    USE ccm;
    exec sp_changedbowner 'ccmDBuser'
    GO

    For Rational Engineering Lifecycle Manager

    CREATE LOGIN relmDBuser
    WITH PASSWORD = 'relmDBpswd';
    USE relm;
    exec sp_changedbowner 'relmDBuser'
    GO

    For Quality Management

    CREATE LOGIN qmDBuser
    WITH PASSWORD = 'qmDBpswd';
    USE qm;
    exec sp_changedbowner 'qmDBuser'
    GO

    For Requirements Management

    CREATE LOGIN rmDBuser
    WITH PASSWORD = 'rmDBpswd';
    USE rm;
    exec sp_changedbowner 'rmDBuser'
    GO

    For Design Management

    CREATE LOGIN dmDBuser
    WITH PASSWORD = 'dmDBpswd';
    USE dm;
    exec sp_changedbowner 'dmDBuser'
    GO

    For Data Collection Component

    CREATE LOGIN dccDBuser
    WITH PASSWORD = 'dccDBpswd';
    USE dcc;
    exec sp_changedbowner 'dccDBuser'
    GO

    For Lifecycle Query Engine

    CREATE LOGIN lqeDBuser
    WITH PASSWORD = 'lqeDBpswd';
    USE lqe;
    exec sp_changedbowner 'lqeDBuser'
    GO

    For Link Index Provider

    CREATE LOGIN ldxDBuser
    WITH PASSWORD = 'ldxDBpswd';
    USE ldx;
    exec sp_changedbowner 'ldxDBuser'
    GO

    For Global Configuration

    CREATE LOGIN gcDBuser
    WITH PASSWORD = 'gcDBpswd';
    USE gc;
    exec sp_changedbowner 'gcDBuser'
    GO

    For common data warehouse

    CREATE LOGIN DWuser
    WITH PASSWORD = 'DWpswd';
    USE dw;
    exec sp_changedbowner 'DWuser'
    GO

  3. Change the collation of the databases. From the command line tool, type this command:

    For Jazz Team Server

    ALTER DATABASE jts COLLATE SQL_Latin1_General_CP437_CS_AS
    GO

    For Change and Configuration Management

    ALTER DATABASE ccm COLLATE SQL_Latin1_General_CP437_CS_AS
    GO

    For Rational Engineering Lifecycle Manager

    ALTER DATABASE relm COLLATE SQL_Latin1_General_CP437_CS_AS
    GO

    For Quality Management

    ALTER DATABASE qm COLLATE SQL_Latin1_General_CP437_CS_AS
    GO

    For Requirements Management

    ALTER DATABASE rm COLLATE SQL_Latin1_General_CP437_CS_AS
    GO

    For Design Management

    ALTER DATABASE dm COLLATE SQL_Latin1_General_CP437_CS_AS
    GO

    For Data Collection Component

    ALTER DATABASE dcc COLLATE SQL_Latin1_General_CP437_CS_AS
    GO

    For Lifecycle Query Engine

    ALTER DATABASE lqe COLLATE SQL_Latin1_General_CP437_CS_AS
    GO

    For Link Index Provider

    ALTER DATABASE ldx COLLATE SQL_Latin1_General_CP437_CS_AS
    GO

    For Global Configuration

    ALTER DATABASE gc COLLATE SQL_Latin1_General_CP437_CS_AS
    GO

    For common data warehouse

    ALTER DATABASE dw COLLATE SQL_Latin1_General_CP1_CS_AS
    GO

  4. Change the row version system for the database. From the command line tool, run this command:

    Note: Ensure that the connection to the database is open before running this command.

    For Jazz Team Server

    ALTER DATABASE jts SET READ_COMMITTED_SNAPSHOT ON
    GO

    For Change and Configuration Management

    ALTER DATABASE ccm SET READ_COMMITTED_SNAPSHOT ON
    GO

    For Rational Engineering Lifecycle Manager

    ALTER DATABASE relm SET READ_COMMITTED_SNAPSHOT ON
    GO

    For Quality Management

    ALTER DATABASE qm SET READ_COMMITTED_SNAPSHOT ON
    GO

    For Requirements Management

    ALTER DATABASE rm SET READ_COMMITTED_SNAPSHOT ON
    GO

    For Design Management

    ALTER DATABASE dm SET READ_COMMITTED_SNAPSHOT ON
    GO

    For Data Collection Component

    ALTER DATABASE dcc SET READ_COMMITTED_SNAPSHOT ON
    GO

    For Lifecycle Query Engine

    ALTER DATABASE lqe SET READ_COMMITTED_SNAPSHOT ON
    GO

    For Link Index Provider

    ALTER DATABASE ldx SET READ_COMMITTED_SNAPSHOT ON
    GO

    For Global Configuration

    ALTER DATABASE gc SET READ_COMMITTED_SNAPSHOT ON
    GO

  5. Create an environment variable named SQLSERVER_JDBC_DRIVER_FILE and point to the sqljdbc4.jar JDBC driver. The location of the driver varies depending on your installation.
    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 SQLSERVER_JDBC_DRIVER_FILE, and in the Variable value enter C:\Path_to_JDBC_dirver\sqljdbc4.jar.
    1. Open a shell window.
    2. Enter the following environment variable declaration:

      SQLSERVER_JDBC_DRIVER_FILE =.:Path_to_JDBC_dirver/sqljdbc4.jar

Install the Apache Tomcat server

Starting in version 6.0.1, Apache Tomcat is not provided as a default application server. However, Apache Tomcat is supported and you can use it. Complete the following steps to download and install Apache Tomcat.

The following method copies the Tomcat files to the Jazz Team Server installation directory and the examples show Apache Tomcat installed in this location: JazzInstallDir. If you install Tomcat in another location, change the installation path.

  1. Open a browser, go to the Apache Tomcat website, and download a supported version of Apache Tomcat application server. The supported version of Apache Tomcat is 7.0.59.
  2. Extract the downloaded .zip file to the JazzInstallDir/server\server directory.
  3. The extract procedure creates a directory named apache-tomcat-7.0.59. Rename this directory to tomcat.
  4. Go to the JazzInstallDir/server/webapps\server\webapps directory and copy all application WAR files to the JazzInstallDir/server/tomcat/webapps\server\tomcat\webapps directory.

Configure Apache Tomcat

When you set up a new installation of CLM to run on Apache Tomcat, you must update some of the default Tomcat configuration files before you start the application server.

b. Change the port numbers.

By default, all Tomcat port numbers are in the 8000 range. In CLM products, the default port numbers are in the 9000 range. If you want to change the default 8080 (HTTP) and 8443 ( HTTPS) port numbers, complete these steps:

  1. Go to the JazzInstallDir/server/tomcat/conf\server\tomcat\conf directory and open the server.xml file for editing.
  2. Change all instances of port="8080" and redirectPort="8443" to port="9080" and redirectPort="9443".
  3. Save the file.

c. Create secure connections (SSL/TLS).

If you want to use secure (HTTPS) connections, you must create or obtain a security certificate for SSL/TLS. You can either generate a self-signed certificate or obtain one from a certificate authority. For more information, see Installing a security certificate and SSL/TLS Configuration HOW-TO (apache.tomcat.org) .

In the following example, change my-ssl.keystore and my-ssl-password to the actual keystore file name and password. If you copy the .keystore file to TomcatHome, no path is required. Otherwise, provide a full path to the .keystore file.

After you create the .keystore file, make the following changes in the server.xml file:

  1. Locate the following connector and remove the <!-- --> comment tags from around the code snippet:
  2. <Connector port="8443" protocol="org.apache.coyote.http11.Http11Protocol"
    maxThreads="150" SSLEnabled="true" scheme="https" secure="true"
    clientAuth="false" sslProtocol="TLS" />

  3. Edit the code snippet to look like the following example. Ensure that you use the correct .keystore file name and password. Also, if you changed the connector port, ensure that you use the correct one:
  4. <Connector SSLEnabled="true"
    URIEncoding="UTF-8"
    acceptCount="100"
    algorithm="${jazz.connector.algorithm}"
    ciphers="SSL_DHE_RSA_WITH_AES_128_CBC_SHA,SSL_DHE_DSS_WITH_AES_256_CBC_SHA,SSL_DHE_RSA_WITH_AES_256_CBC_SHA,SSL_DHE_RSA_WITH_AES_128_CBC_SHA256,SSL_DHE_DSS_WITH_AES_128_CBC_SHA256,SSL_DHE_RSA_WITH_AES_256_CBC_SHA256,SSL_DHE_RSA_WITH_AES_128_GCM_SHA256,SSL_DHE_DSS_WITH_AES_128_GCM_SHA256,SSL_ECDHE_RSA_WITH_AES_128_CBC_SHA,SSL_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,SSL_ECDHE_RSA_WITH_AES_256_CBC_SHA,SSL_ECDHE_RSA_WITH_AES_128_GCM_SHA256,SSL_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,SSL_ECDHE_RSA_WITH_AES_256_GCM_SHA384,SSL_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,SSL_ECDHE_RSA_WITH_AES_128_CBC_SHA256,SSL_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,SSL_ECDHE_RSA_WITH_AES_256_CBC_SHA384,SSL_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,SSL_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,TLS_DHE_RSA_WITH_AES_128_CBC_SHA,TLS_DHE_DSS_WITH_AES_256_CBC_SHA,TLS_DHE_RSA_WITH_AES_256_CBC_SHA,TLS_DHE_RSA_WITH_AES_128_CBC_SHA256,TLS_DHE_DSS_WITH_AES_128_CBC_SHA256,TLS_DHE_RSA_WITH_AES_256_CBC_SHA256,TLS_DHE_RSA_WITH_AES_128_GCM_SHA256,TLS_DHE_DSS_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,SSL_RSA_WITH_3DES_EDE_CBC_SHA,SSL_RSA_WITH_AES_128_CBC_SHA,SSL_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_3DES_EDE_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_256_CBC_SHA"
    clientAuth="false"
    connectionTimeout="20000"
    disableUploadTimeout="true"
    enableLookups="false"
    keystoreFile="my-ssl.keystore"
    keystorePass="my-ssl-password"
    maxHttpHeaderSize="8192"
    maxThreads="150"
    minSpareThreads="25"
    port="9443"
    protocol="HTTP/1.1"
    scheme="https"
    secure="true"
    sslEnabledProtocols="${jazz.connector.sslEnabledProtocols}"/>

  5. Locate the AJP 1.3 connector and define it as follow by adding the sslEnabledProtocols parameter. Ensure to use the correct redirect port.
  6. <Connector enableLookups="false"
    port="9009"
    protocol="AJP/1.3"
    redirectPort="9443"
    sslEnabledProtocols="${jazz.connector.sslEnabledProtocols}"/>

  7. Save the server.xml file.

d. Enable single sign-on.

If you use Jazz Security Architecture single sign-on, Apache Tomcat does not authenticate users, so no configuration is required for the user registry.

If you install more than one CLM application on the same Tomcat instance, complete these steps to enable Tomcat single sign-on:

  1. In the server.xml file, locate the following line and remove the comment tags from around it.
  2. <Valve className="org.apache.catalina.authenticator.SingleSignOn" />

e. Configure the user registry.

If you use an LDAP user registry, follow the instructions in Manually configuring the Apache Tomcat web container to use LDAP to configure Tomcat to use your LDAP registry.

Complete the following steps to update the Tomcat user registry.

  1. In the server.xml file, locate the <Resource name="UserDatabase" auth="Container" line.
  2. Add the attribute readonly="false". The entire Resource code snippet should look like this:
  3. <Resource name="UserDatabase" auth="Container"
    type="org.apache.catalina.UserDatabase"
    description="User database that can be updated and saved"
    factory="org.apache.catalina.users.MemoryUserDatabaseFactory"
    pathname="conf/tomcat-users.xml"
    readonly="false"/>

  4. In the server.xml file, locate the <Realm className="org.apache.catalina.realm.UserDatabaseRealm" line.
  5. Add the attributes digest="SHA-1" and digestEncoding="UTF-8":
  6. <Realm className="org.apache.catalina.realm.UserDatabaseRealm"
    digest="SHA-1"
    digestEncoding="UTF-8"
    resourceName="UserDatabase"/>

f. Disable access logging.

In previous releases of CLM, access logging was disabled by default to improve performance. If you do not use access logging, insert comment tags around the following section in the server.xml file:

<!--
<Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs"
prefix="localhost_access_log." suffix=".txt"
pattern="%h %l %u %t "%r" %s %b" />
-->

g. Define Jazz security roles.

You must define the standard Jazz security roles and create an administrative user account. In previous releases, a predefined ADMIN user with the ADMIN password was used for the initial administrative login. Now, you can define any user name and password in the tomcat-users.xml file. To define Jazz security roles and create a default user, complete these steps:

  1. Go to JazzInstallDir/server/tomcat/conf\server\tomcat\conf and open the tomcat-users.xml file for editing.
  2. Add the following code snippet to the <tomcat-users>:
  3. <tomcat-users>
    <role rolename="JazzUsers"/>
    <role rolename="JazzAdmins"/>
    <role rolename="JazzGuests"/>
    <role rolename="JazzProjectAdmins"/>
    <role rolename="manager-gui"/>
    <user username="ADMIN" password="ADMIN" roles="JazzUsers,JazzAdmins,JazzProjectAdmins"/>
    </tomcat-users>

    The password must be entered in clear text in the tomcat-users.xml file, and then encrypted by completing the following steps.

  4. Open a command window and enter these commands:

    cd JazzInstallDir/server\server
    repotools-jts -convertTomcatUsers tomcatUsersPath=JazzInstallDir/server/tomcat/conf/\server\tomcat\conf\tomcat-users.xml

  5. The repotools command creates a file called tomcat-users.xml.converted. Delete the original tomcat-users.xml file and rename tomcat-users.xml.converted to tomcat-users.xml.

Start the Apache Tomcat server

You are now ready to start the Apache Tomcat server.

  1. To start the server, open a command prompt and change to the JazzInstallDir\server directory.
  2. Enter this command:

    server.startup.bat -tomcat

    Note: A separate Apache Tomcat console window opens. If you close this window, the server stops. Depending on your installation options, the server startup might take a few minutes. After the server is started, the startup time in millisecond is displayed in the Tomcat window. For example, a line like this might be displayed: Server startup in 203645 ms.

    Important: If the server is installed in the default Program Files directory, to be able to write to this directory, you must run the startup program as an administrator.

  3. Tip: To stop the server, you can enter server.shutdown.bat -tomcat

  1. To start the server, open a command shell and change to the JazzInstallDir/server directory.
  2. Enter this command:

    ./server.startup -tomcat

    Note: A separate Apache Tomcat console window does not open. You can check the server startup progress by viewing the JazzInstallDir/server/logs/jts.log file.

    After you access the server for the first time, the logs directory under JazzInstallDir/server is created.

  3. Tip: To stop the server, you can enter ./server.shutdown -tomcat

Manage federated file-based user registry

Before you begin

  • Ensure that WebSphere Application Server is already installed and running.

About this task

Jazz Team Server uses J2EE container managed authentication for login and system permissions. For application server to work, you must configure a realm with the application server. The file-based user registry is useful for testing or evaluation, because Jazz Team Server does not support importing users or mapping user roles. For the full application functionality, including viewing system user roles and importing users, Jazz Team Server supports an LDAP realm.

Configure the federated repositories

  1. In the WebSphere Integrated Solutions Console, click Security > Global security.
  2. Make sure Enable administrative security and Enable application security check boxes are selected.
  3. From the Available realm definitions select Federated repositories and click Configure.
  4. In the Primary administrative user name field, type the WebSphere Application Server administrative ID.
  5. Under Server user identity, make sure Automatically generated server identity is selected. Click OK and then save.
  6. Set Federated repositories as the current realm definition by clicking Set as Current.
  7. Stop and restart the WebSphere Application Server.

Setting up groups and users

To be able to run Jazz Team Server, you need to define groups and users in the WebSphere Application Server repository and map them to Jazz groups. Before Installing any CLM applications, you must create the user groups.

  1. In the WebSphere Integrated Solutions Console, click Users and Groups > Manage Groups.
  2. Click Create and create the following group names:
    • JazzAdmins
    • JazzProjectAdmins
    • JazzUsers
    • JazzGuests
  3. In the Users and Groups section, click Manage Users.
  4. Click Create and enter a name in the User ID field to create a user in the JazzAdmins group.
  5. Click Group Membership and then click Search.
  6. Select JazzAdmins from the Available window and then click Add, to add JazzAdmins to the Mapped To window.
  7. Click Close and in the Create a User page fill in the remaining required fields. Click Create.
  8. Click Create Like and create other users and assign them to the appropriate Jazz group membership.

Start the Liberty server

You are ready to start the Liberty server.

  1. To start the Liberty server, open a command windowshell and enter the following commands:
  2. cd JazzInstallDir\server
    server.startup.bat

    cd JazzInstallDir/server
    ./server.startup

Set up the WebSphere Application Server by using the Jython script

The clm_was_config.py script configures WebSphere Application Server and sets up security options so that you can run CLM applications in a WebSphere environment.

Before you begin

Ensure you have completed the following tasks:

Procedure

  1. If your Jazz Team Server is installed on a Windows platform, but you are using the DB2 for z/OS database server, open the Jazz_Install_Dir/server/was/clm_was_config.py for editing.
  2. Search for #createJVMCustomProperty(jvm, "DB2Z_JDBC", db2DriverPath, "") and delete the # sign at the begining of the line to remove the comment.
  3. Add the file path to location of the Db2z JDBC driver. Note the forward slash. For example:

    createJVMCustomProperty(jvm, "DB2Z_JDBC", "/etc/jazz/server/db2z", "")

  4. To configure the Oracle JDBC driver location open the Jazz_Install_Dir/server/was/clm_was_config.py for editing.
  5. Search for #createJVMCustomProperty(jvm, "ORACLE_JDBC_DRIVER_FILE", oracleDriverPath, "") and delete the # sign at the begining of the line to remove the comment.
  6. Add the absolute path to location of the Oracle JDBC driver. For example:

    createJVMCustomProperty(jvm, "ORACLE_JDBC_DRIVER_FILE", "C:\app\user\product\11.2.0\dbhome_1\jdbc\lib\ojdbc6.jar", "")

    createJVMCustomProperty(jvm, "ORACLE_JDBC_DRIVER_FILE", "/opt/app/user/product/11.2.0/dbhome_1/jdbc/lib/ojdbc6.jar", "")

  7. To configure the SQL Server JDBC driver location open the Jazz_Install_Dir/server/was/clm_was_config.py for editing.
  8. Search for #createJVMCustomProperty(jvm, "SQLSERVER_JDBC_DRIVER_FILE", sqlDriverPath, "") and delete the # sign at the begining of the line to remove the comment.
  9. Add the absolute path to location of the SQL Server JDBC driver. For example:

    createJVMCustomProperty(jvm, "SQLSERVER_JDBC_DRIVER_FILE", "C:\MSSQL\jdbc\sqljdbc4.jar", "")

    createJVMCustomProperty(jvm, "SQLSERVER_JDBC_DRIVER_FILE", "/opt/mssql/jdbc/sqljdbc4.jar", "")

  10. Save and close the clm_was_config.py file.
  11. Open a command window as administrator and enter the following commands. Replace WAS_Profile_Dir with the directory where WebSphere Application Server profile is installed. For example, C:\Program Files (x86)\IBM\WebSphere\AppServer\profiles\AppSrv01/opt/IBM/WebSphere/AppServer/profiles/AppSrv01:
  12. Note: On Windows platforms you must use forward slash in the paths for the location of the Jython script and the conf directory.

    cd WAS_Profile_Dir\bin
    wsadmin.bat -lang jython -user WAS_USER -password WAS_PASSWORD -f C:/Jazz_Install_Dir/server/was/clm_was_config.py C:/Jazz_Install_Dir/server/conf

    cd WAS_Profile_Dir/bin
    ./wsadmin.sh -lang jython -user WAS_USER -password WAS_PASSWORD -f /opt/Jazz_Install_Dir/server/was/clm_was_config.py /opt/Jazz_Install_Dir/server/conf

  13. For changes to take effect, restart the application server. Replace server1 with the name of your application server:
  14. cd WAS_Profile_Dir\bin
    stopServer.bat server1 -user WAS_USER -password WAS_PASSWORD
    startServer.bat server1

    cd WAS_Profile_Dir/bin
    ./stopServer.sh server1 -user WAS_USER -password WAS_PASSWORD
    ./startServer.sh server1

Set up the WebSphere Application Server

Before you begin

Ensure you have completed the following tasks:

  • WebSphere Application Server is already installed and running.
  • You have the WebSphere administrative user name and password.
  • Verify or update the WebSphere Application Server level. For a list of supported versions and fix packs, see the Detailed System Requirements page.
  • On Unix systems, ensure that the Open File Limit value is properly set. For more information, see Planning to install on UNIX and Linux systems.
  • The database is created. If you use the default Derby database for evaluation purposes, ensure the location to the database in the teamserver.properties file is an absolute path.

Procedure

  1. Open a browser and login to WebSphere Integrated Solutions Console at https://hostname.example.com:9043/ibm/console/logon.jsp.
  2. The Java 2 Security option must be turned off. If this option is turned on in WebSphere Application Server, the web application will not start.
    1. Click Security > Global security.
    2. Under Java 2 security, clear the check box for Use Java 2 security to restrict application access to local resources.
    3. Ensure that the Enable administrative security and Enable application security check boxes are selected.
  3. To ensure that the LTPA cookies are secure, enable the Requires SSL setting:
    1. Click Security > Global security > Web and SIP security > Single sign-on(SSO).
    2. Click the Requires SSL check box.
    3. Click OK and Save directly to the master configuration.
  4. Also ensure that the Use available authentication data when an unprotected URI is accessed application server security setting is selected.
    1. Click Security > Global security > Web and SIP security > General settings.
    2. Click the Use available authentication data when an unprotected URI is accessed check box.
    3. Click OK and Save directly to the master configuration.
  5. Add the following session management custom property to avoid SESN0008E error message when a user logs out without terminating the session:
    1. Click Servers > Server Types > WebSphere application servers.
    2. Click server1 and then in the Container Settings section, click Session management.
    3. In the Additional Properties section, click Custom properties.
    4. Click New and enter the following information:
      • Name: InvalidateOnUnauthorizedSessionRequestException
      • Value: true
    5. Click Apply and save directly to the master configuration.
  6. To improve performance of the operating procedures, change the WebContainer thread pool size settings:
    1. Click Servers > Server Types > WebSphere application servers.
    2. Click server1 and then in the Additional Properties section, click Thread pools.
    3. In the Thread pools page, click WebContainer.
    4. Enter 200 in the Minimum Size and Maximum Size fields.
    5. Click OK and save directly to the master configuration.
  7. Jazz Team Server requires several specific settings on the Java Virtual Machine in which it runs. To set these properties, click Servers > Server Types > WebSphere application servers > server1.
  8. Under Server Infrastructure, click Java and Process Management > Process definition.
  9. Under Additional Properties, click Java Virtual Machine.
  10. In the Generic JVM arguments field, type the following lines:

    -Xmx4g -Xms4g -Xmn1g
    -Xgcpolicy:gencon -Xnocompressedrefs
    -XX:MaxDirectMemorySize=1G

    -Xmx4g -Xms4g -Xmn1g
    -XX:MaxPermSize=768M -XX:ReservedCodeCacheSize=512M -XX:CodeCacheMinimumFreeSpace=2M

    -Xmx4g -Xms4g -Xmn1g
    -Xgcpolicy:gencon -Xcompressedrefs
    -Xgc:preferredHeapBase=0x100000000
    -XX:MaxDirectMemorySize=1G

    Tip: If you need more heap size, then you can use the following setting, replacing {N} with the amount of memory to be used and {N/4} with 1/4 of the total memory. For example, if -Xmx is set to 8g, -Xmn should be set to 2g.

    -Xmx{N} -Xms{N} -Xmn{N/4}

    For Rational DOORS Next Generation only: The -Xmn value should be 33% of the -Xms value. For example, if the -Xmx size is 4gb, the -Xmn should be 1365m. The following Deployment wiki document contains useful information about Rational DOORS Next Generation sizing and tuning: Sizing and tuning guide for Rational DOORS Next Generation 6.0: configuration management.

  11. Click Apply, and then click Save directly to the master configuration.
  12. One of the custom properties you must add is JAZZ_HOME, a system property that specifies where to find certain configuration files. This property uses a URL rather than a simple path, so specify the value as a file-style URL: file:///file_path. Under Java Virtual Machine > Additional Properties, click Custom properties. You must use three forward slashes (///) after file:.

    In a distributed environment, when you are using a separate application server for each web application, you must add these custom properties for each instance of the WebSphere Application Server.

  13. Click New, enter JAZZ_HOME in the Name field, and enter file:///JazzInstallDir/server/conf in the Value field. Substitute JazzInstallDir with the location of Jazz Team Server installation directory. For example, file:///C:/PROGRA~1/IBM/JazzTeamServer/server/conf if the server is installed in /opt/IBM, enter file:////opt/IBM/JazzTeamServer/server/conf.

    To avoid problems, do not use spaces in file paths. You can use double quotation marks to enclose the path.

  14. Click OK.
  15. Repeat Step m and add these custom properties:
    • Name: lqe.config.location Value: file:///JazzInstallDir/server/conf/lqe
    • Name: ldx.config.location Value: file:///JazzInstallDir/server/conf/ldx
    • Name: java.awt.headless Value: true
    • Name: org.eclipse.emf.ecore.plugin.EcorePlugin.doNotLoadResourcesPlugin Value: true
    • Name: ORACLE_JDBC_DRIVER_FILE Value: Absolute_path_to_the_JDBC_driver/ojdbc6.jar

      Note: The path to the JDBC driver must be an absolute path. Do not use URL path (file:///). For more information about Oracle Java Database Connectivity (JDBC) connections, see Set up the database step.

    • Name: SQLSERVER_JDBC_DRIVER_FILE Value: Absolute_path_to_the_JDBC_driver/sqljdbc4.jar

      Note: The path to the JDBC driver must be an absolute path. Do not use URL path (file:///). For more information about SQL Server JDBC connections, see Set up the database step.

    • Name: log4j.configuration Value: file:///JazzInstallDir/server/conf/startup_log4j.properties

      The settings that the startup_log4j.properties file contains are used at the early stages in the startup process to pass messages to the WebSphere Application Server SystemOut.log file. After the early stages, each Jazz application switches to using the application-specific settings from the JazzInstallDir/server/conf/app_context/log4j.properties file.

  16. Click Save directly to the master configuration.
  17. In the WebSphere Integrated Solutions Console navigation pane, expand Environment and click Shared libraries.
  18. In the Scope list, select Node=MachineNameNode01, Server=server1 and click New.
  19. Enter the shared library name JRS Shared Library, add a description, and set the classpath to: JRS_install_dir/server/conf/rs/\server\conf\rs\WAS_SharedLibrary. For example: C:\Progra~1\IBM\JazzTeamServer\server\conf\rs\WAS_SharedLibrary/opt/IBM/JazzTeamServer/server/conf/rs/WAS_SharedLibrary
  20. Under Class Loading, select the Use an isolated class loader for this shared library check box, click Apply, and then click Save.
  21. For changes to take effect, restart the application server.

Deploy web application (WAR files) by using the Jython script

You can use clm_deploy.py or clm_deploy_distributed.py in a distributed environment to deploy application WAR files. These scripts also map the appropriate security roles for JTS, CCM, and QM applications.

Before you begin

Ensure that WebSphere Application Server, Jazz Team Server, and CLM applications are installed prior to running the script.

Complete the following steps to map the security roles to your LDAP groups. Note that the groups must be setup on the LDAP server prior to completing this mapping.

  1. Open the clm_deploy.py or clm_deploy_distributed.py scripts in a text editor for editing.
  2. Go to the end of the script and remove the comments from the following lines:
  3. # Example of how to set role/mapping for jts.war
    AdminApp.edit('jts.war', '[-MapRolesToUsers [["JazzAdmins" No No "" admins]["JazzDWAdmins" No No "" admins]["JazzUsers" No No "" users]["JazzGuests" No No "" users]["JazzProjectAdmins" No No "" admins]]]')
    AdminConfig.save()

    Use the following examples to modify the role/mapping for the application:

    # Set role/mapping for jts.war
    AdminApp.edit('jts.war', '[-MapRolesToUsers [["JazzAdmins" No No "" cn=JazzAdmins,cn=members,o=ldap.server.com]["JazzUsers" No No "" cn=JazzUsers,cn=members,o=ldap.server.com]["JazzGuests" No No "" cn=JazzGuests,cn=members,o=ldap.server.com]["JazzProjectAdmins" No No "" cn=JazzProjectAdmins,cn=members,o=ldap.server.com]]]')
    AdminConfig.save()

    # Set role/mapping for ccm.war
    AdminApp.edit('ccm.war', '[-MapRolesToUsers [["JazzAdmins" No No "" cn=JazzAdmins,cn=members,o=ldap.server.com]["JazzUsers" No No "" cn=JazzUsers,cn=members,o=ldap.server.com]["JazzGuests" No No "" cn=JazzGuests,cn=members,o=ldap.server.com]["JazzProjectAdmins" No No "" cn=JazzProjectAdmins,cn=members,o=ldap.server.com]]]')
    AdminConfig.save()

    # Set role/mapping for qm.war
    AdminApp.edit('qm.war', '[-MapRolesToUsers [["JazzAdmins" No No "" cn=JazzAdmins,cn=members,o=ldap.server.com]["JazzUsers" No No "" cn=JazzUsers,cn=members,o=ldap.server.com]["JazzGuests" No No "" cn=JazzGuests,cn=members,o=ldap.server.com]["JazzProjectAdmins" No No "" cn=JazzProjectAdmins,cn=members,o=ldap.server.com]]]')
    AdminConfig.save()

  4. Save and close the file.

About this task

The clm_deploy.py script installs all application WAR files that are available in the webapps directory into a single WebSphere Application Server node.

The clm_deploy_distributed.py script can be used to install any application WAR files that are available in the webapps directory, if you specify them in your command argument as a comma-separated list.

Note: The web archive applications must have a .war extension.

Procedure

To deploy applications on a single WebSphere Application Server, complete this step:

  1. Open a command window as administrator and enter the following commands. Replace nodeName and server1 with your WebSphere Application Server node name and server name:
  2. Note: On Windows platforms you must use forward slash in the paths for the location of the Jython script and the webapps directory.

    cd WAS_Profile_Dir\bin
    wsadmin.bat -lang jython -user WAS_USER -password WAS_PASSWORD -f C:/Jazz_Install_Dir/server/was/clm_deploy.py nodeName server1 C:/Jazz_Install_Dir/server/webapps

    cd cd WAS_Profile_Dir/bin
    ./wsadmin.sh -lang jython -user WAS_USER -password WAS_PASSWORD -f /opt/Jazz_Install_Dir/server/was/clm_deploy.py nodeName server1 /opt/Jazz_Install_Dir/server/webapps

To deploy applications in a distributed WebSphere Application Server environment, complete this step:

  1. Open a command window as administrator and enter the following commands. Replace nodeName and server1 with your WebSphere Application Server node name and server name:
  2. Note: On Windows platforms you must use forward slash in the paths for the location of the Jython script and the webapps directory.

    cd WAS_Profile_Dir\bin
    wsadmin.bat -lang jython -user WAS_USER -password WAS_PASSWORD -f C:/Jazz_Install_Dir/server/was/clm_deploy_distributed.py nodeName server1 C:/Jazz_Install_Dir/server/webapps jts,ccm,clmhelp

    cd cd WAS_Profile_Dir/bin
    ./wsadmin.sh -lang jython -user WAS_USER -password WAS_PASSWORD -f nodeName server1 /opt/Jazz_Install_Dir/server/was/clm_deploy_distributed.py /opt/Jazz_Install_Dir/server/webapps jts,ccm,clmhelp

  3. To start the deployed applications, restart the application server. Replace server1 with the name of your application server:
  4. cd WAS_Profile_Dir\bin
    stopServer.bat server1 -user WAS_USER -password WAS_PASSWORD
    startServer.bat server1

    cd WAS_Profile_Dir/bin
    ./stopServer.sh server1 -user WAS_USER -password WAS_PASSWORD
    ./startServer.sh server1

Deploy web applications (WAR files)

Before you begin

  • Make sure WebSphere Application Server is installed and started.
  • You have access to the .WAR files. If you used IBM Installation Manager to install the CLM applications and during the installation cleared the check box for Install Tomcat 7, by default, the web application files (.WAR) are copied into the JazzInstallDir/server/webapps directory. If during installation you selected Install Tomcat 7, the web application files (.WAR) are copied into the JazzInstallDir/server/tomcat/webapps directory.
  • If WebSphere Application Server is installed in a non-root environment, the user who deploys the CLM applications must have read and write access to the installation directory and all sub-directories.
  • Uninstall WebSphere Application Server default applications (DefaultApplication, ivtApp, and query) if they are installed with the profile. Jazz Team Server and CLM applications do not use these applications and for security and performance reasons they can be removed.

Procedure

  1. Open a browser and login to WebSphere Integrated Solutions Console at https://hostname.example.com:9043/ibm/console/logon.jsp.
  2. Click Applications > New Application > New Enterprise Application.
  3. On the Path to the new application page, select Remote file system and browse for the application.war file. Click Next.

    Depending on the CLM applications that you installed, the following web applications might be available for deployment:

    • jts.war
    • clmhelp.war
    • ccm.war
    • relm.war
    • qm.war
    • rm.war
    • converter.war
    • dm.war
    • rdmhelp.war
    • rsadm.war
    • dcc.war
    • lqe.war
    • ldx.war
    • rs.war
    • gc.war

  4. Select Fast Path, and then click Next.
  5. For the Lifecycle Query Engine and Link Index Provider modules, expand Choose to generate default bindings and mappings, and then select the Generate Default Bindings check box.
  6. On the Map modules to servers page, select the check box next to ldx to specify the target scope on the server for the ldx module.
  7. On the Map modules to servers page, select the check box next to lqe to specify the target scope on the server for the lqe module.
  8. Click Next to accept all default options until you reach the Map context roots for web modules page.
  9. In the Map context roots for web modules, set the following Context Root for applications:
    • Jazz Team Server to /jts
    • IBM Knowledge Center to /clmhelp
    • Change and Configuration Management to /ccm
    • Rational Engineering Lifecycle Manager to /relm
    • Quality Management to /qm
    • Requirements Management to /rm
    • Converter application to /converter
    • Design Management to /dm
    • Data Collection Component to /dcc
    • Report Builder to /rs
    • Lifecycle Query Engine to /lqe
    • Link Index Provider to /ldx
    • Global Configuration to /gc
  10. Click Finish.
  11. Verify that your application was installed correctly and then click Save directly to the master configuration.

Map security roles to a user or repository group

The jts_war, qm_war, and ccm_war applications must have the same authentication methods for their users and use the same security group mapping.

  1. In WebSphere Integrated Solutions Console click Applications > Application Types > WebSphere enterprise applications.
  2. For Jazz Team Server, click the jts_war application to open it for editing.
  3. For Change and Configuration Management, click the ccm_war application to open it for editing.
  4. For Quality Management, click the rqm_war application to open it for editing.
  5. In the Detail Properties section, click Security role to user/group mapping.
  6. Select a specific repository group, such as JazzAdmins or JazzUsers, and click Map groups.

    These repository groups are associated with every Jazz implementation and must be mapped to a particular group that contains the authorized users. If you are using LDAP, these groups must be set up on the LDAP server prior to completing this mapping. If you are mapping these repository groups to individual users, select the repository group and click Map Users.

  7. Enter a search string to return your users or group names. Click Search to run the query.
  8. From the list of available users or groups that is returned, select the particular user or group and move it to the Selected column.
  9. Click OK to map the users or groups to the Jazz repository groups.
  10. Save the changes.

Note: If in the future there will be changes to the LDAP configuration level, you must remap the security roles to the user or repository group for JTS and other installed applications.

Configure the Lifecycle Query Engine application

  1. In WebSphere Integrated Solutions Console click Applications > Application Types > WebSphere enterprise applications.
  2. Click lqe_war to open it and then click Manage Modules.
  3. Click lqe, locate the Class loader order field and select Classes loaded with local class loader first (parent last).
  4. Click OK and save your changes.
  5. Go back to the lqe_war application and click Class loading and update detection.
  6. On the Class loader page, select Classes loaded with local class loader first (parent last).
  7. Click Apply and Save directly to the master configuration.

Configure the Link Index Provider application

  1. In WebSphere Integrated Solutions Console click Applications > Application Types > WebSphere enterprise applications.
  2. Click ldx_war to open it and then click Manage Modules.
  3. Click ldx, locate the Class loader order field and select Classes loaded with local class loader first (parent last).
  4. Click OK and save your changes.
  5. Go back to the ldx_war application and click Class loading and update detection.
  6. On the Class loader page, select Classes loaded with local class loader first (parent last).
  7. Click Apply and Save directly to the master configuration.

Configure the Report Builder application

  1. In WebSphere Integrated Solutions Console click Applications > Application Types > WebSphere enterprise applications.
  2. On the Enterprise Applications page, in the list of resources, click rs_war.
  3. On the Configuration page, in the References section, click Shared library references.
  4. Select the rs_war check box and click Reference shared libraries.
  5. In the Available list, select JRS Shared Library and click the right arrow.
  6. Click OK. Click OK again and then click Save.
  7. In the list of resources, click rs_war.
  8. On the Configuration page, under Detail Properties, click Class loading and update detection.
  9. In the Class loader order group, ensure that Classes loaded with local class loader first (parent last) is selected. Click Apply and then click Save.

Start the applications

  1. In WebSphere Integrated Solutions Console click Applications > Application Types > WebSphere enterprise applications.
  2. Select the check box next to these applications, and then click Start:
    • jts_war
    • clmhelp_war
    • ccm_war
    • relm_war
    • qm_war
    • rm_war
    • converter_war
    • dm_war
    • rdmhelp_war
    • rsadm_war
    • dcc_war
    • lqe_war
    • ldx_war
    • rs_war
    • gc_war

    A green arrow should appear that indicates the application is successfully started.

    Note: The Converter application is supported only on Windows and Linux. For installation instructions on other unsupported platforms, see the Delegated Configuration section of Requirements Management Converter Application Configuration and Troubleshooting Guide.

Configure the server on IBM i

For information about configuring the server, see Configuring the server on IBM i.

Manage users by configuring LDAP

To configure your WebSphere Liberty to use an LDAP registry to authenticate users, see Configuring an LDAP connection.

To configure your Apache Tomcat to use an LDAP registry to authenticate users, see the topics under Managing users by using LDAP.

To configure your WebSphere Application Server to use an LDAP registry to authenticate users, see Enabling LDAP on WebSphere Application Server.

Run the setup wizard

After installing the applications, databases, and starting the Jazz Team Server and other applications, you can login to the Jazz Team Server (jts/setup) page and run the setup wizard to configure the servers.

The Express setup is a simplified version of the wizard that lets you set up the default Derby database and Liberty Basic User Registry. The wizard will detect and set up the applications that you have just installed.

Procedure

  1. Point your web browser to the following address: https://hostname.example.com:9443/jts/setup.
  2. Type ADMIN (case-sensitive) in both the User ID and Password fields. Click Log In.
  3. On the Welcome page, select Express Setup. Click Next.
  4. On the Configure Public URI page, provide a Public URI that is of the form https://[fully qualified hostname]:9443/jts and select the check box to confirm that you have read and understood the recommendations on this page. Click Test Connection. After the test is successful, click Next.

    Important: A [fully qualified hostname] is the host name along with the DNS domain reference of the machine on which the Jazz Team Server is installed. An example of a good [fully qualified hostname] is hostname.example.com. Examples of bad [fully qualified hostname] are localhost or an IP address.

  5. On the Create Administrative User page, create an administrative user by providing a user ID, full name, password, and email address. This new administrative user ID will replace the default ADMIN user. Click Next.
  6. The Setup Progress page is open and displays each step of the progress. A green check mark denotes that the step was successful. After setting up the application is 100% complete, click Next.
  7. On the Assign Licenses page, if necessary, click Activate Trial for the required licenses. This opens the License Agreement page for a selected license. Read and accept the license agreement, and then click Finish.
  8. After activating the required licenses, click Finish. This opens the Server Administration page where you can perform additional administrative and project management tasks such as, managing the server, users, and licenses. For more information, see Administering Rational solution for Collaborative Lifecycle Management servers.

The Custom setup wizard takes you through setting up your database, configuring email settings, configuring the user registry, and registering applications.

Before you begin

  • Make sure Jazz Team Server is installed and running.
  • For new installations, if you do not want to use the default port numbers, you must change them before you use the setup wizard. For more information, see Changing the port numbers for the application server.
  • Databases must be created before running the setup wizard. Make sure that you performed the Set up the database step in this document.
  • On a single server topology, the wizard detects and allows you to set up the applications that you have just installed. In a distributed environment, first install and start Jazz Team Server and all applications on each individual server and make note of the applications discovery URL. Then, run the setup wizard on the server where Jazz Team Server is installed and on the Register Applications page provide the discovery URL of the applications that are installed on the other servers.

Procedure

  1. Point your web browser to the following address: https://hostname.example.com:9443/jts/setup.
  2. Type ADMIN (case-sensitive) in both the User ID and Password fields. Click Log In.
  3. Log in with your WebSphere Administrative ID that is a member of JazzAdmins user group.
  4. Log in as an LDAP registered user who has JazzAdmins privileges. Note that the LDAP user or group must be mapped to the repository group.
  5. On the Welcome page make sure Custom Setup is selected, and then click Next.
  6. Read the information on the Introduction page and click Next.
  7. On the Configure Public URI page, provide a public URI that is of the form https://fully qualified hostname:9443/jts and select the check box to confirm that you have read and understood the recommendations on this page. Click Test Connection. After the test is successful, click Next.
  8. On the Configure Database page, provide information to set up a connection to the Jazz Team Server database.
    • Database Vendor: Select DB2OracleSQL ServerDB2 for z/OS.
    • Connection Type: Select J2EE if you manage your database connection by the J2EE container in WebSphere Application Server. You must provide the J2EE datasource name. JDBC connection type does not involve the container and Jazz Team Server connects to the database directly and manages the connection pooling.
    • For JDBC connection type, provide JDBC location and JDBC password. For DB2 for z/OS, provide the schema prefix and the DB2z database name in the appropriate fields.
    • Click Test Connection and when the connection was successful, click Create Tables. This step might take a few minutes. After database tables are created successfully, click Next to continue.
  9. On the Enable E-mail Notification page, enable or disable email notifications. If you choose to enable notifications, you will need to provide information about your email server and test the connection to the email server. Click Next after making your selections and testing the connection.
  10. On the Register Applications page, the wizard detects the applications that were installed along with the Jazz Team Server on the same server. It might take a minute for each application to be discovered and added to the list of applications to register. The wizard will not detect those applications installed on a different server.
    1. Optional: If you do not want to register an application, click the X icon to the far right of the application name. Typically, you should register all applications; however, you might not want to register one or more applications in the following situations:
      • You downloaded and deployed all applications, but you do not intend to use all of them.
      • You will not have licenses that allow access to an application.
      • You are configuring this Jazz Team Server application as a stand-alone floating or token license server.
    2. Verify the Application Type and Discovery URL of the installed applications. The wizard creates default pre-authorized functional User IDs for each application.
    3. Optional: To add an application installed on a different server, click Add Application and provide the application name and discovery URL. After you provide the application name and discovery URL, the Functional User ID will be generated and entered automatically. The functional user ID will be used to run tasks in the background. The functional user ID does not have to exist in the external user registry or as a user in the repository; if the user doesn't exist in the repository, it will be automatically created.
    4. Click Register Applications. The wizard creates friend relationships, registers the applications, and generates a consumer key and secret for each application.
    5. After registration is successful, click Next to configure the registered applications. Notice that the menu on the left now lists the registered application along with sub-steps.
  11. On the Setup User Registry page, provide the following information:
    1. Select the type of user registry you will use.
      • Liberty Basic Registry: Select this option if your application server is the default Liberty profile and you do not have an LDAP server. This is the simplest configuration option and allows the Jazz Team Server to manage users and groups for you with the Liberty profile user database.
      • If you select an LDAP user registry, you must provide information to configure the connection between the Jazz Team Server and your LDAP server. You might need to request this information from your LDAP administrator.
      • Select this option if your application server is Tomcat and you don't have an LDAP server. This is the simplest configuration option and allows the Jazz Team Server to manage users and groups for you with the Tomcat user database.
      • If you select Non-LDAP External Registry, enter the same user ID that you used to log into the setup wizard. This is the WebSphere Application Server administrative user ID.
      • For WebSphere Application Server on z/OS with RACF security or WebSphere Application Server on IBM i with local OS authentication, select non-LDAP external registry.
    2. Provide the user ID, name, password, and email Address of the user who will have administrative access to the Jazz Team Server.
    3. Optionally disable the default ADMIN access by selecting the appropriate check box.
    4. Depending on the installed applications, under Rational DOORS Next Generation, Rational Team Concert, Rational Quality Manager, Rational Engineering Lifecycle Manager, select the Client Access Licenses (CALs) you want the administrative user to have. You can assign only one type of role-based CAL to the administrator. For example, you can assign the administrator only a Rational Team Concert - Developer CAL or a Rational Team Concert - Stakeholder CAL, but not both. The same rule applies to other applications. If you have installed the trial licenses, you must accept the terms of a license before you can assign it to the administrative user. To activate a license, click Activate Trial; then, in the Client Access License Agreement window, click I accept the terms in the license agreement and click Finish.
    5. Tip: See Client access license management overview for information on how licenses can provide different levels of access to the capabilities in the applications in the current release.

  12. Click Next after making your selections.
  13. On the Configure Data Warehouse page provide information to set up a connection to the data warehouse. The data warehouse is a database used for reporting and analytics. By default, the application is pre-configured to use the Derby database that is included with the application and configuration is not required. Click Next to continue. If you have a database prepared on an enterprise database server such as DB2 OracleSQL Server, you must configure the Jazz Team Server to use that database. Select the database vendor and the connection type from the list and enter the connection properties.
    1. In the Configure Data Warehouse Database Vendor and Connection Type section, select your Database Vendor and Connection type for that database vendor. The defaults are to use the included, pre-configured Derby database with a JDBC connection. You can either keep this default or choose a different database vendor and connection type.

      Note: If you select J2EE for connection type, you must also set the resultSetHoldability property to 1 in WebSphere Application Server. By default, this property is set to 2. If you do not set this property to 1, some of the data warehouse collection jobs might fail. For more information about resultSetHoldability, see your WebSphere Application Server documentation.

    2. In the Configure Data Warehouse Database Connection Properties section, type the connection properties to connect to your database. The required values vary depending on your database vendor and connection type.
    3. In the Database Table Space Folder field, type the path to an existing directory on the database server where the table space will be created and specify any additional advanced server properties for your database:
      • Temporary Table Space
      • ODS Table Space
      • ODS Index Table Space
      • Star Table Space
      • Star Index Table Space
      • Custom Report Database User
    4. If you used Rational Common Reporting or Rational Insight and you want to use the existing data warehouse database as the data warehouse for your CLM products, provide the information to connect to that existing database. You are prompted to add tables to your Rational Common Reporting or Rational database.
    5. Click Test Connection to verify that the server can successfully communicate with the database by using the connection information that you provided.
    6. If you did not previously use a repotools command to create the database tables, you might see a warning that the database exists but that it does not contain any tables. To create the tables, click Create tables. You might have to wait several minutes for the command to finish.
    7. Click Next.
  14. If you do not want to configure the data warehouse at this time, select the I do not wish to configure the data warehouse at this time check box.

    If you do not configure the data warehouse, your applications will be functional but you will not be storing any reporting data and most reports will not work.

  15. For each application configure the database and the data warehouse similar to the steps you carried out previously.
  16. On the Finalize Application page, click Finalize Application Setup.
  17. On the Setup Report Builder page, click Connect to data sources. Jazz Team Server detects the data sources and makes the connection. If you want to import reports provided by your data sources, click Import ready-to-use reports.
  18. On the Summary page, click Finish to access the Jazz Team Server Administration page where you can perform administration tasks such as, managing the server, users, and licenses. For more information, see Administering Rational solution for Collaborative Lifecycle Management servers.

Configure the server by using the setup repotools command

You can run the setup command from a command-line to set up databases, configure email settings, configure the user registry, and register any applications you have just installed.

The setup command is a repository tools command that allows you to set up a Jazz Team Server and associated applications without using the setup wizard. The command may be run in interactive mode to help capture the response file needed to drive future automated installations. See Repository tools command to configure the server for the explanation of each parameter that you can use with the command.

Before you begin

Prior to running the setup command, you must have installed the Jazz Team Server and any CLM applications, created your databases, and deployed and started the applications on your application server.

Note: If you are using a Derby database, before running the setup command, ensure that the location of the database and data warehouse in the Jazz_Install_Dir_6.0.1/server/conf/jts/teamserver.propertiesJazz_Install_Dir_6.0.1\server\conf\jts\teamserver.properties file is an absolute path. For example: com.ibm.team.repository.db.jdbc.location=Jazz_Install_Dir_6.0.1/conf/jts/derby/repositoryDB and com.ibm.team.datawarehouse.db.jdbc.location=Jazz_Install_Dir_6.0.1/conf/jts/derby/warehouseDB.

Procedure

  1. Open a command window and enter the following commands:

    cd Jazz_Install_Dir_6.0.1\server
    repotools-jts.bat -setup repositoryURL=https://qulified.hostname.com:9443/jts adminUserID=ADMINWAS_ADMIN_ID adminPassword=ADMINWAS_ADMIN_PASSWORD

    cd Jazz_Install_Dir_6.0.1/server
    ./repotools-jts.sh -setup repositoryURL=https://qulified.hostname.com:9443/jts adminUserID=ADMINWAS_ADMIN_ID adminPassword=ADMINWAS_ADMIN_PASSWORD

  2. Configure a public URI and then hit Enter.
  3. Read the warning and confirm your public URI:

    I understand that once the Public URI is set, it cannot be modified except with additional administrative commands, which can result in broken links from other applications that do not support changing URLs.

    Choose Confirm Public URI:

    [1] I understand
    [2] Cancel and exit setup - default

  4. At the Configure Database step, enter a number to choose a DB connection type:
  5. [1] JDBC - Default
    [2] J2EE

  6. Enter a number to choose a database vendor:
  7. [1] Derby - default
    [2] DB2
    [3] SQL Server
    [4] DB2 for z/OS
    [5] DB2i
    [6] Derby Net
    [7] Oracle

  8. Enter a location for the JDBC database. If the location contains password, use the value {password} instead of the actual password.
  9. For example:

    conf/jts/derby/repositoryDB

    //localhost:50000/JTS:user=db2admin;password={password};

    thin:jtsDBuser/{password}@localhost:1521/CLMDB

    //localhost:1433;databaseName=jts;user=jtsDBuser;password={password};

    //ipAddress:ipPort/location:user=jtsDBuser;password={password};

  10. Enter Y to enable the email notification. Enter N to skip.
  11. At the Configure User Registry step, enter a number corresponding to one of the following entries:
  12. [1] LIBERTY
    [2] Tomcat
    [3] LDAP
    [4] Non-LDAP External Registry

  13. Enter the following information to create an administrative user.
    • User ID
    • Password (The password is not displayed on the screen.)
    • Re-Type Password
    • Your full name
    • Email address

    If you selected LDAP, the logged in user information is imported. If you selected Non-LDAP, the password is not required.

  14. After you created the administrative user, you can disable the default ADMIN user. Choose one these options:
  15. [1] Disable - default
    [2] Do Not Disable

  16. Next, depending on installed applications, you will be asked to register local applications. Enter Y to confirm and enter the instance name (context root) and discovery URL for each application.
  17. Note: A local application is an application that is installed under the same application server as Jazz Team Server and its details can be discovered. A non-local application is either installed in a distributed environment or not installed in the same application server as Jazz Team Server and its details must be provided by the user.

    The following table displays the applications that can be registered with Jazz Team Server with their context root and discovery URL:

    CLM applications with their default context root and discovery URL
    Application Name Context root Discovery URL

    Change and Configuration Management

    Quality Management

    Requirements Management

    Rational Engineering Lifecycle Manager

    Global Configuration Management

    Design Management

    Link Index Provider

    Report Builder

    Data Collection Component

    Lifecycle Query Engine

    /ccm

    /rqm

    /rm

    /relm

    /gc

    /dm

    /ldx

    /rs

    /dcc

    /lqe

    https://server.example.org:9443/ccm/scr

    https://server.example.org:9443/rqm/scr

    https://server.example.org:9443/rm/scr

    https://server.example.org:9443/relm/scr

    https://server.example.org:9443/gc/scr

    https://server.example.org:9443/dm/scr

    https://server.example.org:9443/ldx/scr

    https://server.example.org:9443/rs/scr

    https://server.example.org:9443/dcc/scr

    https://server.example.org:9443/lqe/scr

  18. At the Assign Licenses step, for each installed application select the appropriate Client Access License(s) to be assigned to your user. You can assign additional license keys in the Admin UI as needed.
  19. At the Configure Data Warehouse data base step, choose a DB connection type and database vendor. For the database network server port, assign a unique port number within the hosting server. The default port number is 1527.
  20. The Setup Report Builder step creates known data sources and imports the ready-to-use reports so that Jazz Reporting Service is ready to use.

    If the data warehouse has not been set up or a Derby database is being used then no password is required. Otherwise, enter a password for data warehouse. This step might take a few minutes.

  21. At the end of the setup, you should see message on the screen that the setup completed successfully.

Create index files for the VVCMODEL.VERSION table

The VVCMODEL.VERSION table in the following database is not indexed by the setup procedure. After you run the setup and create your database tables, you must run the following commands to create index files for the VVCMODEL.VERSION table to optimize the database.

  • Requirements Management database
  • Design Management database
  1. Open a sqlcmd command line tool and enter the following commands:

    ALTER TABLE VVCMODEL.VERSION ALTER COLUMN CONCEPT NVARCHAR(450) NOT NULL
    ALTER TABLE VVCMODEL.VERSION ALTER COLUMN STORAGE NVARCHAR(450) NULL

    CREATE  INDEX VERSION_CONCEPT_DX ON VVCMODEL.VERSION (CONCEPT)
    CREATE  INDEX VERSION_STORAGE_DX ON VVCMODEL.VERSION (STORAGE)

Activate and enable configuration management

For detailed instructions about activating configuration management and enabling project areas including a link to obtain an activation key, see Getting started for application administrators.

Related links

This Jazz.net article also provides useful information about configuration management.

Configuring the LQE permission

After running the setup wizard and registering the LQE application, you must log on to the server and assign the required permission.

  1. Log on to the administration page of the LQE application at https://host.example.org:9443/lqe/web/admin/data-sources.
  2. In the sidebar, click Permissions.
  3. Click Add groups.
  4. Select the check box for Everyone group and then click OK.

Collecting data with Data Collection Component

After you install and start the server, you can use Data Collection Component to collect data from the registered applications and load them into the data warehouse. For detailed instructions, see Collecting data with the Data Collection Component.

Install the Rational Team Concert client for Eclipse IDE

After installing and setting up the server, you can install the Rational Team Concert Eclipse client to connect to the server. To install the client for Eclipse IDE by using IBM Installation Manager, see Installing the Rational Team Concert Eclipse client by using Installation Manager.

Install the Rhapsody Design Management components

After installing and setting up the Design Management server, you can install the components such as import engines, client extensions, sample projects and so on. For detail instructions, see Installing Rational Rhapsody components.

Install the Rational Software Architect Design Management components

After installing and setting up the Design Management server, you can install the components such as import engines, client extensions, sample projects and so on. For detail instructions, see Installing Rational Software Architect components.

Configuring Kerberos single-sign-on authentication

To configure Kerberos server and client single-sign-on authentication, see Configuring Kerberos single-sign-on authentication.