Installing IBM® Rational® Project Conductor


This information was built 26 Feb 2010.

The latest installation instructions are also available in the Rational Project Conductor information center.

Contents

Installing IBM Rational Project Conductor
Planning the installation
Installation roadmaps
Installation planning worksheet
Installation requirements
Installing Rational Project Conductor
Installing Rational Project Conductor on a new Jazz Team Server instance
Installing Rational Project Conductor on an existing Jazz Team Server instance
Performing silent installations
Post-installation tasks
Setting up the databases
Setting up and starting the server
Creating users and assigning licenses
Setting up the project management environment
Upgrading to Version 1.0.0.1
Additional installation and upgrade options
Logging in to Rational Project Conductor
Uninstalling Rational Project Conductor
Notices
Copyright license
Trademarks and service marks

Installing IBM Rational Project Conductor

Planning the installation

There are several options and requirements that you must consider when planning your installation. Use the installation roadmap and planning worksheet to help you get started.

Installation roadmaps

The installation roadmap provides a snapshot of the procedures for installing IBM® Rational® Project Conductor. You can install Rational Project Conductor with a new Jazz™ Team Server instance. If you already have the Jazz Team Server installed with another product, you can install Rational Project Conductor into the existing Jazz Team Server instance.

Roadmap for installing Rational Project Conductor and Jazz Team Server

  1. Review the installation planning worksheet
  2. Verify that the hardware and software requirements are met.
  3. Install Rational Project Conductor and the Jazz Team Server.
  4. Perform the post-installation tasks that are relevant to your installation environment:
    1. If you are using a database other than the default Derby database, set up the database to work with the Jazz Team Server
    2. Create database tables
    3. Start the server
    4. If you want to use the Websphere Application Server, set up and start the WebSphere Application Server
    5. Run the setup wizard to test the database connection, and to configure additional server options
    6. If you are using LDAP as the user registry, configure the LDAP connection parameters
    7. Create users and assign licenses
    8. Set up the project management environment

Roadmap for installing Rational Project Conductor in an existing Jazz Team Server instance

  1. Review the installation planning worksheet
  2. Verify that the hardware and software requirements are met.
  3. Install Rational Project Conductor in an existing Jazz Team Server instance.
  4. Perform the post-installation tasks:
    1. Add database tables to the existing repository
    2. Start the server
    3. Create users and assign licenses
    4. Set up the project management environment

Installation planning worksheet

Use this worksheet to help you plan your installation.

Note:
IBM Rational Project Conductor is based on the Jazz Team Server. When you install Rational Project Conductor, the Jazz Team Server is installed by default.

The following table lists the installation options, and the considerations for each option.

Table 1. Installation options
Installation options Considerations
Review and choose an application server

The Jazz Team Server includes Apache Tomcat as the default application server. The Jazz Team Server can also be configured to run with a WebSphere® Application Server.

a. Apache Tomcat
  • Bundled with the Jazz Team Server.
  • Simple installation and no setup required.
b. WebSphere Application Server
  • Requires configuration for hosting the Jazz Team Server. For more information, see Setting up and starting a WebSphere Application Server.
  • Supports a more powerful user registry setup. You can configure WAS to allow users to log in from either a local user registry and a LDAP registry at the same time.
Review and choose a database

The Jazz Team Server includes Derby as the default database. If you are already using other databases such as DB2®, or Oracle, in your environment, the Jazz Team Server can be configured to run with your existing database software.

a. Derby
  • Bundled with Jazz Team Server.
  • No installation or configuration required.
    Note:
    A Derby database cannot support more than 10 users. If you want to support more than 10 users, you need to use a different database.
b. DB2
c. SQL Server
d. Oracle
Review and choose a user management method

Apache Tomcat user database: The default user management enables you to manage users without any external user management system.

LDAP user registry: You must configure your Apache Tomcat or IBM WebSphere Application Server to use an LDAP registry to authenticate users.

a. Apache Tomcat user database

Managing users with the Apache Tomcat user database is for Apache Tomcat installations only. The user names and encrypted passwords are stored in the tomcat-users.xml file. Updates, such as, creating a new user and changing user passwords or repository permission roles are automatically written to the xml file. You do not need to edit the file.

b. LDAP user registry

For more information, see Managing users with Lightweight Directory Access Protocol (LDAP)

Installation requirements

Verify that your environment meets or exceeds the minimum hardware and software requirements, and that your user ID has the required permissions before you can install the product.

For an up-to-date list of minimum hardware and software requirements, go to http://www.ibm.com/support/docview.wss?uid=swg27017169.

Verify that your user ID meets the following criteria before you install the product:

Installing Rational Project Conductor

Install IBM Rational Project Conductor, and IBM Installation Manager if required, and verify the installation. Rational Project Conductor is based on the Jazz Team Server. By default, when you install Rational Project Conductor, the Jazz Team Server is also installed. However, if you use other Rational products that are based on the Jazz Team Server, you can install Rational Project Conductor on an existing Jazz Team Server installation.

Installing Rational Project Conductor on a new Jazz Team Server instance

Install IBM Rational Project Conductor on a new Jazz Team Server instance. Follow this installation scenario if you are not using any other products that are based on the Jazz Team Server, or if you do not want to create a common repository for the Jazz Team Server products.

Before you begin

You can install Rational Project Conductor from the installation media, or from a download package on https://jazz.net. Before you start the installation, either obtain the installation media or download the installation package. To complete the download, you must register and obtain a user name and password from https://jazz.net.

About this task

To install Rational Project Conductor on a Windows or Linux operating system:

  1. If you are using the installation media, insert the media into the disk drive. If you are using the download package, extract the files from the downloaded .zip package to a temporary directory.
  2. Click the launchpad program to start the installation:
  3. Click Install Rational Project Conductor. This opens the Install Packages page. If you are installing the product for the first time and IBM Installation Manager is not detected on your system or an incompatible version is installed, then you must install the latest release of Installation Manager.
  4. When you are ready to begin installing Rational Project Conductor, ensure that the product name and version check boxes are selected. Click Next.
  5. Read the license agreement. If you agree with its terms, accept the license agreement, and click Next.
  6. Accept the default installation location for Installation Manager, and click Next.
  7. On the Install Packages page, select Create a new package group. Modify the default Installation Directory, if required.
  8. Click Next.
  9. The default application server is Apache Tomcat. The IBM Rational Project Conductor Server Activation Keys check box is selected by default.
  10. Click Next.
  11. Click Install.
  12. A message confirms the completion of the process.

What to do next

Complete the next steps in the installation:

Alternatively, return to the Installation roadmaps to review the next steps in the installation.

Installing Rational Project Conductor on an existing Jazz Team Server instance

If you are using other products that are based on the Jazz Team Server, such as IBM Rational Team Concert™, you can install IBM Rational Project Conductor on the existing Jazz Team Server instance. In this installation scenario, Rational Project Conductor and the existing Jazz-based product share a common data repository.

Before you begin

  1. Obtain the installation media or download the installation package from https://jazz.net. To complete the download, you must register and obtain a user name and password from https://jazz.net
  2. Stop the Jazz Team Server and back up the existing database to protect your environment against data loss during the installation. If the installation is unsuccessful, you can restore this database backup.

About this task

Complete the installation by using IBM Installation Manager, and then verify the installation.

To install Rational Project Conductor on a Windows or Linux operating system by using the launchpad:

  1. Ensure that the Jazz Team Server is stopped.
  2. If you are using the installation media, insert the media into the disk drive. If you are using the download package, extract the files from the downloaded .zip package to a temporary directory.
  3. Click the launchpad program to start the package installation:
  4. Click Install IBM Rational Project Conductor. This opens the Install Packages page. If the Installation Manager version is outdated, then you must install the latest version of Installation Manager.
  5. When you are ready to begin the installation of Rational Project Conductor, ensure that the product name and version check boxes are selected. Click Next.
  6. Read the license agreement. If you agree with its terms, accept the license agreement, and click Next.
  7. On the Install Packages page, ensure that the Use the existing package group radio button is selected. Select the existing Jazz Team Server package group name. Click Next and continue through the rest of the installation process without making changes.
  8. To begin the installation, click Install.
  9. A message confirms the completion of the process.

What to do next

Add the Rational Project Conductor database tables to the existing Jazz Team Server repository. For more information, see Adding database tables to an existing repository.

Alternatively, return to the Installation roadmaps to review the next steps in the installation.

Performing silent installations

For information about installing the product silently on one or more machines, read the silent installation documentation in the IBM Installation Manager Information Center.

Visit the Installation Manager information center at http://publib.boulder.ibm.com/infocenter/install/v1r2/index.jsp and search for performing silent installations.

To perform silent installation, you must configure a response file that contains the data required to perform the silent installation. The IBM Rational Project Conductor installation media contains a sample response file rpc.responsefile.xml that is available at disk1/sample_response_files. You can configure this response file by specifying your preferences.

Note:
To perform silent uninstallation, or to update or modify your installation, use the sample response file rpc.responsefile.xml in the installation directory at JazzInstallDir/sample_response_files.

Post-installation tasks

After you install IBM Rational Project Conductor, you must complete tasks such as setting up databases, starting the server, creating users, and assigning permissions.

Setting up the databases

After your database is installed, you must configure the database to work with the Jazz Team Server, and then create the database tables. If you are using the Derby database that was included with the product installation, then the database is configured by default.

If you installed IBM Rational Project Conductor into an existing package group, you must upgrade the existing repository to include the Rational Project Conductor database schema.

Setting up a DB2 database

To use the IBM DB2 database, you must configure it to work with the Jazz Team Server.

Before you begin

You must complete the following prerequisite tasks before you can configure DB2.

About this task

To set up a DB2 database:

  1. Create the database in the DB2 Command Window. The example commands create a database called JAZZ. These commands run in the DB2 Command Window. The Command Window can be opened from the Start menu under the DB2 Command Line Tools menu.
    Note:

    To ensure proper handling of Unicode content, the database character set must be UTF-8 encoding. Because the AUDITABLE_LINKS table does not fit in the default page size of 4 K on Windows, set the page size to at least 8 K.

    If the database is not running, use the command db2start to start DB2.

  2. Locate the file teamserver.properties in the directory JazzInstallDir/server/conf/jazz and rename it to teamserver.derby.properties.
  3. Locate the file teamserver.db2.properties in the directory JazzInstallDir/server/conf/jazz and rename it to teamserver.properties.
  4. Specify the database and connection details in the file teamserver.properties.

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

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

What to do next

You have finished setting up your database and can continue with Creating database tables.

Alternatively, return to the Installation roadmaps to review the next steps in the installation.

Setting up an Oracle database

To use an Oracle database, configure it to work with the Jazz Team Server.

Before you begin

Ensure that the following prerequisites are met. Consult your Oracle documentation or an Oracle database administrator (DBA) for help.

When running Jazz Team Server on Oracle, create an Oracle tablespace to improve performance. You must create a user linked to that tablespace.

Remember:
Neither of these steps are performed by the database builder with the repository tools.

About this task

To set up an Oracle database:

  1. Create a tablespace. The tablespace location must be appropriate to the machine and disk drive.
    Note:
    The tablespace can have any of these properties:
    • A name other than oracle_tbs
    • A location in another directory
    • A size larger than 1GB. For large installations, you need to allocate more space.
    The example below shows a create statement executed on a Windows machine:
    CREATE BIGFILE TABLESPACE oracle_tbs DATAFILE 'D:\oracle_tbs\oracle_tbs.dbf' SIZE 1G AUTOEXTEND ON EXTENT MANAGEMENT LOCAL AUTOALLOCATE;
    Important:
    The directory path (in this example D:\oracle_tbs) must exist. It is not necessary to create a separate special tablespace. You can use the Oracle default USERS tablespace, but Oracle performs better with a pre-allocated space on the disk that it manages.
  2. Create an Oracle user.

    After the tablespace is created, a special Oracle user must be created for Jazz to use the Oracle database.

    In this example, the user has the name jazzDBuser and password (IDENTIFIED BY in Oracle terms) jazzDBpswd and exists in the tablespace created in 1.
    CREATE USER jazzDBuser IDENTIFIED BY jazzDBpswd DEFAULT TABLESPACE oracle_tbs;
    After the user is created, the user should be given the necessary permissions needed to initialize the Jazz database. The following SQL commands can be used to grant the appropriate permissions:
    GRANT CREATE SESSION TO jazzDBuser;
    GRANT CREATE TABLE, ALTER ANY TABLE, DROP ANY TABLE, CREATE ANY INDEX, ALTER ANY INDEX, DROP ANY INDEX TO jazzDBuser;
    GRANT INSERT ANY TABLE, UPDATE ANY TABLE, DELETE ANY TABLE TO jazzDBuser;
    GRANT CREATE PROCEDURE TO jazzDBuser;
    GRANT CREATE VIEW TO jazzDBuser;
  3. Locate the file teamserver.properties in the directory JazzInstallDir/server/conf/jazz and rename it to teamserver.OtherDBProvider.properties.
  4. Locate the file teamserver.oracle.properties in the directory JazzInstallDir/server/conf/jazz and rename it to teamserver.properties.
    Tip:
    Renaming the original teamserver.properties file enables you to restore the file to the previous working version. By default, the DB Provider is derby.
  5. Configure the server
    1. Edit the server configuration file if you used a different user name, password, or db name, installed Oracle server on a different machine than Jazz Team Server, or are using a port other than the default. Open the file teamserver.properties in JazzInstallDir/server/conf/jazz directory, and change the information listed below to match your setup.

      com.ibm.team.repository.db.vendor = ORACLE

      com.ibm.team.repository.db.jdbc.location=thin:jazzDBuser/{password}@localhost:1521/ORCL

      Change jazzDBuser with the user created for Jazz to use the Oracle database. If you are using localhost, uncomment this line by removing # from the beginning of the line and comment the next location line. Localhost connection strings should not include the preceding //. Change 1521 with your Oracle server machine TCIP port. Change ORCL with your Oracle database name.

      com.ibm.team.repository.db.jdbc.location=thin:jazzDBuser/{password}@//oracleserver.example.com:1521/ORCL

      Remember:
      Oracle location URLs can take several forms. The examples here work under most circumstances. Consult the Oracle JDBC documentation for more details.

      If you are using a non-localhost connection, uncomment this line by removing the # from the beginning of the line and comment the previous location line. Non-localhost connection strings must include the preceding //.

      com.ibm.team.repository.db.jdbc.password=jazzDBpswd

      Change jazzDBpswd with the password of the user created for Jazz to use the Oracle database.

      Important:
      Do not change the {password} text in the property com.ibm.team.repository.db.jdbc.location. The user password must be specified in the property com.ibm.team.repository.db.jdbc.password.

      If you are using Oracle Express, use 1521 for TCIP port and XE for Oracle database name:

      com.ibm.team.repository.db.vendor = ORACLE
      com.ibm.team.repository.db.jdbc.location=thin:jazzDBuser/{password}@localhost:1521/XE
      com.ibm.team.repository.db.jdbc.password=jazzDBpswd
    2. In the same directory as the server scripts (JazzInstallDir/server), create a directory named oracle.
    3. Locate the Oracle JDBC driver JAR file, named ojdbc14.jar. The location can vary depending on the Oracle product and operating system. Copy this file to the directory named oracle.
      Note:
      If you are using WebSphere Application Server, configure a property named "ORACLE_JDBC"; then set it to the absolute file path (not URL) to the Oracle JDBC drivers. This task is described in the WebSphere Application Server setup instructions. Make a note of the file path for later use in these instructions.
  6. Open a SQL plus window and type the following command:
    GRANT DBA TO jazzDBuser;

What to do next

You have finished setting up your database and can continue with Creating database tables.

Alternatively, return to the Installation roadmaps to review the next steps in the installation.

Setting up a SQL Server database

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

This procedure assumes that the following prerequisites have been met:

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

Setting up a database

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

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

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

Configuring the server

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

To configure the server:

  1. Rename the following files:
    Tip:
    Renaming the original teamserver.properties file enables you to restore the file to the previous working version. By default, the DB Provider is derby.
  2. Edit the server configuration file if you used a different user name, password, or db name, installed SQL server on a different machine than Jazz Team Server, or are using a port other than the default. Open the file teamserver.properties in JazzInstallDir/server/conf/jazz directory, and change the information listed below to match your setup.
    com.ibm.team.repository.db.vendor = SQLSERVER
    com.ibm.team.repository.db.jdbc.location=//SQL SERVER MACHINE IP:SQL SERVER TCIP PORT;databaseName=JAZZ DATABASE NAME;user=JAZZ USERNAME;password={password}
    com.ibm.team.repository.db.jdbc.password=JAZZ LOGIN PASSWORD
    Important:
    Do not change the password={password} text in the property com.ibm.team.repository.db.jdbc.location. The user password must be specified in the property com.ibm.team.repository.db.jdbc.password.

To specify the jar file location for JDBC:

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

What to do next

You have completed setting up your database. Now, create the database tables. For more information, see Creating database tables.

Alternatively, return to the Installation roadmaps to review the next steps in the installation.

Troubleshooting

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

Also, verify the following:

Creating database tables

If you installed IBM Rational Project Conductor in a new Jazz Team Server instance, and want to use IBM DB2, Oracle, or Microsoft SQL server as the database, use the repository tools to create the database tables.

Before you begin

Before you can run this command, stop the database server.

About this task

Important:
If you installed Rational Project Conductor in an existing Jazz Team Server instance, for example, a Rational Team Concert package group, you must upgrade the existing repository to include the additional database tables. For more information about upgrading an existing repository, see Adding database tables to an existing repository.

The repotools file is located in JazzInstallDir/server.

The command uses the configuration properties in teamserver.properties for the connection and size settings. By default, the command looks in the current directory. The parameters in the teamserver.properties can be modified to reference the appropriate database.

To create the database tables:

  1. Run the command repotools -createTables to create the database tables for a Rational Project Conductor repository.
  2. After the database tables are created, stop and restart the database.

What to do next

Alternatively, return to the Installation roadmaps to review the next steps in the installation.

Adding database tables to an existing repository

If you installed IBM Rational Project Conductor into an existing Jazz Team Server instance, for example, an IBM Rational Team Concert package group, you must upgrade the existing repository to include the Rational Project Conductor database schema. You must perform this step for all database servers, including the default Derby database.

Before you begin

Before you can run this command, stop the database server.

About this task

Important:
If you installed Rational Project Conductor in a new package group, and you are not using the default Derby database, you must create the database tables, using the repository tools createTables command. For more information about creating the database tables, see Creating database tables.

The repotools file is located in JazzInstallDir/server.

The command uses the configuration properties in teamserver.properties for the connection and size settings. By default, the command looks in the current directory. The parameters in the teamserver.properties can be modified to reference the appropriate database.

To add the database tables to an existing repository:

  1. Run the command repotools -addTables to add the database tables for Rational Project Conductor to the existing repository:
    Note:
    There may be exceptions displayed when this command is run. You can ignore these exceptions since the database is created successfully.
  2. After the database tables are added, stop and restart the database.

What to do next

You can now proceed to start the server.

Alternatively, return to the Installation roadmaps to review the next steps in the installation.

Setting up and starting the server

If you are using IBM WebSphere Application Server, you must set up the server environment, and then start the server. There are different options for running the server startup scripts on either Apache Tomcat application server or WebSphere Application Server.

About this task

If you plan to use the included Apache Tomcat application server, you are ready to start the Jazz Team Server. If you plan to use the WebSphere Application Server, set up your server environment as described in Setting up and starting a WebSphere Application Server.

Starting the Apache Tomcat server

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

Before you begin

Before you start the server, review the following requirements:

Starting the server on Windows

Run the startup file to start the Apache Tomcat server on Windows.

About this task

To start the server:

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

What to do next

These tasks run the start and stop scripts directly from the directory JazzInstallDir/server. Also, you can run the commands from the Jazz Team Server Windows start menu.

After the server is started, proceed to Testing and configuring the server.

Starting the server on Linux

Run the startup file to start server on Linux.

About this task

To start the server:

  1. From the JazzInstallDir/server directory: A separate Apache Tomcat console window is not visible. You can check the server startup progress by viewing the log file at JazzInstallDir/server/tomcat/logs/catalina.out.
  2. To stop the server, from the JazzInstallDir/server directory:

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

What to do next

After the server is started, proceed to Testing and configuring the server.

Alternatively, return to the Installation roadmaps to review the next steps in the installation.

Setting up and starting a WebSphere Application Server

You can set up IBM Rational Project Conductor to work with IBM Websphere Application Server. This setup assumes that you are installing Rational Project Conductor on the same machine as the Websphere Application Server.

Before you begin

Ensure that the following criteria are met:

About this task

You can configure WebSphere Application Server as your application server even if you have installed Rational Project Conductor with the default Tomcat application server option. In this scenario, the steps for setting up WebSphere Application Server are the same, except that when the jazz.war file is deployed, you must navigate to the jazz.war file that is located within the Tomcat installation directory.

To set up a WebSphere Application Server:

  1. Verify or update the WebSphere Application Server level.

    Rational Project Conductor requires WebSphere Application Server Version 6.1 with the IBM Java™ SDK 1.5 SR5 or later fix pack applied. Use the IBM Java SDK 1.5 SR6 SDK update that is available from http://www-01.ibm.com/support/docview.wss?rs=180&uid=swg27009393 and select fix pack V6.1.0.25 or later. With WebSphere 6.1 and the GA IBM Java SDK, Rational Project Conductor starts to report "proxy errors" after some number of operations.

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

  2. Update the JVM arguments which can be set to control some aspects of the server behavior. The following list contains the specifics of setting these JVM properties in the administrative console, substitute JazzInstallDir with your Rational Project Conductor installation directory:
    1. Click Servers -> Application Servers.
    2. Click server1.
    3. Click Java and Process Management -> Process Definition.
    4. Click Java Virtual Machine.
    5. Add the value 100 to the Initial Heap.
    6. Add the value 1500 to the Maximum Heap Size.
    7. Click Apply.
    8. Click Custom Properties.
    9. Add the following properties: Click New, enter the Name and Value, and then click OK.

      Name: java.awt.headless. Value: true

      Name: org.eclipse.emf.ecore.plugin.EcorePlugin.doNotLoadResourcesPlugin. Value: true

      Name: JAZZ_HOME Value: file:///JazzInstallDir/server/conf

    10. Click Save directly to the master configuration.
  3. Set up the required global WebSphere Application Server instance properties, and activate the proper security settings.
    1. In the WebSphere Application Server Admin Console, in the left menu, expand the Security group, and click Secure administration, applications, and infrastructure Servers.
    2. Ensure that the following security settings are configured as shown below:
      • Enable administrative security is "on"
      • Enable application security is "on"
      • Java 2 security is "off" for all three options
    3. Save the master configuration.
  4. Set up LDAP as the user authentication method. Rational Project Conductor requires that LDAP authentication is configured to perform authorization and personalize the application.
  5. Restart WebSphere Application Server.

    On Windows, the default value for WebSphere installation directory is:

    C:\Program Files\IBM\WebSphere\AppServer

    You can restart the server with the following commands on Windows:

    cd WASInstallDir\bin 
    stopServer.bat server1 [for a secure server, include: -username {LDAP_User} -password {LDAP_Password}] 
    startServer.bat server1

    On Linux, the default value for WebSphere installation directory is:

    /opt/IBM/WebSphere/AppServer

    You can restart the server with the following commands on Linux:

    cd WASInstallDir/bin 
    ./stopServer.sh server1 [for a secure server, include: -username {LDAP_User} -password {LDAP_Password}] 
    ./startServer.sh server1
  6. Now, install the Rational Project Conductor application.
    1. Open the Admin console for your WebSphere Application Server.
    2. Click Applications -> Install New Application.
    3. Under Path to new Application, click Local file system.
    4. Under Full path, browse to the location of the jazz.war in your file system. For example, JazzInstallDir/server/jazz.war. If Tomcat is already set up as the Rational Project Conductor application server, then browse to the jazz.war file at JazzInstallDir/server/tomcat/webapps/jazz.war
    5. Set Context Root as /jazz.
    6. Select the option Show me all installation options and parameters.
    7. Click Next and continue until Step 6: Map virtual hosts for Web modules.
    8. In step 6: Map Virtual Hosts, select the Mapping to the default host check box. Click Next, and continue until Step 8: Map Security roles to users or groups.
    9. In Step 8: Map Security roles to users or groups, map the Jazz roles to the WebSphere user groups.
      • Select the check box for the Jazz group you want to map.
      • Click Look up groups. If the WebSphere users are not mapped to groups, then click Look up users, and map the roles to users.
      • Search for the available groups or users. To search for groups, you can use wildcard characters to search for Jazz*
      • Click the >> button to select the corresponding group, and click OK.
      • Perform these mapping steps for all the Jazz roles.
    10. Click Next and then click Finish.
    11. Click Save directly to the master configuration.
  7. Deploy the help.war file for the Rational Project Conductor online help to be available. The steps are a subset of the procedure to deploy the jazz.war detailed in step 6 :
    1. In the Admin console, click Applications -> Install New Application
    2. Under Path to new Application, click Local file system.
    3. Under Full path, browse to the location of the help.war in your file system. For example, JazzInstallDir/server/help.war.
    4. Set Context Root as /help.
    5. Click Next and continue through the remaining Install New Application steps.
    6. Click Finish.
    7. Click Next and then click Finish.
    8. Click Save directly to the master configuration..
  8. Start the applications you installed.
    1. Click Applications -> Enterprise Applications.
    2. Select the check boxes for jazz_war and help_war, and click Start.

      A green arrow should appear indicating the application started successfully.

What to do next

After the server is started, proceed to Testing and configuring the server.

Alternatively, return to the Installation roadmaps to review the next steps in the installation.

Testing and configuring the server

Run the setup wizard to verify that the server is operating properly and to configure additional server options such as e-mail notifications.

Before you begin

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

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

The server setup wizard is available at https://localhost:9443/jazz/setup. If the server setup wizard does not load, check the following items:

About this task

To configure and test the server:

  1. Open the setup wizard by typing the URL https://localhost:9443/jazz/setup.

    The default user name and password are case sensitive:

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

  2. Choose a setup path. The setup wizard has the following two main paths
  3. By default the Disable default ADMIN access check box is selected. After you create a new user with JazzAdmin rights, the default ADMIN user is disabled. This is a security feature. Disable this check box if you want to retain the default ADMIN user.
    Note:
    If you retain the default ADMIN user, you must assign a IBM Rational Project Conductor Client Access License to the user. If no license is assigned, the default ADMIN user cannot perform any project management tasks. For information about assigning licenses, see Creating users and assigning licenses.
  4. When the initial setup is complete, additional options can be configured from the Jazz Team Server Admin Web user interface by using the URL https://localhost:9443/jazz/admin.

Setting up the LDAP connection parameters

If you are using LDAP as the user registry method, specify the LDAP connection parameters.

About this task

Use the setup wizard to perform this task. For more information about the setup wizard, including troubleshooting options if the setup wizard does not load, see Testing and configuring the server.

  1. Start the setup wizard to perform this task. Use the URL https://localhost:9443/jazz/setup.

    You can log in with the default user name and password:

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

  2. Click Fast Path Setup.
  3. In the Setup User Registry page, select LDAP as the user registry type. Enter the LDAP configuration parameters. For more information, see Managing users with Lightweight Access Directory Protocol (LDAP) in the Rational Team Concert Information Center.
    Important:
    By default, the "Disable default ADMIN access" check box is selected. After you create a new user with JazzAdmin rights, the default ADMIN user is disabled. This action is a security feature. Disable this check box if you want to retain the default ADMIN user.

Creating users and assigning licenses

You must create users and assign licenses to them so that they can start using the application. To complete the installation, you must assign a Project Manager license to atleast one user, so that the user can log in and complete the project management environment setup.

Before you begin

You must be logged in to the Admin Web UI and be a member of the JazzAdmins group.

About this task

When creating a user, you assign a name, user ID, e-mail address, repository groups, and client access licenses to the user. Optionally, you can add a photo of the user. Regardless of where you create the user, the user resides in the repository and is available to be added to any project area or team area in the repository.

To create a user:

  1. In the Admin Web UI, click the User Management tab.
  2. Select the Active Users page; then click Create User.
  3. Complete the following fields:
  4. In the Repository Permissions section, select the appropriate user permissions: You can assign one or more following repository groups to the user:
  5. In the Client Access Licenses section, select the appropriate license type. You can assign the following licenses:
    Remember:
    You must assign the Project Manager license to atleast one user, for that user to log in and complete the project management environment setup. For more information about setting up the project management environment, see Setting up the project management environment.
  6. You can also create users first, and assign licenses later. To assign licenses to existing users (including the default ADMIN user), in the User Management page, click Client Access License Management.
    1. To assign the Project Team license, click the IBM Rational Project Conductor- Project Team tab, click Assign Project Team License. Select the user, and click Add.
    2. To assign the Project Manager license, click the IBM Rational Project Conductor- Project Manager tab, click Assign Project Manager Licenses, select the user, and click Add.
  7. Click Save.

Setting up the project management environment

To set up the project management environment on the Jazz Team Server, you must deploy the project management process templates, and create the project management administration area. Perform this step after completing the server setup.

Before you begin

  1. You must complete the server setup.
  2. You must be a member of the JazzAdmins group.
  3. You must have a IBM Rational Project Conductor - Project Manager license assigned.

  1. Log in to https://localhost:9443/jazz/epmWeb with the admin user credentials. If you are logging in as the default admin user, use the following credentials:
  2. The Set up project management environment page opens. Click Configure environment. The process takes a few minutes to complete. This deploys the project management process templates, and creates the Project Management Administration area where you can configure project management options such as calendars, rates, skills, and competencies.
    Note:
    You perform this step only once in an installation instance. After you complete this step, the same URL takes you to the Rational Project Conductor login page.
  3. Log out from the server.

What to do next

To configure users, roles, and permissions, and to set up project management data, log in to the Jazz Team Server Admin interface. Use the URL https://localhost:9443/jazz/rpc/admin. To get started with creating programs and projects, log in to Rational Project Conductor. Use the URL https://localhost:9443/jazz/epmWeb.

Upgrading to Version 1.0.0.1

To upgrade an existing installation, use the IBM Installation Manager updater or the download package, and migrate your repository data.

Before you begin

If you want to upgrade your installation by using the installation package, download the package from https://jazz.net. To perform the download, you must register and obtain a username and password from https://jazz.net.

  1. Stop the Jazz Team Server.
  2. Export the database by using repotools.bat. In the command prompt window, change the directory to JazzInstallDir/server. Type the following command:
    repotools.bat -export toFile=./file_name.tar
  3. Update the installation by using either of the following options:
    1. To update the installation by using the Installation Manager update option:
      1. Start Installation Manager. Click Update.
      2. Select the Jazz Team Server instance on which Rational Project Conductor is installed. Click Next. Installation Manager searches for and displays the available updates.
      3. Click Update. A message confirms the completion of the process.
    2. To update the installation by using the download package:
      1. Extract the contents of the upgrade package to a folder in your computer, or at a shared location.
      2. Start Installation Manager. Click File -> Preferences.
      3. In the left menu bar, ensure that Repositories is selected. Click Add Repository, and specify the repository location as Upgrade folder location/disk1/diskTag.inf. For example, C:/Documents and Settings/User name/My Documents/ProductRelease_nn/disk1/diskTag.inf. Click OK. Close the Preferences window.
      4. In Installation Manager, click Update .
      5. On the Update Package page, select the existing package group name, and click Next, and then click Update. A message confirms the completion of the process
  4. From the JazzInstallDir/repotools/eclipse/configuration directory, remove the folders org.*. There will be multiple folders for deletion.
  5. Import the repository data from the exported file using repotools. In the command prompt window, change the directory to JazzInstallDir/server. Type the following command:
    repotools -import fromFile=./file_name.tar
    At the prompt for whether you want to drop the existing database and overwrite it, click Yes. A message confirms the successful completion of the process.
  6. Clear the server cache.
  7. Start the Jazz Team Server.

Additional installation and upgrade options

You can install and upgrade your installation of IBM Rational Project Conductor by using offline and online installation options, or a combination of both. You can also install Rational Project Conductor into an existing IBM Rational Team Concert instance. You can perform offline installation by using a download package or media (DVD), and you can perform online installation by referring to the IBM Update site via IBM Installation Manager.

Installation resources

To perform the installation, you need access to the download packages, and an installed IBM Installation Manager. Installation Manager is installed when you install Rational Project Conductor 1.0.

The download packages are available as .zip archives at https://jazz.net/downloads/rational-project-conductor/.

Directly installing Version 1.0.0.1

If you are installing Rational Project Conductor for the first time, you can directly install Version 1.0.0.1 by using any of the following installation options:

During the installation, you can also select the option to install Rational Project Conductor, Version 1.0.0.1 in an existing Rational Team Concert, Version 2.0.0.2 instance.

Installing Version 1.0 and Version 1.0.0.1 from locally available download packages

  1. Download the Rational Project Conductor 1.0 and 1.0.0.1 installation packages, and extract the files to separate directories.
  2. Start IBM Installation Manager. Click File -> Preferences.
  3. In the left menu bar, ensure that Repositories is selected. Click Add Repository, and specify the repository location as 1.0 folder location/disk1/diskTag.inf. Repeat to add a repository location for the 1.0.0.1 folder. Click OK.
  4. Install Version 1.0 and Version 1.0.0.1.
    Note:
    To install Rational Project Conductor into an existing Rational Team Concert, Version 2.0.0.2 instance, on the Install Packages page, select the option to install in an existing package group, and select the Jazz Team Server instance for Rational Team Concert.

Installing Version 1.0 from a locally available download package or media, and installing Version 1.0.0.1 by using the IBM Update site

  1. Download the Rational Project Conductor 1.0 installation packages, and extract it to a local directory. If you are using the 1.0 media, ensure the media contents are available on your computer.
  2. From the 1.0 package directory or media, start the installation by clicking the launchpad file to start the installation. Installation Manager is installed if not already installed on your computer.
  3. On the Install Packages page, click Check for Other Versions and Extensions. Version 1.0.0.1 is shown as available for installation from the IBM Update site.
  4. Select and complete the installation of Version 1.0.0.1.
    Note:
    To install Rational Project Conductor into an existing Rational Team Concert, Version 2.0.0.2 instance, on the Install Packages page, select the option to install in an existing package group, and select the Jazz Team Server instance for Rational Team Concert.

Upgrading to Version 1.0.0.1

If you have an installed Rational Project Conductor, Version 1.0, you can upgrade your installation to Version 1.0.0.1. For information on upgrading to Version 1.0.0.1, see Upgrading to Version 1.0.0.1.

Upgrading to Rational Project Conductor, Version 1.0.0.1, and Rational Team Concert, Version 2.0.0.2

If you installed Rational Project Conductor, Version 1.0 in an Rational Team Concert, Version 2.0 instance, you can upgrade both installations. Use any of the following installation options:

Upgrading by using locally available download packages:

  1. Download the Rational Project Conductor, Version 1.0.0.1 and Rational Team Concert, Version 2.0.0.2 installation packages, and extract the files to separate directories.
  2. Start IBM Installation Manager. Click File -> Preferences.
  3. In the left menu bar, ensure that Repositories is selected. Click Add Repository, and add repository locations for the Rational Project Conductor and Rational Team Concert upgrade package folders. Click OK.
  4. Click Update, and select Rational Team Concert for update. If the Rational Project Conductor update is selected, clear the selection.
    Note:
    You must update the Rational Team Concert installation first because the Rational Project Conductor update process checks for a compatible Rational Team Concert version.
  5. After the Rational Team Concert update is complete, select the Rational Project Conductor update, and complete the update.

Upgrading by using the IBM Update site

  1. Start Installation Manager. Click Update.
  2. Select Rational Team Concert for update. If the Rational Project Conductor update is selected, clear the selection.
  3. After the Rational Team Concert update is complete, select the Rational Project Conductor update, and complete the update.

Logging in to Rational Project Conductor

You are now ready to log in to IBM Rational Project Conductor. Based on your assigned roles and permissions, you can work with programs and projects.

About this task

To log in to Rational Project Conductor:

  1. In your Web browser, type https://localhost:9443/jazz/epmWeb.
  2. Enter your user name and password. Click OK.
  3. You can now work with programs and projects. For assistance, click the Help icon and click Help Contents.

What to do next

To manage your work items or access the change management area:

  1. In your Web browser, type https://localhost:9443/jazz/web
  2. Enter your user name and password. Click OK.
  3. Select your project area. You can now query and retrieve your work items and create new work items.

Uninstalling Rational Project Conductor

To uninstall IBM Rational Project Conductor, use IBM Installation Manager or the uninstall.bat file.

Before you begin

Stop the server before you start the uninstallation.

About this task

With the Uninstall Packages option in IBM Installation Manager, you can uninstall the packages from a single installation location.

To uninstall Rational Project Conductor

  1. Log in to the computer using the same user account that you used to install the product packages. To start the uninstallation, use any of the following options:
  2. Select the packages that you want to remove.
  3. Click Next and then click Uninstall.
  4. After the successful uninstallation page is displayed, to view the log file, click View Log file.

What to do next

The installer does not remove the user-created data. You must delete this data manually. Do not delete the data if you want to point to the same data during reinstallation of the product.

You can uninstall Installation Manager if you do not have any other product packages installed.

Notices

© Copyright IBM Corporation 2009, 2010. All Rights Reserved.

U.S. Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

This information was developed for products and services offered in the U.S.A.

IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to:

IBM Director of Licensing
IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to:

Intellectual Property Licensing
Legal and Intellectual Property Law
IBM Japan, Ltd.
1623-14, Shimotsuruma, Yamato-shi
Kanagawa 242-8502 Japan

The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice.

Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact:

Intellectual Property Dept. for Rational Software
IBM Corporation
20 Maguire Road
Lexington, Massachusetts 02421-3112
U.S.A.

Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee.

The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us.

Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products.

All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only.

This information is for planning purposes only. The information herein is subject to change before the products described become available.

This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental.

Copyright license

This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. The sample programs are provided "AS IS", without warranty of any kind. IBM shall not be liable for any damages arising out of your use of the sample programs.

Each copy or any portion of these sample programs or any derivative work, must include a copyright notice as follows:

© (your company name) (year). Portions of this code are derived from IBM Corp. Sample Programs. © Copyright IBM Corp. 2009, 2010.

If you are viewing this information softcopy, the photographs and color illustrations may not appear.

Trademarks and service marks

IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at www.ibm.com/legal/copytrade.shtml.