Setting up WebSphere Application Server for Rational Engineering Lifecycle Manager

Deploying and starting the Jazz™ Team Server begins with the selection of the application server, which hosts the Jazz Team Server and its applications. Before you can deploy Rational® Engineering Lifecycle Manager application war files, you must set up your WebSphere® Application Server.

Before you begin

Important: If you are upgrading from an older product version, follow the upgrading instructions to configure your application server.
Ensure you have completed the following tasks:

The Jazz web interface requires that authentication be configured in order to perform authorization and personalize the application.

Note:
  • Rational Engineering Lifecycle Manager v1.x must share an application server with the Lifecycle Query Engine.
  • Rational Engineering Lifecycle Manager v4.x can share an application server with the Lifecycle Query Engine or be deployed to a different application server. However, both applications must be registered to the same Jazz Team Server.

About this task

This document does not provide details for configuring WebSphere authentication or SSL, which is a complex topic. Detailed information about the various authentication and encryption options is covered in the WebSphere Application Server product documentation. For more information, go to the WebSphere product documentation and use this phrase in search: Securing applications and their environment.

Procedure

  1. Configure the Java Virtual Machine in which Rational Engineering Lifecycle Manager runs.

    Click Servers > Server Types > WebSphere application servers > Server1. Under Server Infrastructure, click Java and Process Management > Process definition. Under Additional Properties, click Java Virtual Machine. Enter the following settings. Click Apply, and then Save directly to the master configuration.

    Table 1. Java Virtual Machine configuration
    Field Value Comments
    Initial Heap 4096  
    Maximum Heap Size 24576
    • The figure here is only a suggestion; set the value according to your environment. A typical medium-size team can use a value of 4096 MB, providing 4 GB of heap memory for the Rational Engineering Lifecycle Manager process on a 64-bit computer. If the Maximum Heap Size value is too small, the Rational Engineering Lifecycle Manager data source to the Lifecycle Query Engine might stop processing the existing backlog, and any new changes that create, modify, or delete products.
    • It is important to have more physical memory than is required by all of the processes on the machine combined to prevent paging or swapping. Paging reduces the performance of the system and affects the performance of the Java memory management system.
    • When you increase the Java heap size, ensure that enough unused physical memory is available on the machine to cover the increase. If sufficient physical memory is not available, either install additional memory or take into account the effect on overall performance that occurs.
    Generic JVM arguments Linux
    -Xmx4g -Xms4g -Xmn512m
    -Xgcpolicy:gencon -Xcompressedrefs
    -Xgc:preferredHeapBase=0x100000000
    Windows
    -Xmx4g -Xms4g -Xmn512m
    -Xgcpolicy:gencon -Xcompressedrefs
    -Xgc:preferredHeapBase=0x100000000
    Linux
    If you need more heap size, then you can use the following setting, replacing {N} with the amount of memory to be used and {N/8} with 1/8 of the total memory. For example, if -Xmx is set to 8g, -Xmn should be set to 1g.
    -Xgcpolicy:gencon -Xmx{N} -Xms{N} -Xmn{N/8}
    -Xcompressedrefs  -Xgc:preferredHeapBase=0x100000000
  2. Configure your custom properties.

    Under Additional Properties, click Custom properties > New. Enter the general properties information for each of the following custom properties and click OK to save the information for each custom property. Then click Save directly to the master configuration.

    Table 2. Custom properties information
    Custom Property Name Custom Property Value Comments
    JAZZ_HOME file:///JazzInstallDir/server/conf

    Substitute JazzInstallDir with the Jazz Team Server installation directory.

    Remember:
    • You must use three forward slashes (///) after file:
    • To avoid problems, do not use spaces in file paths. For the Program Files directory you can use PROGRA~1, and for the Program Files (x86) directory, you can use PROGRA~2.
    Examples:

    Linux file:///opt/IBM/JazzTeamServer/server/conf

    Windows file:///C:/PROGRA~1/IBM/JazzTeamServer/server/conf

    This system property specifies where to find certain configuration files. This property uses a URL rather than a simple path. Enter a value as a file-style URL: file:///file_path.
    Important: In a distributed environment, when you are using a separate application server for each web application, you must add these custom properties for each instance of the WebSphere Application Server.
    java.awt.headless true  
    org.eclipse.emf.ecore.plugin.EcorePlugin.doNotLoadResourcesPlugin true  
    Oracle

    ORACLE_JDBC_DRIVER_FILE

    Absolute path to the JDBC_driver/ojdbc6.jar The path to the JDBC driver must be an absolute path. Do not use URL path (file:///). For more information about Oracle Java Database Connectivity (JDBC) connections, see Setting up an Oracle database for Rational Engineering Lifecycle Manager and the Lifecycle Query Engine

    SQL_JDBC_DRIVER_FILE

    Absolute path to the JDBC_driver/sqljdbc4.jar The path to the JDBC driver must be an absolute path. Do not use URL path (file:///). For more information about connecting to a SQL Server database, see the documentation for the Rational solution for Collaborative Lifecycle Management.
    log4j.configuration file:///JazzInstallDir/server/conf/startup_log4j.properties  
  3. Increase the default thread pool to allow for multiple users.

    Click Servers > Server Types > WebSphere application servers > Server1. Under Additional Properties, click Thread pools > WebContainer. Increase the default maximum size from 50 to 200 threads, and click Save directly to the master configuration.

  4. Configure the InvalidateOnUnauthorizedSessionRequestException custom property.
    Click Servers > Server types > Application servers > Server1 > Session management > Custom properties > New. Enter the name and value pair for your custom property. Click OK or Apply, and then click Save on the console task bar to save your configuration changes.
    Table 3. Custom property information
    Custom Property Name Custom Property Value Comments
    InvalidateOnUnauthorizedSessionRequestException true The default value for this session management custom property is false.
  5. Set the Jazz Reporting Service shared library.
    1. On the administrative console, go Environment > Shared libraries. Change the drop-down scope to server, and click New.
    2. Enter the shared library name as JRS Shared Library, add a description, and set the class path to 5.0.1_install_dir/server/conf/rs/SharedLibrary. Under Class Loading, select the check box to use an isolated class loader for the shared library and click Apply.
    3. Click Save to the master configuration.
  6. Restart the application server for the changes to take effect.
    • Linux Run the stopServer.sh and the startServer.sh command.
    • Windows Run the stopServer.bat and the startServer.bat command.

What to do next

  1. Deploy your application files.
    1. On the WebSphere Application Server administrative console, go to Applications > New Application > New Enterprise Application.
    2. In the Preparing for application installation wizard, under Path to the new application, select Local file system and specify the full path to your application file. In the Install New Application wizard, set the application context root, and follow all the installation steps. On the Install New Application summary page, verify your selected installation options, an click Finish.
      Table 4. Application files and values
      Application Full Path Value Context Root
      Rational Engineering Lifecycle Manager RELM_install_dir/server/webapps/relm.war /relm
      Rational Engineering Lifecycle Manager documentation RELM_install_dir/server/webapps/relmhelp.war /relmhelp
      Configuration Management application RELM_install_dir/server/webapps/vvc.war /vvc
      Jazz Reporting Service RELM_install_dir/server/webapps/rs.war /rs
    3. Click Save directly to the master configuration.

  2. Add the Jazz Reporting Service library reference.
    1. Go to Applications > Applications types > WebSphere enterprise applications, and click rs_war in the application list.
    2. In the Reference section, click Shared library references.
    3. Select the check box next to rs_war, and click Reference shared libraries.
    4. Select JRS Shared Library, and click the right arrow.
    5. Click OK. Then, click OK again to save your settings to the master configuration.

  3. Ensure that Jazz Reporting Service class loading order is configured correctly.
    1. Go to Applications > Applications types > WebSphere enterprise applications, and click rs_war in the application list.
    2. In the Detail Properties section, click Class loading and update detection.
    3. In the Class loader order section, select Classes loaded with local class loader first (parent last).
    4. Click OK, and Save to master configuration.

  4. On the Enterprise Applications page, select the applications that you have just deployed to WebSphere Application Server and select Start.
Note: This document does not provide details for configuring WebSphere authentication or SSL, which is a complex topic. Detailed information about the various authentication and encryption options is covered in the WebSphere Application Server product documentation. For more information, go to the WebSphere product documentation and use this phrase in search: Securing applications and their environment.

Feedback