Configuring WebSphere Application Server for use with Rational Quality Manager

Follow these instructions to configure IBM WebSphere® Application Server for use with IBM Rational® Quality Manager.

Planning for the configuration

Note: IBM® Rational Team Concert provides additional information on configuring WebSphere Application Server. To view this information, see Setting up a WebSphere Application Server.

Updating WebSphere Application Server

  1. If you don't have WebSphere Application Server (WAS) installed, do so now. See the WebSphere Application Server installation guide for step-by-step directions.
  2. Install WebSphere Application Server fix pack WASSDK FP13 or WASSDK FP15. Jazz support requires WebSphere Application Server 6.1 to have the Java™ SDK 1.5 SR6 Cumulative Fix for WebSphere Application Server applied, but later cumulative fixpacks are also acceptable. To install the fix pack, you must first install the “Update Installer”. At a minimum, WASSDK FP13 (which corresponds to IBM JDK SR6) must be applied. The Jazz™ WebSphere installation instructions point to this fix pack.
    Note: Be sure to install the SDK fix pack, not the regular fix pack.

Configuring WebSphere Application Server

To configure WebSphere Application Server:

  1. If it is not already running, start the WebSphere Application Server service.
  2. Browse to the WebSphere Application Server Administrative console.
  3. Authenticate with the server as the admin resource.
    Note: The person who installed the WebSphere software would have specified the user ID and password of the admin resource at the time of installation.
  4. After authentication, click Servers > Application Servers > server1.
  5. Locate the Server Infrastructure section of the server1 configuration page, expand Java and Process Management, and click Process Definition.
  6. On the Process Definition page, go to the Additional Properties section and click Java Virtual Machine.
  7. Increase the Maximum Heap Size to 1000 and click Apply.
  8. In the Generic JVM arguments section on the Java Virtual Machine page, include the following JVM arguments. Be sure to add the JVM arguments on one line.

    Windows example:

    -Dcom.ibm.team.server.configURL=file:///D:/RQM/server/teamserver.properties -Dlog4j.configuration=file:///D:/RQM/server/log4j.properties -Djava.awt.headless=true -Dorg.eclipse.emf.ecore.plugin.EcorePlugin.doNotLoadResourcesPlugin=true -Xmx1000M -Dcom.ibm.team.repository.provision.profile=///D:/RQM/server/provision_profiles -Dcom.ibm.rqm.create.samples=false -Xss768k

    Linux example:

    -Dcom.ibm.team.server.configURL=file:///opt/IBM/RQM/server/teamserver.properties -Dlog4j.configuration=file:///opt/IBM/RQM/server/log4j.properties -Djava.awt.headless=true -Dorg.eclipse.emf.ecore.plugin.EcorePlugin.doNotLoadResourcesPlugin=true -Xmx1000M -Dcom.ibm.team.repository.provision.profile=///opt/IBM/RQM/server/provision_profiles -Dcom.ibm.rqm.create.samples=false -Xss768k

    where D:/RQM is the installation directory on Windows and opt/IBM/RQM is the installation directory on Linux.

    These values must be encoded, which requires that any spaces in the file paths should be replaced with %20. For example, C:\Program Files would become C:\Program%20Files. If the JVM argument values are entered incorrectly, the WebSphere Application Server will not start. If this happens, you cannot use the WebSphere Application Server Web user interface to correct this; you must locate the server.xml file, edit the file, and then start WebSphere Application Server. The file is typically located here:
    c:\Program Files\IBM\WebSphere\AppServer\profiles\AppSrv01\config\cells\qwin268Node01Cell\nodes\qwin268Node01\servers\server1\server.xml
    Note: The JVM arguments mentioned in the Rational Team Concert help do not contain the full JVM arguments needed for correct deployment of Rational Quality Manager.
  9. Under Additional Properties, click Custom Properties.
  10. Click New and add these values:
    • Name: com.ibm.team.repository.provision.profile Value: file:///JazzInstallDir/server/provision_profiles
    • Name: com.ibm.team.server.configURL Value: file:///JazzInstallDir/server/teamserver.properties
    • Name: log4j.configuration Value: file:///JazzInstallDir/server/log4j.properties
    • Name: java.awt.headless Value: true
    • Name: org.eclipse.emf.ecore.plugin.EcorePlugin.doNotLoadResourcesPlugin Value: true

      For example, add the specified values this way: JazzInstallDir = C:/IBM/RQM

  11. Save the changes to the Master Configuration file.
  12. Shut down and restart the WebSphere Application Server.
    Note: If the server does not restart, check the Generic JVM arguments manually. These arguments are maintained in the server.xml file, which in a typical installation can be found at the following location:
    C:\Program Files\ibm\WebSphere\AppServer\profiles\AppSrv01\config\cells\enable01
    Node01Cell\nodes\enable01Node01\servers\server1\server.xml

Configuring the Rational Quality Manager product and help on WebSphere Application Server

To configure the IBM Rational Quality Manager product and help in a WebSphere Application Server environment:

  1. Start the WebSphere Admin console interface and authenticate with the server using the WebSphere Application Server Admin user ID.
  2. Expand Applications and click Install New Application.
  3. Under Path to the new application, browse to the location of the jazz.war file on the Local file system and select the file.
  4. Type the context root as /jazz and then click Next.
    Note: You can find the jazz.war file at <Rational Quality Manager _install_path>\server\tomcat\webapps\jazz.war.
  5. Continue clicking Next until you see the Summary screen, and then click Finish to install the new application.
  6. Verify that the jazz_war application was installed and click Save to save the changes to the Master Configuration file.
  7. Return to the Install New Application page.
  8. Browse to the location of the help.war file on the local file system and select the file. Type the context root as /help and click Next.
    Note: You can find the help.war file at <Rational Quality Manager_installation_path>\server\tomcat\webapps\help.war.
  9. Continue clicking Next until you see the Summary screen, then click Finish to install the new application.
  10. Verify that the help_war application was installed and click Save to save the changes to the Master Configuration file.
  11. Expand the Enterprise Application section in the Applications option.
  12. Select jazz_war and click Start.
  13. Select help_ war and click Start.

Configuring LDAP on WebSphere Application Server for Rational Quality Manager

To configure LDAP:

  1. From the Websphere Admin console, click Security > Secure administration, applications, and infrastructure.
  2. Update the security settings as follows:
    • Enable administrative security: on
    • Enable application security: on
    • User account repository/Available realm definitions: standalone LDAP registry
    • In the User account repository section, click Configure and supply the General Properties.
      • Primary administrative user name - Your user ID
      • Server user identity - Automatically generated server identity
      • Type of LDAP server - Custom
      • Search timeout - 120 seconds
  3. Click Apply and save the changes.
  4. In the Configuration section, click Test connection.
  5. In the Additional Properties section, click Advanced Lightweight Directory Access Protocol (LDAP).
  6. Specify the General Properties fields as follows:
    • User filter:
      (&(emailaddress=%v)(objectclass=ePerson)) 
    • Group filter:
      (&(cn=%v)(|(objectclass=groupOfNames)(objectclass=groupOfUniqueNames))) 
    • User ID map:
       *:emailaddress 
    • Group member ID map: (replace ibm with your own ID)
      ibm-allGroups:member;ibm-allGroups:uniqueMember 
    • Certificate map mode:
      EXACT_DN
  7. Click Apply when done and save the changes.
  8. Click Apply and Save for each of the screens to confirm each setting.
    Note: On the last page, make sure the Current realm definition is set to Standalone LDAP registry.
  9. Stop and restart the WebSphere Application Server.
  10. After the WebSphere Application Server restarts, validate the changes by logging into the Admin Console.
  11. To map user groups to the specific applications, click Applications > Enterprise Applications.
  12. In the list of Enterprise Applications, select the jazz_war application and click Stop.
  13. When the application is stopped, click the jazz_war application to open it for editing.
  14. In the Detail properties section, click Security role to user/group mapping.
  15. Select a specific group, such as JazzAdmins and JazzUsers, and click Look up groups.

    These groups are associated with every Jazz implementation and must be mapped to a particular LDAP group that contains the authorized users. These groups need to be set up on the LDAP server prior to performing this mapping.

  16. Enter a search string to return your group names from the LDAP server. Click Search to run the query.
  17. From the list of available groups returned, select the particular group and move it to the Selected column.
  18. Click OK to map the LDAP groups to the Jazz groups.
  19. Map the appropriate LDAP group for all Jazz groups:
    • JazzAdmins
    • JazzDWAdmins
    • JazzUsers
    • JazzGuests
    Note: Do not enable the All authenticated? option.
  20. Save the changes and restart the jazz_war application.
  21. Log out of the Admin Console and shut down the browser window.

Setting up the WebSphere Application Server custom registry

Note: You can use the instructions in this section while you are evaluating Rational Quality Manager. These instructions are not useful in an actual production environment if you are using LDAP.

To set up user credentials using the WebSphere Application Server custom registry:

  1. Create a directory called WAS_Security and add the users.props and groups.props files to the root of the drive where WebSphere Application Server is installed.
  2. Click Security > Secure administration, applications and infrastructure and select Standalone custom registry from the User Account Repository section; then click the Security Configuration Wizard button.
  3. In Step 1 of the Security Configuration Wizard, select Enable application security.
  4. In Step 2, select Standalone custom registry.
  5. In Step 3, Configure user repository, add a Primary administrative user name, and a name and value for both usersFile (users.props) and groupsFile (groups.props):
    Step 3 of Configure Security Wizard showing completed fields for admin username and location for usersFile and groupsFile
  6. In Step 4, review the summary, and then click Finish.
  7. Save changes by clicking Save directly to the master configuration. From Applications > Enterprise Applications, select jazz.war, and then click Stop (unless already stopped as indicated with a red x).
  8. Select the jazz.war link and then select Security role to user/group mapping.
  9. Select JazzAdmins, and then click Look up groups:
    Security role to user/group mapping
  10. Click Look up groups and then select admins from the available list.
  11. Add to selected list. Repeat steps 9 and 10 for JazzDWAdmins, again selecting admins.
  12. For JazzUsers and JazzGuests follow steps 9 and 10, but select users for the roles.
  13. Save the changes by clicking Save directly to the master configuration.
  14. To complete the WebSphere Application Server configuration, restart the WebSphere Application Server.

Starting WebSphere Application Server as a Windows service

With Rational Quality Manager, you can create test scripts that refer to automated tests that were created with other test tools. These automated tests can be saved on local test machines or on shared network locations. Tests that are saved on shared network locations are accessed via Universal Naming Convention (UNC) shares.

By default, when WebSphere Application Server runs as a Windows® service, it logs in as a local system account. In this case, it is possible that Rational Quality Manager will be unable to access UNC shares because the local system account lacks security credentials. Therefore, be sure to set the WebSphere Application Server Windows service to log in as a specific user account with security credentials. This allows the service to connect to any UNC shares that match the security credentials of that user account.

Related tasks
Making shared test resources available

Feedback