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 or later, 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.
Ensure that your environment
is set up correctly:
- WebSphere Application Server is
installed.
Jazz™ Team Server,
which provides the foundation for Design
Management Server,
requires WebSphere Application Server Version
8.0 or later, or WebSphere Application Server Version
7.0.
- If you are using a database other than Apache Derby, the database
is set up as described in Setting up the database.
- The Design
Management Server is
installed as described in Installing Design Management, client extensions and engines.
About this task
If you are using a departmental or enterprise topology, you
will need to configure the Websphere Application Server for each server
and application running on that machine.
Procedure
- In the WebSphere Application Server administrative
console, specify the following security settings:
- Confirm that Java™ 2
security is turned off by clicking and clearing
the Use Java 2 security to restrict application access
to local resources check box.
- 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.
- Click and under Authentication,
click and select the Use
available authentication data when an unprotected URI is accessed check
box.
- Specify the Java virtual
machine settings for WebSphere Application Server:
- In the administrative console, click and
then click your server. By default, the server is named server1.
- Under Server Infrastructure,
click .
- Under Additional Properties,
click Java Virtual Machine.
- In the Initial heap size field,
specify 4096. The
figures used for heap sizes and JVM arguments are 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 Jazz Team Server process on a 64-bit computer with a minimum of
8 GB of physical memory. It is important to use the same amount for
Initial and Maximum heap sizes. When increasing 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. It is also 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.
- 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.
- In the Generic JVM arguments field,
add the following:
| Operation system |
user input |
| Windows |
-Xmx4g -Xms4g -Xmn512m -Xgcpolicy:gencon -Xcompressedrefs
-Xgc:preferredHeapBase=0x100000000 -XX:MaxDirectMemorySize=1G |
| Linux |
-Xmx4g -Xms4g -Xmn512m -Xgcpolicy:gencon -Xcompressedrefs
-Xgc:preferredHeapBase=0x100000000 -XX:MaxDirectMemorySize=1G |
| AIX |
-Xmx4g -Xms4g -Xmn512m -Xgcpolicy:gencon -Xnocompressedrefs
-XX:MaxDirectMemorySize=1G |
Tip: 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
-XX:MaxDirectMemorySize=1G
- Click Apply.
- On the Java Virtual Machine page,
under Additional Properties, click Custom
Properties.
- 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.
- 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.
- Click New again and specify a
property named java.awt.headless with the value true.
- Click New again and specify a
property named org.eclipse.emf.ecore.plugin.EcorePlugin.doNotLoadResourcesPlugin with
the value true.
- 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.
- 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.
- 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.
- Install the Jazz Team Server application:
- In the administrative console, click .
- 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.
- Under How do you want to install the application?,
click Fast Path and then click Next.
- On the Step 1: Select installation options page,
accept the default options and click Next.
- On the Step 2: Map modules to servers page,
select the check box beside <app>.war where <app> is
the name of the application you are installing, ensure that the target
server or cluster is correct, and click Next.
- On the Step 3: Map virtual hosts for web modules page,
select the check box beside <app>.war, and
click Next.
- On the Step 4: Map context roots for Web modules page,
set Context Root to /<app> where <app> is
the applications context root. For example if installing dm.war,
the context root can be dm and click Next.
- Click Finish.
- Depending the applications you are installing on the server,
repeat the installation steps for the following war files and corresponding
context roots:
| Option |
Description |
| dm.war (Design Management application) |
/dm |
| admin.war (Jazz Team Server application) |
/admin |
| vvc.war (Design Management application) |
/vvc |
| rdmhelp.war (Design Management application) |
/rdmhelp |
| clmhelp.war (Jazz Team Server application) |
/clmhelp |
| rsadm.war (Design Management application) |
/rsadm |
| vvchelp.war (Configuration Management application) |
/vvchelp |
| jts.war (Jazz Team Server application) |
/jts |
- On the server containing the Jazz Team
Server (jts.war), you will need to map security roles on the Websphere
application server. 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
- Click .
- 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.
- 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.
- Verify that the applications installed
successfully and then save the changes to the master configuration
for WebSphere Application Server.
- Add the following session management custom property to
avoid SESN0008E error message when a user logs out without terminating
the session:
- In WebSphere Integrated Solutions Console, click .
- Click server1 and then in the Container
Settings section, click Session management.
- In the Additional Properties section, click Custom
properties.
- Click New and enter the following information: Name: InvalidateOnUnauthorizedSessionRequestException Value: true
- Click Apply and save directly
to the master configuration.
- After saving to the master configuration, stop and restart
the server.
- In the WebSphere Application Server administrative
console, click 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.