Deploying the Design Management Server on WebSphere Application Server

You can deploy the Design Management Server on WebSphere® Application Server instead of the Apache Tomcat server that comes with the server. The instructions are based on WebSphere Application Server version 8.0, with slight variations for version 7.0.

Before you begin

Important: There is the potential for security exposure when using WS-Security; this could result in a user gaining elevated privileges. This impacts applications using JAX-WS and JAX-RPC. For complete details on how to obtain and install this security patch, read this news flash. In addition, consider subscribing to WebSphere Application Server updates through My Notifications; therefore, you will receive security-related notices for updates and patches.
Fast path: If you installed Apache Tomcat in the setup wizard, no manual deployment steps are necessary. Proceed to Setting up and configuring the Design Management Server.
Ensure that your environment is set up correctly:

Procedure

  1. In the WebSphere Application Server administrative console, specify the following security settings:
    1. Turn off Java™ 2 security by clicking Security > Global security and clearing the Use Java 2 security to restrict application access to local resources check box.
    2. In the Current realm definition field, make sure that the proper security realm is configured and set as the current realm. Then, select the Enable administrative security and Enable application security check boxes.
    3. Click Security > Global security > Web and SIP security > General settings and select the Use available authentication data when an unprotected URI is accessed check box.
  2. Specify the Java virtual machine settings for WebSphere Application Server:
    1. In the administrative console, click Servers > Server Types > WebSphere application servers and then click your server. By default, the server is named server1.
    2. Under Server Infrastructure, click Java and Process Management > Process Definition.
    3. Under Additional Properties, click Java Virtual Machine.
    4. In the Initial heap size field, specify 4096.
    5. In the Maximum heap size field, specify the maximum memory for the server in MB. For 64-bit computers, specify an amount of memory that is appropriate to your environment, such as 4096 for 4GB of memory.
    6. In the Generic JVM arguments field, add -Xmx4g -Xms4g -Xmn512m -Xgcpolicy:gencon -Xcompressedrefs -Xgc:preferredHeapBase=0x100000000
    7. Click Apply.
    8. On the Java Virtual Machine page, under Additional Properties, click Custom Properties.
    9. Click New and specify the JAZZ_HOME property, which identifies the location of configuration files for the Design Management Server, including the jts and dm folders.
      This property uses a URI rather than a simple file path, and it always begins with file:///. The default location on a Windows system is as follows:
      file:///C:/PROGRA~1/IBM/JazzTeamServer/server/conf
      On a Linux system, the default location is as follows:
      file:///opt/ibm/JazzTeamServer/server/conf
      Note: To avoid problems, do not use spaces in file paths. For Program Files folders on 32-bit installations of Windows, you can use PROGRA~1, and for Program Files (x86) folders on 64-bit installations of Windows, you can use PROGRA~2.
    10. Click New again and specify a property named log4j.configuration. Use the location of the startup_log4j.properties file as the value. This property uses the same format as the JAZZ_HOME property. In most cases, this file is in the JAZZ_HOME folder. The default value on a Windows system is as follows:
      file:///C:/PROGRA~1/IBM/JazzTeamServer/server/conf/startup_log4j.properties
      The default value on a Linux system is as follows:
      file:///opt/ibm/JazzTeamServer/server/conf/startup_log4j.properties
      Note: The settings in startup_log4j.properties are used at the early stages in the startup process to pass messages to the SystemOut.log file. After the early stages, each application switches to using the application-specific settings from the server/conf/<app_context>/log4j.properties file.
    11. Click New again and specify a property named java.awt.headless with the value true.
    12. Click New again and specify a property named org.eclipse.emf.ecore.plugin.EcorePlugin.doNotLoadResourcesPlugin with the value true.
    13. If you are using a SQL Server database, click New again and specify a property named SQLSERVER_JDBC_DRIVER_FILE with the location of the file sqljdbc4.jar.
    14. If you are using an Oracle database, click New again and specify a property named ORACLE_JDBC_DRIVER_FILE with the location of the file ojdbc5.jar.
    The custom properties look similar to the following figure. Note that some properties are present by default in addition to the properties that you add.
    An example of the properties for the Java virtual machine
  3. Save the changes to the master configuration and restart WebSphere Application Server.
    Now the server is ready to deploy the Design Management Server application files.
    Note: On a UNIX or Linux system, if WebSphere Application Server is installed in a non-root environment, the user who installs the Design Management Server must have read and write access to the installation directory and all its subdirectories.
  4. Install the Jazz Team Server application:
    1. In the administrative console, click Applications > New Application > New Enterprise Application.
    2. Under Path to the new application, click Browse to specify the location of the jts.war file and click Next. If you did not install Apache Tomcat when you installed Design Management Server, the default location of this file is installDir/server/webapps. If you installed Tomcat, the default location is installDir/server/tomcat/webapps.
    3. Under How do you want to install the application?, click Fast Path and then click Next.
    4. On the Step 1: Select installation options page, accept the default options and click Next.
    5. On the Step 2: Map modules to servers page, select the check box beside jts.war, ensure that the target server or cluster is correct, and click Next.
    6. On the Step 3: Map virtual hosts for web modules page, select the check box beside jts.war, and click Next.
    7. On the Step 4: Map context roots for Web modules page, set Context Root to /jts and click Next.
    8. Click Finish.
  5. Repeat the installation steps for the following war files and corresponding context roots:.
    Option Description
    dm.war /dm
    admin.war /admin
    vvc.war /vvc
    rdmhelp.war /rdmhelp
    clmhelp.war /clmhelp
    rsadm.war /rsadm
    vvchelp.war /vvchelp
  6. Map the security roles for the Jazz Team Server application to users and groups in your security realm. Setting up security is beyond the scope of this task, but in most cases in which your global security realm uses an LDAP registry, you map groups in the LDAP registry to the following security roles for the application:
    • JazzAdmins
    • JazzDWAdmins
    • JazzProjectAdmins
    • JazzGuests
    • JazzUsers
    1. Click Applications > Application Types > WebSphere Enterprise Applications > jts_war.
    2. Under Detail Properties, click Security role to user/group mapping. This page shows the user groups for the Design Management Server that you must map to users or groups in your security realm.
    3. Select a role and then click Map Groups to map that role to a group in your security realm.
      Note: Do not enable the All authenticated? option.
  7. Verify that the applications installed successfully and then save the changes to the master configuration for WebSphere Application Server.
  8. Add the following session management custom property to avoid SESN0008E error message when a user logs out without terminating the session:
    1. In WebSphere Integrated Solutions Console, clickServers > Server Types > WebSphere application servers.
    2. Click server1 and then in the Container Settings section, click Session management.
    3. In the Additional Properties section, click Custom properties.
    4. Click New and enter the following information: Name: InvalidateOnUnauthorizedSessionRequestException Value: true
    5. Click Apply and save directly to the master configuration.
  9. After saving to the master configuration, stop and restart the server.
  10. In the WebSphere Application Server administrative console, click Applications > Application Types > WebSphere Enterprise Applications to confirm all applications are running.

Results

Green arrows appear beside the applications to indicate that they started correctly.

What to do next

Now you can configure the Design Management Server as described in Setting up and configuring the Design Management Server.

Feedback