Setting up a WebSphere Application Server

This topic describes how to set up the Jazz™ Team Server to work with WebSphere® Application Server. This setup assumes that you are installing the Jazz Team Server on the same machine as the Websphere Application Server.

Before you begin

Before beginning these steps, you should have the following completed:
Tip: When using the IBM® Installation Manager the Jazz Team Server files can be installed into a Web application directory. During the installation process, you should not install the included Apache Tomcat application server; this makes the Installation Manager ask for a Web Application directory and install only the files needed for WebSphere. The default directory is C:\Program Files\IBM\JazzTeamServer on Windows® or /opt/IBM/JazzTeamServer on Linux®. The installation directory is referred to as JazzInstallDir in this procedure. If you use the IBM Installation Manager to install the files into the WebSphere Application Server Web applications directory, then you do not need to manually move the files as described above.

About this task

Note: This document does not teach the configuration of WebSphere authentication or SSL, which is a complex topic. Detailed information about the various authentication and encryption options for WebSphere is covered in the WebSphere Information Center. For more information, go to the WebSphere Information Center and search for Securing applications and their environment. The Jazz Web UI requires that authentication be configured in order to perform authorization and personalize the application.

Procedure

  1. Review and update the database location in the teamserver.properties file.
    com.ibm.team.repository.db.vendor = DB2
    com.ibm.team.repository.db.jdbc.location=//localhost:50000/JAZZ:user=db2admin;password={password};
    com.ibm.team.repository.db.jdbc.password=db2admin
    Note: This is a sample DB2 configuration. The teamserver.properties should be updated depending on the database vendor (Oracle/MS-SQL).
  2. Verify or update the WebSphere Application Server level.

    Jazz Team Server requires WebSphere Application Server Version 6.1 with the IBM Java SDK 1.5 SR5 or later Cumulative Fix applied or WebSphere Application Server Version 7.0 with at least 7.0.0.7 installed. The IBM Java SDK 1.5 SR6 SDK update is available from http://www-1.ibm.com/support/docview.wss?rs=180&uid=swg24017492. With WebSphere 6.1 and the GA IBM Java SDK, Jazz starts to report "proxy errors" after some number of operations.

    You must obtain the corresponding WebSphere Application Server i-fixes for fixes to IBM Java SDK 1.5 SR9 or IBM Java SDK 1.6 SR4 that are necessary for IBM Rational Team Concert™ 2.0 to run correctly. Otherwise, some services in the server might not start correctly. The i-fixes are available under their corresponding WebSphere Application Server APARs. For IBM Java SDK 1.5/WebSphere Application Server 6.1, the APAR is PK85942 and you can download the files from ftp://ftp.software.ibm.com/software/websphere/appserv/support/fixes/PK85942/. Install at least WebSphere Application Server 6.1 fixpack 19 before installing the JRE i-fix. For IBM Java SDK 1.6/WebSphere Application Server 7.0, the APAR is PK 86771 and you can download the files from ftp://ftp.software.ibm.com/software/websphere/appserv/support/fixes/PK86771/.

  3. Update the JVM arguments.

    The Jazz Team Server needs some specific settings on the Java Virtual Machine in which it is run.

    The first property that needs to be set in the Generic JVM arguments is the default maximum memory allocation, using the -Xmx setting. This should be set based on the size of the team supported by the server and the memory capacity of the server where Jazz Team Server is running. A typical medium-size team can use a value of -Xmx1536M, providing 1536 MB of heap memory for the Jazz Team Server process.

    A second property that needs to be set in the Generic JVM arguments, specifically for Rational® Quality Manager, is the thread stack size. A typical stack size for Rational Quality Manager is -Xss786K.

    If you are connecting to an Oracle or SQL Server database then you need to add a property named "ORACLE_JDBC" or "SQLSERVER_JDBC". Set the property to the absolute file path (not a URL) to the appropriate jdbc drivers.

    The following examples show the Generic JVM arguments for connecting to Oracle and SQL Server databases, along with the default maximum memory allocation and the thread stack size. Substitute JazzInstallDir with your Jazz Team Server installation directory.

    -DORACLE_JDBC=JazzInstallDir\server\oracle -Xmx1536M -Xss768k
    -DSQLSERVER_JDBC=JazzInstallDir\server\sqlserver -Xmx1536M -Xss768k

    There are several other system properties that need to be set to control certain server behaviors. They are included below. Here are the specifics of setting these JVM properties in the WebSphere Administrative Console. Substitute JazzInstallDir with your Jazz Team Server installation directory:

    1. Click on Servers > Application Servers.
    2. Click on server1.
    3. Click on Java and Process Management > Process Definition.
    4. Click on Java Virtual Machine.
    5. Add the value 100 to the Initial Heap.
    6. Add the value 1000 to the Maximum Heap Size.
    7. Click Apply.
    8. Click Logging and Tracing. Click Change Log Detail Levels. The Jazz Team Server uses the BIRT reporting engine. To prevent BIRT informational entries from being written to the WebSphere log file, set the logging level to severe for the org.eclipse.birt.* packages. Click Apply.
    9. Click Application servers > {server_name} > Process definition > Java Virtual Machine > Custom properties. One of the custom properties that you need to add is JAZZ_HOME, a system property that specifies where to find certain configuration files. This property uses a URL rather than a simple path, so the value should be specified as a file://-style URL.
    10. Add the following properties: Click New; enter the Name and Value; then click OK.
      • Name: java.awt.headless Value: true
      • Name: org.eclipse.emf.ecore.plugin.EcorePlugin.doNotLoadResourcesPlugin Value: true
      • Name: JAZZ_HOME Value: file:///JazzInstallDir/server/conf
    11. Click Save directly to the master configuration.
    Important: For Solaris only, you must also add the following Java command line argument:
    -XX:MaxPermSize=256m
    For additional information, see Chapter 2, "Configuring a Solaris environment for WebSphere Application Server" of the IBM WebSphere Application Server V6.1 on the Solaris 10 Operating System redbook.
  4. Restart Websphere to install the Jazz Application.
    In the following command line examples, WASInstallDir represents the location where WebSphere Application Server is installed on your server.
    • On Windows, the default value for WebSphere installation directory is:
      C:\Program Files\IBM\WebSphere\AppServer
      You can restart the server with the following commands on Windows:
      cd WASInstallDir\bin 
      stopServer.bat server1 [for a secure server, include: -username {LDAP_User} -password {LDAP_Password}] 
      startServer.bat server1
    • On Linux, the default value for WebSphere installation directory is:
      /opt/IBM/WebSphere/AppServer
      You can restart the server with the following commands on Linux:
      cd WASInstallDir/bin 
      ./stopServer.sh server1 [for a secure server, include: -username {LDAP_User} -password {LDAP_Password}] 
      ./startServer.sh server1
    1. Open the Admin console for your WebSphere Application Server.
    2. Click on Applications > Install New Application.
    3. Under Path to new Application, click Local file system.
    4. Under Full path enter:
      JazzInstallDir/server/jazz.war
    5. Set Context Root to /jazz.
    6. Click Next and continue through the remaining Install New Application steps.
    7. Click Finish.
    8. Click Save directly to the master configuration.
    9. Click on Applications > Enterprise Applications.
    10. Select the box next to jazz_war; click Start.

      A green arrow should appear indicating the application started successfully.

What to do next

After the server is started, proceed to Running the setup wizard.

For more information about this topic visit the following links:

http://jazz.net/library/techtip/95

https://jazz.net/wiki/bin/view/Main/WASSetupFAQ


Feedback

Did this help? You can provide feedback at Jazz.net (registration required): Comment in the forums or submit a bug