Working with Rhapsody Design Management 6.0.6.1 in Engineering Lifecycle Management 7.x environment

Andrey Karaulov, Persistent Systems
Last updated: March 4, 2020
Build basis: Rhapsody Model Manager 6.0.6.1

Background

Rhapsody Design Manager 6.0.6.1 is the last version made generally available. Although there are no plans to release new versions of this application, defects found in already released versions are being fixed and delivered to customers through interim fixes. Thus, it is possible to use Rhapsody DM 6.0.6.1 even if all the other ELM applications are migrated to the 7.x version. However, the applying of the interim or test fixes has some limitations.

To apply an interim or a test fix, one has to place the corresponding ZIP file into the server/patch folder that is located under the installation folder, and then restart the application server. The patch service, which is part of any ELM application, checks the content of the server/patch folder and processes the ZIP file found there. However, this service cannot distinguish if the patch file is compatible with the installed versions of ELM applications; it’s the responsibility of a server administrator to ensure the compatibility of applied fixes. For example, if the patch file, which is compatible with an older application version (such as 6.0.6.1), is placed into the patch folder of a newer application version (such as 7.0), it is very likely that the neither patch will be applied or that the application will not behave as expected.

Therefore, Rhapsody Design Manager version 6.0.6.1 must be moved into a separate installation folder if it is installed into a folder containing other ELM applications that are planned to be migrated to 7.0 or a newer version. Other than this, no actions are needed.

The other point that should be taken into account if there is a plan to use Rhapsody DM 6.0.6.1 together with ELM applications version 7.x are the license keys. Once ELM applications are migrated to 7.0 or a newer versions, the corresponding license keys must be updated. In order to be able to manipulate OSLC links from Rhapsody DM application, the license keys for Rhapsody DM must be updated as well. See the corresponding section below for more details.

System and Software requirements

The system and software requirements for ELM products may change for each release of ELM, and Rhapsody DM 6.0.6.1 may not work with certain software that is compatible with that version of ELM.

For example, ELM 7.0.1 can be used with version 19c as well as version 12c of Oracle database, but Rhapsody DM 6.0.6.1 cannot be used with Oracle versions higher than 12c.

To avoid any problems, it is essential that you check the system and software requirements for the version of ELM that you want to upgrade to, and compare these with the requirements for Rhapsody DM 6.0.6.1, before you upgrade ELM applications to the newer version.

For a complete list of the requirements for a specific version of ELM (and for Rhapsody DM 6.0.6.1), see the “System requirements” section of the deployment wiki on jazz.net.

Move the Rhapsody DM application to a new location

Examples

Examples in this article are for moving Rhapsody DM (RDM) application to a new location.
In the following examples, the installation folder corresponding to the existing RDM 6.0.6.1 is refer to as old_install_dir, and the new RDM 6.0.6.1 that you will be installing for server rename is referred to as new_install_dir.
The code snippet examples are for UNIX platforms.

This topic is for an installation topology without the use of a reverse proxy. If you are using a reverse proxy in your deployment, see the following resources:

In order to perform a server rename procedure, you must install a separate RDM application along with your old RDM installation. There are two options for installing the RDM application:

Install the RDM application on the same server as the old application: In this case, you must change the port number during the rename process. For details, see Changing the port numbers for the application server.
Install the RDM application on a different server from the old application: In this case, you must change the fully qualified hostname during the rename process.

This section is divided into two subsections:

WebSphere Application Server Liberty Profile
WebSphere Application Server

WebSphere Application Server Liberty Profile

About this task

The following procedure is for the WebSphere Liberty basic registry to manage users. For LDAP, see Configuring an LDAP or an LDAP/SDBM connection.

Procedure

Install RDM 6.0.6.1 (the same version as the existing RDM installation) into a new folder (new_install_dir). Make sure to select Install with WAS Liberty Profile.
Prepare a mapping file for the server rename procedure:
1. Ensure the existing server is up and running.
2. Open a command window and enter the following commands:
```
cd old_install_dir/server
./repotools-jts.sh -generateURLMappings toFile=MAPPINGS.TXT adminUserId=adminUserId adminPassword=adminPassword repositoryURL=https://hostname:port/jts
```
3. Update the generated MAPPINGS.TXT file: Comment out or remove the source and target lines for applications that should not be renamed and keep only one pair related to the RDM application:
```
source=https://hostname:old_https_port/dm
target=https://hostname:new_https_port/dm
```
  NOTE:
  new_https_port is a random port number that should manually be changed since it is not automatically added to the generated mapping file.

Verify the MAPPINGS.TXT file by entering the following command:

./repotools-jts.sh -verifyURLMappings mappingFile=MAPPINGS.TXT adminUserId=adminUserId adminPassword=adminPassword repositoryURL=https://hostname:old_https_port/jts

If the Lifecycle Query Engine or Link Index Provider are installed, make sure that you completed the Preparing for server rename procedure mentioned in Impact of server rename on Lifecycle Query Engine and the Link Index Provider.
If the Data Collection Component is installed, make sure you performed all required actions described in Impact of server rename on the Data Collection Component.
Go to old_install_dir/server and stop the server.
Back up the existing source environment.
Go to new_install_dir/server and enter the following command to create folders used by the WebSphere Liberty server.
```
./repotools_dm -help
```
This command creates the new_install_dir/server/liberty/servers/clm folder.

Copy the RDM application indices and configuration files into the new_install_dir folder:

cp -R old_install_dir/server/conf/dm/indices new_install_dir/server/conf/dm/indices
cp old_install_dir/server/conf/dm/teamserver*.properties new_install_dir/server/conf/dm/
cp old_install_dir/server/conf/dm/rhapsody.properties new_install_dir/server/conf/dm/rhapsody.properties

For Apache Derby database only: Copy the Apache Derby database:
First, enter the following command to delete the new_install_dir Apache Derby database:
```
rm -rf new_install_dir/server/conf/dm/derby/repositoryDB
```
Then, enter the following command to copy the Apache Derby database:
```
cp -R old_install_dir/server/conf/dm/derby/repositoryDB new_install_dir/server/conf/dm/derby/repositoryDB
```

Copy the WebSphere Liberty basicUserRegistry.xml file:

cp old_install_dir/server/liberty/servers/clm/conf/basicUserRegistry.xml new_install_dir/server/liberty/servers/clm/conf

Copy the lpta.keys file:

First, make a backup and delete the lpta.keys file from the new_install_dir server.

rm new_install_dir/server/liberty/servers/clm/resources/security/ltpa.keys

Then copy the lpta.keys file to the new server:

cp old_install_dir/server/liberty/servers/clm/resources/security/ltpa.keys new_install_dir/server/liberty/servers/clm/resources/security

Go to the new_install_dir/server/liberty/servers/clm folder and open the server.xml file for editing.

Modify the HTTP and HTTPS ports:

<httpEndpoint id="defaultHttpEndpoint"
host="*"
httpPort="<new_http_port>"
httpsPort="<new_https_port>" />

NOTE:
<new_http_port> is a random port number for HTTP protocol.

Uninstall the RDM application form the old_install_dir. Ensure that dm.war and dm.war.zip files are deleted from the following folders:
```
old_install_dir/server/liberty/servers/clm/apps
old_install_dir/server/liberty/clmServerTemplate/apps
```
Go to the old_install_dir/server folder and create a file called serverConf.txt with the following content:
```
# Rhapsody DM
new_install_dir/server/conf
```
Copy the ImportUMLMappings.activate file to the old_install_dir/server/conf folder.
If the Lifecycle Query Engine or Link Index Provider are installed, make sure that you completed the During server rename procedure mentioned in Impact of server rename on Lifecycle Query Engine and the Link Index Provider.

Open a command window and enter the following commands:

cd old_install_dir/server
./repotools-jts.sh -importURLMappings fromFile=MAPPINGS.TXT serverConfFile=serverConf.txt

Verify that the rename is successful by checking the console output and the jazz_install_dir/server/repotools-jts_importURLMappings.log file.

Start both servers:

cd old_install_dir/server
./server.startupCopy
cd new_install_dir/server
./server.startup

Log in to Jazz™ Team Server and open the following URL in a browser:
```
https://hostname:old_https_port/jts/serverRenameStatus
```
Verify that the rename process completed successfully by going through all the RDM project areas that are in read only mode. Check that all application friend URLs are correct.
After verifying everything, select the checkbox to remove the read only mode and complete the rename process.
If the Lifecycle Query Engine and the Link Index Provider are installed, complete the After server rename procedure mentioned in Impact of server rename on Lifecycle Query Engine and the Link Index Provider
If the Data Collection Component is installed, make sure you performed all required actions described in Impact of server rename on the Data Collection Component.

WebSphere Application Server

About this task

The following scenario is for the installation of multiple applications installed into different Installation Manager groups on different servers.

Server 1: JTS, CCM, RDM
Server 2: DCC
Server 3: LQE

The goal is to move the RDM application from Server 1 into a new Server 4 and keep all other applications on the same servers as before.

Procedure

Install RDM 6.0.6.1 (the same version as the existing RDM installation) on Server 4.
Install and configure WebSphere Application Server on server 4.
Prepare a mapping file for the server rename procedure:
1. Ensure the existing server is up and running.
2. Open a command window and enter the following commands:
```
cd old_install_dir/server
./repotools-jts.sh -generateURLMappings toFile=MAPPINGS.TXT adminUserId=adminUserId adminPassword=adminPassword repositoryURL=https://hostname:port/jts
```
3. Update the generated MAPPINGS.TXT file: Comment out or remove the source and target lines for applications that should not be renamed and keep only one pair related to the RDM application:
```
source=https://old_hostname:port/dm
target=https://new_hostname:port/dm
```
  NOTE:
  new_hostname corresponds to the host name of Server 4.

Verify the MAPPINGS.TXT file by entering the following command:

./repotools-jts.sh -verifyURLMappings mappingFile=MAPPINGS.TXT adminUserId=adminUserId adminPassword=adminPassword repositoryURL=https://old_hostname:port/jts

If the Lifecycle Query Engine or Link Index Provider are installed, make sure that you completed the Preparing for server rename procedure mentioned in Impact of server rename on Lifecycle Query Engine and the Link Index Provider.
If the Data Collection Component is installed, make sure you performed all required actions described in Impact of server rename on the Data Collection Component.
Log in to WebSphere Application Server on server 1 and undeploy the am.war application.
Stop WebSphere Application Server on servers 1, 2, and 3.
Back up the existing source environment.

Copy the RDM application indices and configuration files into the new_install_dir folder:

cp -R old_install_dir/server/conf/dm/indices new_install_dir/server/conf/dm/indices
cp old_install_dir/server/conf/dm/teamserver*.properties new_install_dir/server/conf/dm/
cp old_install_dir/server/conf/dm/rhapsody.properties new_install_dir/server/conf/dm/rhapsody.properties

For Apache Derby database only: Copy the Apache Derby database:
First, enter the following command to delete the new_install_dir Apache Derby database:
```
rm -rf new_install_dir/server/conf/dm/derby/repositoryDB
```
Then, enter the following command to copy the Apache Derby database:
```
cp -R old_install_dir/server/conf/dm/derby/repositoryDB new_install_dir/server/conf/dm/derby/repositoryDB
```
Copy ImportUMLMappings.activate file to old_install_dir/server/conf folder.
For the Lifecycle Query Engine and the Link Index Provider, make sure that you completed the During server rename procedure mentioned in Impact of server rename on Lifecycle Query Engine and the Link Index Provider.
If you can map the network drives from the Jazz Team Server host, follow these steps:
1. Map a network drive from the Jazz Team Server host to each of the application hosts.
2. Go to the old_install_dir/server folder and create a file called serverConf.txt that contains a list of remote server/conf directories. For example:
```
#Remote DCC
D:/JazzTeamServer/server/conf
#Remote RDM
R:/JazzTeamServer/server/conf
```
3. Open a command window and enter the following command:
```
./repotools-jts.sh -importURLMappings fromFile=MAPPINGS.TXT serverConfFile=serverConf.txt
```
If you cannot map the network drives from the Jazz Team Server host, follow these steps:
1. Open a command window and enter the following command:
```
./repotools-jts.sh -importURLMappings fromFile=MAPPINGS.TXT
```
2. Copy the server/conf/jts/.mappingEvent file to the remote applications configuration directories that participated in server rename.
  NOTE:
  The event file is generated when you import the mappings. You must copy the .mappingEvent file after you import the mapping file but before you start the server.
Verify that the rename is successful by checking the console output and the jazz_install_dir/server/repotools-jts_importURLMappings.log file.
Start WebSphere Application Server on servers 1, 2, 3 and 4.
Log in to Jazz™ Team Server and open the following URL in a browser:
```
https://old_hostname:port/jts/serverRenameStatus
```
Verify that the rename process completed successfully by going through all the RDM project areas that are in read only mode. Check that all application friend URLs are correct.
After verifying everything, select the checkbox to remove the read only mode and complete the rename process.
For the Lifecycle Query Engine and the Link Index Provider, complete the After server rename procedure mentioned in Impact of server rename on Lifecycle Query Engine and the Link Index Provider
For Data Collection Component make sure you performed all required actions described in Impact of server rename on the Data Collection Component.

For more information

Changing the public URL by using server rename

Update the Rhapsody DM license keys

Passport Advantage cannot be used to get updated RDM 6.0 license keys. They are only available via the IBM License Key Center.
Once updated license keys are generated and downloaded, they must be be updated on the JTS server side.

Unzip the downloaded file.
Go to the 7.x JTS server and open the License Key Management page.
Click “Add…” and select the jar file unzipped previously.
Accept the license agreement and click the Finish button.

Users that had been assigned the previous 6.0 Design Manager License still have that license assigned to them.

About the author

Dashboards and work items are no longer publicly available, so some links may be invalid. We now provide similar information through other means. Learn more here.

Feedback

Was this information helpful?

Yes

No 1 person rated this as helpful.