Configuring the Jazz Team Server and the first application after the upgrade

After you perform the upgrade and start the Jazz™ Team Server (and any distributed CLM Application servers), you need to configure the Jazz Team Server and the CLM Application.

Before you begin

Before you configure the server, open your web browser and clear the browser cache.

You must know the public URI for the Jazz Team Server and any applications that you are registering. The public URI any previous version of the Jazz Team Server or any application cannot change. For more information on planning your URIs, see Planning your URIs.

About this task

Procedure

Note: If you are running the wizard to setup distributed applications, carry out the following steps in order:
  1. Install the Jazz Team Server application and trial licenses on the first server. Start the first server but do not run the setup wizard on the server.
  2. Install the Change and Configuration Management, Quality Management, or Requirements Management applications on the second server (or on a server for every application, as in the Enterprise topology examples). Start the servers, but do not run the setup wizard.
  3. Run the setup wizard on the first server (with the Jazz Team Server application), starting from step 2 below. When you get to the Register Applications page of the setup wizard (see step 8, below), provide the discovery URL of the applications installed on the other servers.
  4. If you want the distributed applications to use LDAP, after you setup the user registry in step 9 below, copy the LDAP files from the server with the Jazz Team Server to the servers with the other applications and then restart all servers.

  1. Ensure that you have started the server by following the instructions in Deploying and starting the server.
  2. Point your Web browser to the following address: https://[fully qualified hostname]:9443/jts/setup
  3. The Jazz Team Server login page appears.
    • For a new installation, type ADMIN (case-sensitive) in both the User ID and Password fields. Click Log In.
      Note:
      • Do not use ADMIN (case-sensitive) as user ID and password if you enabled applications to use Lightweight Directory Access Protocol (LDAP) on WebSphere® Application Server. Instead, login as an LDAP registered user who has JazzAdmin privileges.
      • For WebSphere Application Server on z/OS® with RACF® security or WebSphere Application Server on IBM® i with local OS authentication, use a user ID that has been granted JazzAdmin privileges on the system.
    • For an upgrade, log in with an administrative ID used in the previous version, and then click Next.
      Note: If you are unable to login, or if the user does not have administrative access, verify that the following tasks have been completed:
      • On Apache Tomcat:
        • If you are using the Tomcat user database, verify that the tomcat-users.xml file was copied over correctly.
        • If you are using LDAP, verify that the LDAP settings were merged properly in the server.xml file.
      • On WebSphere Application Server:
        • Verify that you have correctly configured the roles to group mappings for all applications.
  4. On the Introduction page, click Next.
  5. On the Configure Public URI page, provide a Public URI Root that is of the form https://[fully qualified hostname]:9443/jts and select the checkbox for I have read and understood the recommendations for configuring the Public URI, and confirm it is set correctly. Click Test Connection. After the test is successful, click Next. If you are upgrading the Jazz Team Server, you cannot change the Public URI.
    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 clmwb.example.com.

    Examples of bad [fully qualified hostname] are localhost and an IP address.

  6. On the Configure Database page, provide information to set up a connection to the database.

    For an upgrade, you should see the database configuration that you specified during the upgrade process. Confirm that the values here match the expected values.

    If you are using the Derby database, you should not have to change the default values, and you will not be prompted to create database tables.

    If you change the default values or set values for an enterprise database like DB2®, Oracle, or SQL Server, click Test Connection to make sure the connection is configured correctly.

    If you did not previously use repotools 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.

    If you have tested the connection and you see no warnings or errors, click Next.

  7. On the Enable E-mail Notification page, enable or disable e-mail notifications. If you choose to enable notifications, you will need to provide information about your e-mail server and test the connection to the e-mail server. Click Next after making your selections and testing the connection.
  8. On the Register Applications page, the wizard detects the applications that were installed along with the Jazz Team Server. It might take a minute for each application to be discovered and added to the list of applications to register. The wizard will also detect the Lifecycle Project Administration application, which must be on the same server as the Jazz Team Server application. The wizard will not detect those applications installed on a different server. You must manually add them; see Step c below.
    1. If you do not want to register an application, click the Close 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.
      What is the Discovery URL?: The discovery URL is the service contribution resource (SCR) URL of an application. In general the SCR URL is formed by adding /scr to the Public URI for the application. For example, if the Public URI for the Change and Configuration Management application is https://[fully qualified hostname]:9443/ccm, the corresponding SCR URL must be https://[fully qualified hostname]:9443/ccm/scr. For a locally installed applications, this URL and a functional User ID will be filled in by the setup wizard.
    3. 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 filled-in 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.
      Note: 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.
      Note: Notice that the menu on the left now lists the registered application along with sub-steps.
  9. On the Setup User Registry page, provide the following information. For an upgrade, your user registry will already be configured and you will have to assign a license to the administrative user.
    1. Select the type of user registry you will use.
      Note:
      • 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.
      • 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 e-mail Address of the user who will have administrative access to the Jazz Team Server.
    3. Depending on the installed applications, under Rational® Requirements Composer, Rational Team Concert™, and Rational Quality 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.

      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.
    4. Click Next after making your selections.
  10. On the Configure Data Warehouse page provide information to setup a connection to the data warehouse. The data warehouse is a database used for reporting and analytics. By default, the application is configured to use the Derby database that is included with the application. If you have a database prepared on an enterprise database server such as DB2 or Oracle, you must configure the Jazz Team Server to use that database.
    1. Optional: To not configure the Data Warehouse at this time, click I do not wish to configure the data warehouse at this time. Only bypass the data warehouse in the following circumstances:
      • You plan to upgrade an existing Rational Quality Manager version 2 application and all of the following are true:
        • You used Rational Common Reporting with Rational Quality Manager;
        • You will be adding the Rational Quality Manager application to this Jazz Team Server environment;
        • You want to use your existing Rational Common Reporting database as the data warehouse for your CLM products;
        • You are not currently upgrading that Rational Quality Manager application.

        When you upgrade your Rational Quality Manager application, you can come back to the setup wizard and configure the Jazz Team Server and the other applications to use the existing Rational Common Reporting database.

      • You used Rational Insight and all of the following are true:
        • You want to use your existing Rational Insight data warehouse database as the data warehouse for your CLM products;
        • You have not yet upgraded to Rational Insight version 1.0.1.1, which is the earliest version that supports CLM.

        After you have upgraded Rational Insight to version 1.0.1.1, you can come back to the setup wizard and configure the Jazz Team Server and the other applications to use the existing Rational Insight database.

      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.

    2. 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.
    3. If you are not using the Derby database, in the Configure Data Warehouse Database Connection Properties section, type the connection properties to connect to your database. The required values will vary depending on your database vendor and connection type.
    4. For Oracle or Microsoft SQL Server, in the Database Table Space Folder field, type the path to an existing directory on the database server where the tablespace will be created.
    5. 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 will be prompted to add tables to your Rational Common Reporting or Rational database.
    6. Type the login information for a functional user that will run the data collection jobs. If you are using Tomcat and the built-in Tomcat User Database, that user will be created in the registry. If you are using LDAP or a different external registry, you must specify a user that exists in the external registry.
      Note: The User ID that you enter for the functional user must be a different ID than the administrative user that you are currently using to configure the application.
    7. Click Test Connection to verify that the server can successfully communicate with the database using the connection information you provided.
    8. 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. If you are using the default Derby data warehouse, you will not see this warning.
    9. Click Next.
  11. For each application configure the database and the data warehouse similar to the steps you carried out above.
    Note: Requirements Management uses the same database as Jazz Team Server. As a result, the databases steps are not available in the menu for Requirements Management.

    If you did not configure the data warehouse for the Jazz Team Server in step 10, on the Configure Data Warehouse page for the application, select I do not wish to configure the data warehouse at this time.

    For the user that will run the data collection jobs, you must enter a different user ID than the ID you are using the configure the application.

  12. On the Finalize Setup page for each application, click Finalize Application Setup. In this step, the consumer key and secret for an application are stored and the users on the Jazz Team Server are synchronized. For the Requirements Management application, if you are upgrading from Rational Requirements Composer version 2 or you are adding a Requirements Management application to an existing Jazz Team Server environment, also click Rebuild Index. If you are configuring an entirely new environment, you do not have to rebuild the index. After you see a message that the process is complete, click Next.
    Note: If the applications on different servers and you see an error message that says "500 error - unexpected error occurred failure during finalize application step," verify that the servers are set to the same date, time, and time zone.
  13. On the Finalize Setup page for the Lifecycle Project Administration application, click Authorize. You might have to log on to any registered applications; log in as an administrative user (the same user ID you are using to run through the setup wizard). Then, click Finalize Application Setup. When the process is complete, click Next.
  14. On the Summary page, you can review the server settings and choose one of the following options:

Feedback