Deploying applications for the Rational solution for Collaborative Lifecycle Management on WebSphere Application Server

Use these instructions to deploy the Rational solution for Collaborative Lifecycle Management (CLM) applications on an IBM WebSphere® Application Server.

Before you begin

  • By default, the web application files (.war) are copied into the JazzInstallDir/server/webapps directory unless during the installation you specified a different location.
  • Uninstall WebSphere Application Server default applications (DefaultApplication, ivtApp, and query) if they are installed with the profile. Jazz Team Server and CLM applications do not use these applications and for security and performance reasons they can be removed.
  • If you are using a federated file-based user registry, you must create the Jazz repository groups in WebSphere Application Server before you install any CLM applications. For more information, see Managing users by using a federated, file-based registry.

About this task

Note: On UNIX, if WebSphere Application Server is installed in a non-root environment, the user who deploys the CLM applications must have read and write access to the installation directory and all subdirectories.
In the following command-line examples, the WASInstallDir variable represents the location where WebSphere Application Server is installed on your server.
  • For Windows operating systemThe default value for the WebSphere Application Server installation directory is as follows:
    C:\Program Files\IBM\WebSphere\AppServer
    You can restart the server with these commands on Windows: 
    cd WASInstallDir\bin 
stopServer.bat server1 [for a secure server, include: -username WAS_USER -password USER_PASSWORD] 
startServer.bat server1
  • For Unix operating systemsThe default value for the WebSphere Application Server installation directory is as follows:
    /opt/IBM/WebSphere/AppServer
    You can restart the server with these commands on UNIX:
    cd WASInstallDir/bin 
./stopServer server1 [for a secure server, include: -username WAS_USER -password USER_PASSWORD] 
./startServer server1

Procedure

  1. Open the WebSphere Integrated Solutions Console.
  2. Click Applications > New Application > New Enterprise Application.
  3. Under Path to the new application, select Remote file system. Choosing Remote file system works for both local drives and network drives.
  4. Under Full path enter the path to the jts.war web application file. The default directory is: 
    JazzInstallDir/server/webapps
    For Lifecycle Query Engine (LQE) and Link Index Provider (LDX) only: Expand Choose to generate default bindings and mappings, and then select the Generate Default Bindings check box.
  5. Click Next to accept all default options until you reach the Map context roots for web modules page.
  6. In the Map context roots for web modules, set Context Root to /jts, and click Next.
  7. Click Finish.
  8. Verify that the jts_war application was installed correctly and click Save directly to the master configuration.
  9. Map security roles to a user or repository group:
    Note: For applications that have Jazz Security Architecture SSO enabled, this step is unnecessary.
    1. Go to Applications > Application Types > WebSphere enterprise applications.
    2. Click the jts_war application, and open it for editing.
    3. In the Detail properties section, click Security role to user/group mapping.
    4. Select a specific repository group, such as JazzAdmins or JazzUsers, and click Map groups.

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

    5. Enter a search string to return your group names from the LDAP server. Click Search to run the query.
    6. From the list of available groups that is returned, select the particular group and move it to the Selected column.
    7. Click OK to map the LDAP groups to the Jazz repository groups.
    8. Map the appropriate LDAP group for all Jazz repository groups:
      • JazzAdmins
      • JazzProjectAdmins
      • JazzUsers
      • JazzGuests
      Note: Do not enable the All authenticated? option.
    9. Save the changes.
    Note: If in the future there will be changes to the LDAP configuration level, you must remap the security roles to the user or repository group for JTS and other installed applications. Also if in the future you need to change the security mappings of the applications, you must first stop the application, change the security mapping, and then restart the application.
  10. Repeat the preceding steps to deploy these applications:
    Important: The ccm_war and qm_war applications must have the same authentication methods for their users and use the same security groups mapped as the jts_war application. All the other applications are not required to do Step 9.
    Table 1. Additional web applications to deploy
    Application Web archive file Context root
    Change and Configuration Management (CCM) ccm.war /ccm
    Important: If your upgrade path started from Rational Team Concert™ version 2, the context root must be /jazz.
    Quality Management (QM) qm.war /qm
    Important: If your upgrade path started from Rational Quality Manager version 2, the context root must be /jazz.
    Requirements Management (RM) rm.war /rm
    Important: If your upgrade path started from Rational Requirements Composer version 2, the context root must be /rdm.
    Product documentation clmhelp.war /clmhelp
    Important: This WAR file must be deployed for context-sensitive help in the user interface to work.
    Requirements Management view mode version of the graphical artifacts. converter.war /converter
    Important: The Converter application is supported only on Windows and Linux. On Linux systems, there is a limitation that the Converter application (converter.war) and Design Manager applications (dm.war) cannot coexist on the same application server and must be deployed on separate application servers. For more information, see Requirements Management Converter Application Configuration and Troubleshooting Guide.
    Rational Engineering Lifecycle Manager (RELM) relm.war /relm
    Rhapsody Design Management (DM) dm.war /dm
    Design Management documentation clmhelp.war /clmhelp
    Jazz Reporting Service - Data Collection Component (DCC) dcc.war /dcc
    Jazz Reporting Service - Lifecycle Query Engine (LQE) lqe.war /lqe
    Jazz Reporting Service - Report Builder (RS) rs.war /rs
    Link Index Provider (LDX) ldx.war /ldx
    Global Configuration Management (GC) gc.war /gc

Configure the Lifecycle Query Engine (LQE) application

Procedure

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

Configure the Link Index Provider (LDX) application

Procedure

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

Configure the Report Builder (RS) application

Procedure

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

Start the server

Procedure

  1. In WebSphere Integrated Solutions Console click Applications > Application Types > WebSphere enterprise applications.
  2. Select the check box next to each installed application, and then click Start. A green arrow should appear that indicates the application is successfully started.
Related concepts:
Single sign-on authentication in CLM

video icon Watch videos

CLM playlist
Jazz.net channel
User Education channel

learn icon Learn more

CLM learning circle
Agile learning circle
Learning circles

ask icon Ask questions

Jazz.net forum
developerWorks forums

support icon Get support

Support Portal
Deployment wiki
Support blog