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 beginning these steps, you should have the following completed:
  • WebSphere Application server is already installed.
  • The database is created and the teamserver.properties file is updated with your database settings.
  • Refer to your WebSphere documentation for security setup and turn off the case-insensitive property.
    Note: Although Websphere and many LDAP directories allow you to log in case-insensitive, Jazz Team Server stores user records with user IDs in exact case as they are imported. When you log in to the Jazz Team Server, the user record is retrieved from the list of users and the case must match exactly.
  • Java™ 2 Security option should be turned off. If this option is turned on in WebSphere Application Server it will cause the Jazz Team Server .war to fail to start.
  • The Jazz Team Server includes the files required to run a complete Apache Tomcat-based server. For a WebSphere installation you only need a subset of the Jazz Team Server files and you should place them in a directory on your WebSphere server machine. Further instructions refer to this as the Jazz Team Server installation directory, or JazzInstallDir for short. From this directory, use:
    • The file JazzInstallDir/server/teamserver.properties.
    • The file JazzInstallDir/server/log4j.properties. If you use a Websphere Application Server, in this file you can change the path for the jazz.log file, which only logs messages from the Jazz Team Server. The default path is tomcat/logs/jazz.log.
    • The file JazzInstallDir/server/tomcat/webapps/jazz.war.
    • The directory JazzInstallDir/server/provision_profiles.
    • The directory JazzInstallDir/server/update-site.
    • The default repository database in JazzInstallDir/repositoryDB.
    • The repository tools in JazzInstallDir/repotools.
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.

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.
  1. Modify the profile.ini and license-profile.ini files:

    Edit each of profiles in JazzInstallDir/server/provision_profiles/ and set an absolute path for the URL property.

    For example,
    • Change this line:
      url=file:./update-site
    • To something like this:
      url=file:/opt/IBM/JazzTeamServer/server/update-site
    Note: The directory JazzInstallDir/server/provision_profiles/ must only contain the .ini files included and must not contain any backup files. Some editors automatically save a backup file which must be removed.
  2. 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:fullyMaterializeLobData=false;user=db2admin;password={password};
    com.ibm.team.repository.db.jdbc.password=db2admin
  3. 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. 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.

  4. Update the JVM arguments.

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

    First, it needs to know where to find the configuration files for the server and for log4j, the logging framework used by the server. This is done by setting the system properties com.ibm.team.server.configURL and log4j.configuration. These properties use a URL rather than a simple path, so the value should be specified as a file://-style URL.

    The second property which is required for the Jazz JVM is to provide it with more than 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 -Xmx1000M, providing 1000 MB of heap memory for the Jazz Team Server process.

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

    There are a couple other system properties which need to be set to control some behavior of the server, 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 Custom Properties
    10. Add the following properties: Click New; enter the Name and Value; then click OK.
      • Name: com.ibm.team.repository.provision.profile Value: file:///JazzInstallDir/server/provision_profiles (as file URL)
        Note: The property com.ibm.team.repository.provision.profile needs to point to the directory containing the provision_profiles.
      • Name: com.ibm.team.server.configURL Value: file:///JazzInstallDir/server/teamserver.properties (as file URL)
      • Name: log4j.configuration Value: file:///JazzInstallDir/server/log4j.properties (as file URL)
      • Name: java.awt.headless Value: true
      • Name: org.eclipse.emf.ecore.plugin.EcorePlugin.doNotLoadResourcesPlugin Value: true
    11. Click Save directly to the master configuration.
  5. 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.

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

Feedback

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