Setting up and configuring the Design Management Server

Use the following steps to set up and configure the Design Management Server. After Design Management is installed, you must configure the IBM® Jazz™ Team Server URI and the database to store data. You must also configure the database, data warehouse, users, and other applications that you installed.
Before you configure the server, you must enable pop-up windows to avoid installation problems during the setup and configuration process.
Important: When you set up and configure the model server, do not refresh the browser or use the Forward and Back buttons in the browser.
To use a database other than the default Apache Derby database, see the following topics: If you want to use WebSphere® Application Server instead of the included Apache Tomcat server, see the following topic:

The first step of the setting up Design Management Server with the Rational® solution for Collaborative Lifecycle Management (CLM) is to configure the IBM Jazz Team Server and its database.

  1. Start the installed server by using an account that has administrator permissions.
    • If you are using Apache Tomcat on a Windows operating system, click Start > All Programs > Collaborative Lifecycle Management > Start the Jazz Team Server.
      Important: If you are using Apache Tomcat, wait for the message INFO: Server startup in # ms. This step might take a while to complete the first time that you start the server; on subsequent restarts, the server starts much faster.
      Tip: To start the server from the command line, open a command prompt as an administrator: click Start > Programs > Accessories, right-click Command Prompt, and click Run as administrator. In the administrator command window, go to the server folder in your server installation directory and run server.startup.bat.
    • If you are using Apache Tomcat on a Linux operating system, go to the server folder in your server installation directory and run server.startup.
    • If you are using WebSphere Application Server, start the server from the WebSphere Application Server administrative console.
  2. In a web browser, go to https://fully_qualified_host_name:9443/jts/setup.

    A fully_qualified_host_name includes both the host name and the DNS domain reference of the server on which the Jazz Team Server is installed. An example of a fully qualified host name is myserver.example.org. The fully qualified host name cannot include localhost or an IP address.

    To find the fully qualified host name (hostname.DNSsuffix) of the server on a Windows operating system, at a command prompt, type hostname to get the host name, and type ipconfig to get the DNS suffix.

    On a Linux operating system, in a terminal window, type hostname –fqdn.

  3. If a security message is displayed, and you understand and accept the associated risks, configure your browser to connect to the server.
  4. The Design Management Server is built on and runs on Jazz Team Server. Therefore, during the setup and configuration process, you must use parts of the standard Jazz Team Server functionality. On the Jazz Team Server login page, enter ADMIN (case sensitive) in both the User ID and Password fields, and then click Log In.

    The following diagram displays the login page for the Jazz Team Server.

  5. On the Setup page, click Custom Setup and click Next.
  6. On the Introduction page, click Next.
  7. On the Configure Public URI page, provide a public URI in the following format: https://fully_qualified_host_name:9443/jts. After you read the warning, and if you understand the implications, click I understand that once the Public URI is set, it can not be modified. Design Management verifies the connection; after the test is successful, click Next.

    The following diagram shows the Configure Public URI page. You can accept the default URI or enter a different URI.

    Tip: If another Jazz application is installed on the server, to avoid a port number collision, change the default port number from 9443 to an available port number. If you have a multiple or enterprise installation that is using Apache Tomcat and have different applications installed in different installations packages, each application must have a different port number to avoid collisions.
    Remember: The variable fully_qualified_host_name is the host name and the DNS domain reference of the computer on which the Jazz Team Server is installed.
  8. On the Configure Database page, complete the steps for the Jazz Team Server database that you are using:

    1. From the Database Vendor list, select the type of database.
    2. From the Connection Type list, select JDBC.
    3. In the JDBC Password field, specify the password for the database user that accesses the database.
    4. In the JDBC Location field, specify the location of the database, using the phrase {password}, including the braces, in place of the password.
      • To install an Apache Derby database, leave the JDBC Password field blank and leave the default value in the JDBC Location field.
      • For a DB2 database, ensure that you prepared the necessary databases as described in Setting up a DB2 database, and then specify the connection string for the database. For example, if the database is installed on myserver.example.org on port 50001 and you are using the default db2inst1 user, specify the following JDBC location:
        //myserver.example.org:50001/JTS:user=db2inst1;password={password};
      • For an Oracle database, follow these steps:
        1. Create a folder named oracle in the server folder of the Design Management Server installation.
        2. Put a copy of the Oracle JDBC JAR file ojdbc5.jar in the oracle folder.
        3. Ensure that you have set up the database as described in Setting up an Oracle database and then specify the connection string for the database. The following code is an example connection string:
          thin:username/{password}@//myserver.example.org:1521/ORACLE_SID
          Use the database user name for username and the ID of your Oracle system for ORACLE_SID.
      • For an SQL Server database, ensure that you set up the database as described in Setting up an SQL Server database, and then specify the connection string for the database. For example, if the database is installed on myserver.example.org and the instance name is SQLINSTANCE, the location looks like the following example:
        //<SQLServer host name>:1433;databaseName=Database Instance>;user=<Database User>;password={password}
    5. Click Next.
  9. On the Enable E-mail Notification page, enable or disable email notification. If you enable notifications, you must provide information about the email server and test the connection. After your selection, click Next.
  10. On the Register Applications page, accept the default settings and click Register Applications. The wizard detects the applications that are installed. The Jazz Team Server and Application Setup wizard automatically finds the Design Management (/dm), Configuration Management Server (/vvc) and Administration (/admin) application and, if applicable, any other CLM applications (/rm, /qm, and /ccm).
  11. If you are setting up an enterprise or multiple installation scenario, you must provide the location of the other CLM and Design Management applications. Click Add Application and add the application instance and the URL of the server that contains the application. Then, click Register Applications.
  12. After the application is registered, click Next. After the wizard registers applications, the left panel in the browser displays additional steps if you are installing multiple CLM applications.
  13. On the Setup User Registry page, provide the following information.
    1. Select the type of user registry to use.
      Note: If you select an LDAP user registry, you must provide information to configure the connection between the Jazz Team Server and the LDAP server. You must log in to the WebSphere Application Server as a registered LDAP user with JazzAdmins privileges.
    2. Create the user ID, name, password, and email address of the user who has administrative user access to the Jazz Team Server. You might consider using DM_Admin for the user ID, name, and password.
    3. Optional: For security reasons, you can disable the ADMIN user.
    4. Assign the Rational Software Architect - Designer or Rational Rhapsody Design Manager - Design Manager license to the new DM_Admin account, and then click Next.
      Note: If you are installing other CLM applications, you can also select licenses for Rational Requirements Composer, Rational Team Concert™, or Rational Quality Management. Click Activate Trial to get a temporary license.

      The following diagram shows the User Registration page where you can activate licenses and set up the authentication type.

  14. On the Configure Data Warehouse page, specify the vendor and connection information for the data warehouse. You can also select the I do not wish to configure the data warehouse at this time check box to skip configuring the data warehouse.

    The following diagram shows the Data Warehouse page. The Warehouse page is displayed multiple times if you are installing other CLM applications.

    1. From the Database Vendor list, select the type of database.
    2. From the Connection Type list, select JDBC.
    3. In the JDBC Password field, specify the password for the database user that accesses the database.
    4. In the JDBC Location field, specify the location of the database, using the phrase {password}, including the braces, in place of the password.
      • To install an Apache Derby database, leave the JDBC Password field blank and leave the default value in the JDBC Location field.
      • For a DB2 database, ensure that you have set up the database as described in Setting up a DB2 database, and then specify the connection string for the database. For example, if the database is installed on myserver.example.org on port 50001 and you are using the default db2inst1 user, specify the following JDBC location:
        //myserver.example.org:50001/DW:user=db2inst1;password={password};
      • For an Oracle database, ensure that you set up the database as described in Setting up an Oracle database and then specify the connection string for the database. The following code is an example connection string:
        thin:username/{password}@//myserver.example.org:1521/ORACLE_SID
        Use the database user name for username and the ID of your Oracle system for ORACLE_SID.
      • For an SQL Server database, ensure that you set up the database as described in Setting up an SQL Server database, and then specify the location of the database. For example, if the database is installed on myserver.example.org and the database name is SQLdb, the location looks like the following example:
        //myserver.example.org:1433;databaseName=SQLdb;user=<Database User>;password={password}
    5. In the Database Table Space Folder field, specify where to create the table space. Do not use spaces in the location of the table space.
    6. In the Custom Report Database User field, specify the name of the user that accesses the data warehouse for report information.
    7. Click Test Connection and resolve any problems with the database connection before you continue.
    8. At the bottom of the page, specify the login information for the user that runs data collection jobs for the data warehouse. If you are using an LDAP server or another external user registry, ensure that the registry has a matching user.
    9. Click Next.
You have now completed the Jazz Team Server configuration. You can now configure the Design Management Server and any other CLM applications.

Setting up the CLM applications (optional)

If you are installing CLM applications along with Design Management Server, you must configure the CLM applications, including their databases and data warehouses.
For each CLM application configure the database and the data warehouse using the following steps.
  1. On the Configure Database page, complete the steps for the IBM Jazz Team Server database that you are using:
    1. From the Database Vendor list, select the type of database.
    2. From the Connection Type list, select JDBC.
    3. In the JDBC Password field, specify the password for the database user that accesses the database.
    4. In the JDBC Location field, specify the location of the database, using the phrase {password}, including the braces, in place of the password.
      • To install an Apache Derby database, leave the JDBC Password field blank and leave the default value in the JDBC Location field.
      • For a DB2 database, ensure that you prepared the necessary databases as described in Setting up a DB2 database, and then specify the connection string for the database. For example, if the database is installed on myserver.example.org on port 50001 and you are using the default db2inst1 user, specify the following JDBC location:
        //myserver.example.org:50001/JTS:user=db2inst1;password={password};
      • For an Oracle database, follow these steps:
        1. Create a folder named oracle in the server folder of the Design Management Server installation.
        2. Put a copy of the Oracle JDBC JAR file ojdbc5.jar in the oracle folder.
        3. Ensure that you have set up the database as described in Setting up an Oracle database and then specify the connection string for the database. The following code is an example connection string:
          thin:username/{password}@//myserver.example.org:1521/ORACLE_SID
          Use the database user name for username and the ID of your Oracle system for ORACLE_SID.
      • For an SQL Server database, ensure that you set up the database as described in Setting up an SQL Server database, and then specify the connection string for the database. For example, if the database is installed on myserver.example.org and the database name is SQLdb, the location looks like the following example:
        //myserver.example.org:1433;databaseName=SQLdb;user=<Database User>;password={password}
    5. Click Next.
  2. On the Configure Data Warehouse page, specify the vendor and connection information for the data warehouse. You can also select the I do not wish to configure the data warehouse at this time check box to skip configuring the data warehouse.
    1. From the Database Vendor list, select the type of database.
    2. From the Connection Type list, select JDBC.
    3. In the JDBC Password field, specify the password for the database user that accesses the database.
    4. In the JDBC Location field, specify the location of the database, using the phrase {password}, including the braces, in place of the password.
      • To install an Apache Derby database, leave the JDBC Password field blank and leave the default value in the JDBC Location field.
      • For a DB2 database, ensure that you set up the database as described in Setting up a DB2 database, and then specify the connection string for the database. For example, if the database is installed on myserver.example.org on port 50001 and you are using the default db2inst1 user, specify the following JDBC location:
        //myserver.example.org:50001/DW:user=db2inst1;password={password};
      • For an Oracle database, ensure that you set up the database as described in Setting up an Oracle database and then specify the connection string for the database. The following code is an example connection string:
        thin:username/{password}@//myserver.example.org:1521/ORACLE_SID
        Use the database user name for username and the ID of your Oracle system for ORACLE_SID.
      • For an SQL Server database, ensure that you set up the database as described in Setting up an SQL Server database, and then specify the location of the database. For example, if the database is installed on myserver.example.org and the database name is SQLdb, the location looks like the following example:
        //myserver.example.org:1433;databaseName=SQLdb;user=<Database User>;password={password}
    5. In the Database Table Space Folder field, specify where to create the table space. Do not use spaces in the location of the table space.
    6. In the Custom Report Database User field, specify the name of the user that accesses the data warehouse for report information.
    7. Click Test Connection and resolve any problems with the database connection before you continue.
    8. At the bottom of the page, specify the login information for the user that runs data collection jobs for the data warehouse. If you are using an LDAP server or another external user registry, ensure that the registry has a matching user.
    9. Click Next.
  3. Click Finalize Application Setup for each CLM application.

    The Finalize Application page is displayed for most CLM applications but can differ depending on the application. Some steps can take a few minutes to complete.

You have configured the CLM applications. You can now configure the Design Management Server by completing similar steps.

Configuring the Design Management application

You can now set up the Design Management application. The set up is similar to the set up for CLM applications, but includes additional steps for Design Management functionality.
  1. On the Design Management Configure Database page, complete step 8 from the previous procedure.
  2. On the Jazz Applications Framework (JAF) Finalization Application page, under Step 1, click Finalize Application Setup. After the application is finalized, click Next.
  3. On the Finalize Application page, click Finalize Application. Once completed, click Next. Note that steps 6 and 7 on the Finalize Application page can take up to 15 minutes to complete.

    In the following diagram, the Finalize Application page is displayed for Design Management. Each step can take a few minutes to complete.

You have successfully installed the Design Management application. You can now set up the remaining the CLM applications for requirements management and lifecycle project administration.

Setting up quality management and requirements management and lifecycle project administration applications

If applicable, you can now set up the CLM applications for requirements management and lifecycle project administration.
These applications use the same database asIBM Jazz Team Server. As a result, the database steps are not available on the menu for these applications.
  1. For quality management applications, you must complete similar steps under the heading Setting up the CLM applications.
  2. Click Finalize Application Setup for each application.

Summary

  1. On the Summary page, review the setup details for the Jazz Team Server.
    Important: At this point in the wizard, you have successfully completed the setup and the application is ready to use.

  2. Click Finish and the wizard redirects you to https://fully_qualified_host_name:9443/jts/admin.

Installation summary

You have completed the setup of the Design Management Server.
To help you get started, on the Server Administration page, click Create Users or Assign Client Licenses on the right side of the page under Task Guide.

Feedback