You can use the repotools command-line tool to back up
and restore CLM servers.
About this task
Note: Starting
in version 6.0.1, Apache Tomcat is not provided as a default application
server. However, Apache Tomcat is supported and you can use it. The
following examples show Apache Tomcat installed in this location: JazzInstallDir/server/tomcat.
If your version is in another location, change the installation path.
- Back up the Jazz Foundation Service indexes and work item
indexes:
- To back up the resource description framework (RDF),
text indices, and work item indices, run the -backupJFSIndexes repository
tools command. For more information, see Repository tools command to back up
Jazz Foundation Service indexes.
- For WebSphere Liberty, create a full copy of the Liberty installation directory. The
application configuration files are in these folders:
JazzInstallDir/server/liberty/servers/clm/
JazzInstallDir/server/liberty/servers/clm/conf/
Some of the files inside these folders are modified during the setup process and during
operation, and should be included in the backup procedure. The following files are typically
modified during the setup:
JazzInstallDir/server/liberty/servers/clm/server.xml
JazzInstallDir/server/liberty/servers/clm/conf/ldapUserRegistry.xml
JazzInstallDir/server/liberty/servers/clm/conf/application.xml
If you are using the built-in local user authentication, also back up the user registry file:
JazzInstallDir/server/liberty/servers/clm/conf/basicUserRegistry.xml
If you provide a server certificate, include it in your backup. You can find information about
the storage location of your certificate in the server.xml file. The element
"keyStore" contains a location property that provides the file location. If this shows a file
or a relative path, the default location for the file is:
JazzInstallDir/server/liberty/servers/clm/conf/resources/security/
- For Tomcat, create a full copy of the directory with the
Tomcat server, web applications, and configuration files. By default,
this is located at JazzInstallDir/server/tomcat. If you do not want to copy every file, here are the critical
directories or files:
- JazzInstallDir/server/tomcat/conf
- JazzInstallDir/server/tomcat/bin
- (if it exists) JazzInstallDir/server/tomcat/webapps/ccm/WEB-INF/web.xml
- (if it exists) JazzInstallDir/server/tomcat/webapps/clmhelp/WEB-INF/web.xml
- (if it exists) JazzInstallDir/server/tomcat/webapps/converter/WEB-INF/web.xml
- (if it exists) JazzInstallDir/server/tomcat/webapps/jazz/WEB-INF/web.xml
- (if it exists) JazzInstallDir/server/tomcat/webapps/jts/WEB-INF/web.xml
- (if it exists) JazzInstallDir/server/tomcat/webapps/qm/WEB-INF/web.xml
- (if it exists) JazzInstallDir/server/tomcat/webapps/rm/WEB-INF/web.xml
- For WebSphere Application Server, run the backupConfig script
for WebSphere Application Server. This script is located in the websphere_install_directory/bin
directory. Because security is enabled for your server, run the script
with the -user administrator_username and -password administrator_password options
with the user name and password of the server administrator. By default,
running the script creates a .zip file of your WebSphere configuration
in the websphere_install_directory/bin
directory.
For more information about the backupConfig script,
see the WebSphere Application Server documentation.
- Back up the repository information from the database.
- Back up the configuration directories: JazzInstallDir/server/conf/app
- To restore the server from a backup:
- Restore the configuration directory from your backup to JazzInstallDir/server/conf/app.
- Restore the Jazz Foundation Service index files from
the .zip file by using the -restoreJFSIndexes repository
tools command.
- Restore the server configuration files.
- For WebSphere, run the restoreConfig script,
specifying the backup configuration file that you made. For more information
about the restoreConfig command, see the WebSphere Application Server documentation.
- For Tomcat, if you had to download a new set of server and application
files, start the Tomcat server to extract the .war web
application files in the JazzInstallDir/server/tomcat/webapps directory
before you restore the various WEB-INF/web.xml files.
- Restore the database.
