Back up Oracle databases with the IBM Rational repotools utility

Using the Repository Tools utility from Collaborative Design Management applications

You can back up and restore an Oracle database by using the Repository Tools utility, known as repotools, that is included with the IBM Rational Software Architect Design Manager. The article presents a scenario in which a user backs up the Oracle database, uninstalls and then reinstalls Design Manager, restores, configures, and deploys Design Manager on WebSphere Application Server, and then restores the database.

Paul J. Vellan (pvellan@ca.ibm.com), Software Verification Developer, IBM

author photoPaul Vellan joined the IBM Rational team in December 2000. He has run both system and functional verification test levels, as well as all aspects IBM Rational modeling tools, including Rational Rose, Rational Rose RealTime, and Rational Software Architect. He has also performed integration testing with other IBM products, including IBM WebSphere Business Modeler, IBM Rational ClearCase, IBM Rational ClearQuest, and IBM RequisitePro, and has worked on automation using IBM Rational Functional Tester, creating automation scripts that are used for testing feature areas of IBM Rational Software Architect. He recently joined the Design Manager Performance Test Team, where he conducts performance tests of both the web client and the IBM Rational Software Architect Design Manager extension. Using IBM Rational Performance Tester, his team creates and runs scripts for benchmark testing of releases.



24 April 2012

Also available in Russian

Prerequisites

This article provides a workflow for using the Repository Tools (repotools) that is available in IBM® Rational® Collaborative Design Management applications to back up and restore an Oracle database. The Design Management Software Verification Test (SVT) team uses this process to prepare for benchmark testing, so they can ensure that the data is consistent between testing cycles.

You need the following to do the backup:

  • Knowledge of Design Manager installation and configuration process
  • Knowledge of IBM® WebSphere® Application Server
  • Knowledge of Oracle databases
  • Administrator rights to the applications and the computers where the applications are installed

Note:
The workflow provided here runs on Microsoft Windows 2008R2 Server 64-bit computers, and all paths and commands are for a Windows operating system.


Repotools overview

The Repository Tools (repotools) application provides a way to manage an IBM® Rational® Jazz™ repository database. It was originally intended for migrating databases, but you can also use this tool to back up and restore any of the databases defined in the IBM® Rational® Design Management teamserver.properties file.

For more information about repotools commands, see the link to the Rational Application Developer Information Center, cited in the Resources section.

You will use the following applications in this process:

  • IBM Rational Design Manager Version 3.0.1
  • IBM® WebSphere® Application Server Version 7.0.0.19
  • Oracle 11g database

Steps that this article covers

This article covers the following steps:

  1. Stopping the WebSphere Application Server, backing up the server directory in the Design Management directory
  2. Running repotools to export the Oracle databases
  3. Uninstalling the existing Design Management server and server extension, and then cleaning up all directories
  4. Uninstalling the .war files on the WebSphere Application Server, and cleaning up all directories
  5. Deleting the Oracle databases and creating new databases
  6. Installing the newer version of Design Manager and restoring the server directory
  7. Running repotools to restore the Oracle databases
  8. Configuring and deploying Design Manager on the WebSphere Application Server (not covered in detail)
  9. Running repotools to reindex the databases
  10. Running the provision command for Design Manager installed on the WebSphere Application Server
  11. Requesting a server restart

Backing up directories and databases

  1. Stop the IBM WebSphere Application Server that the Design Manager installation is running on.
  2. On the IBM WebSphere host computer, click Start > All Programs > IBM WebSphere > Application Server > Profiles > AppSrv01 > Stop the Server. (See Figure 1.)
Figure 1. Stopping the WebSphere Application Server
Start and Stop options, Stop selected
  1. Copy the entire server directory in the Design Management directory to a temporary location.
  2. Using the command prompt, go to the /IBM/DesignManagement/server directory and enter the following command: 2
    repotools-jts.bat –export tofile=C:\temp\dbexport.tar

Note:
This process can take from several minutes up to several hours, depending on the size of the Oracle database that you are backing up.

Uninstall Design Manager and clean up the WebSphere Application Server

  1. Start IBM Installation Manager, and uninstall Design Management Server and IBM Rational Software Architect Design Manager Server Extension.
  2. Browse to the installed directory and delete the DesignManagement folder.
  3. Delete the .war files on the WebSphere Application Server.
  4. Start the WebSphere Application Server. (See Figure 1.)
  5. After the server starts, open the administrative console and log in as the administrator.
  6. Under Welcome, select Applications > Application Types > WebSphere Enterprise Applications.
  7. From the list of applications, select the following variable names:
    • dm_war
    • jts_war
    • rdmhelp_war
  8. Click Stop.

Important:
If a red X appears beside the file names in the Application Status column, select the three applications again, and click Uninstall. (See Figure 2.)

Figure 2. Uninstalling the .war files from the application server
Three .war files selected to uninstall
  1. After the applications are deleted, click Save and log out of the Administrative console.
  2. Stop the WebSphere Application server. (See Figure 1)
  3. Delete the _war directories in the application server directory:
    1. Using Windows Explorer, browse to the following directory:
      C:\Program Files\IBM\WebSphere\AppServer\profiles\AppSrv01\temp\<hostname> Node01\server1
    2. Locate and delete the following three directories that are shown in Figure 3:
      • dm_war
      • jts_war,
      • rdmhelp_war
Figure 3. Deleting the _war directories
Location of dm_war directory on the server

Delete the Oracle databases

After you uninstall the .war files from the application server, you must delete an old database and create a new one. During this step, you need access to the database host computer.

  1. On the computer that hosts the Oracle databases, start the Oracle Database Configuration Assistant.
  2. On the Welcome screen, click Next, and then click Delete a Database.
  3. Select the database to delete.
  4. Repeat this process for the second database. (See Figure 4.)
Figure 4. Delete Oracle databases
Option to delete databases in Oracle DB wizard
  1. Create two new databases:
    1. Launch the Oracle Database Configuration Assistant again, select Create a Database, and click Next.
    2. Select the General Purpose or Transaction Processing template, and click Next.
    3. Enter the new global database name and SID name. Both names must be identical to the first database that you deleted.
    4. Click Next. (See Figure 5.)
Figure 5. Enter a database name
Option to create Database in Oracle DB Wizard
  1. For the database credentials (Screen should read Step 5 of 12 in title bar), select Use the Same Administrative Password for All Accounts, and provide the same password as the original database.(See Figure 6. below)
Figure 6. Database credentials
Option to set Password when creating a Database
  1. Click Next four more times until you advance to the Initialization Parameters page (The Screen should read Step 9 of 11 in the title bar, as Figure 7 shows.)
  2. On the Initialization Parameters page, click the Memory tab, set the memory to about 20% (based on a 64-bit computer with 16 GB of RAM).
  3. On the Sizing tab, set the processes to 300.
  4. On the Character Sets tab, review the list of character sets, and select UTF8 Universal Character Set. Then set the national character set to UTF8. (See Figure 7.)
  5. Click Finish.
Figure 7. Setting the UTF8 character set
UTF8 character settings for the databases

Create the Oracle database table spaces

  1. Log in to the first database that you created by selecting Start > All Programs > Oracle-Oardb11g_home1 > Database-Control <database name>
  2. On the login screen, log in as SYS and connect as SYSDBA, and then click Login.
  3. Under the Server tab, click Storage > Tablespaces, and then click Create.
  4. Enter the same name for the table space that you originally had (usually the same as the database name, with a suffix of _tbs). For example: DM40M5_tbs
  5. Click Use bigfile tablespace, and then click Add. (See Figure 8.)
Figure 8. Create a table space
Create Tablespace view, Name field
  1. On the Add Datafile page, add the file name in this format: dbname_tbs.dbf
    For example:
    DM40M5_tbs.dbf
  2. Add the file directory path.
    For example:
    C:\oracle_tbs
  3. Change the file size to 1GB.
  4. Click Automatically extend datafile when full (AUTOEXTEND), and set it to 100 KB increment. (See Figure 9.)
Figure 9. Table space size settings
Size setting and location for Tablespace names
  1. Click Continue.
  2. Click ShowSQL; your screen should look like the following example:
    CREATE BIGFILE TABLESPACE "DM30DB1_TBS" DATAFILE 'C:\oracle_tbs\DM30DB1_tbs.dbf' SIZE 1G AUTOEXTEND ON NEXT 100K MAXSIZE UNLIMITED LOGGING EXTENT MANAGEMENT LOCAL SEGMENT SPACE MANAGEMENT AUTO
  3. Click OK. to finish creating the table spaces.

Create users and set their privileges

  1. Go back to the main database instance page and click Database Instance: dbname in the upper left.
  2. Click the Server tab.
  3. Click Security > Users, and then click Create.
  4. Enter a name for the user in this format: dbname_user (example: DM40M5_user).
  5. Enter and confirm your password.
  6. Click the radio button to change the default table space to the table space that you just created (in this example: DM40M5_TBS), as Figure 10 shows.
Figure 10. Setting the table space to the user name
Select and Tablespace columns with names to select
  1. Under the Modify System Privileges tab, move all of the available system privileges to the selected system privileges, and then click OK. (See Figure 11)
Figure 11. Setting privileges for the user
Assigning privileges to newly created user
  1. Click Show SQL. The first line should look similar to this example:
    CREATE USER "DM30DB2_USER" PROFILE "DEFAULT" IDENTIFIED BY "*******"
    DEFAULT TABLESPACE "DM30DB2_TBS" ACCOUNT UNLOCK
  2. Click Return.
  3. To create the user, click OK, and then click Log Out.
  4. Log in as the user that you just created (DM40M5_user as Normal) to make sure that you can connect.

Repeat the process for the second database.

Install Design Manager by using IBM Installation Manager

To install the Design Management Server and the IBM Rational Software Architect Design Manager Server Extension:

  1. Start IBM Installation Manager and click Install.
  2. Select both the Design Management Server and the IBM Rational Software Architect Design Manager Server Extension (select the same version that you just uninstalled).
  3. If you agree to the terms, accept the license agreement, and then click Next.

Note:
Because you are installing Design Management onto WebSphere Application Server, do not install the Apache Tomcat application.

  1. Accept all of the default settings and continue with the installation.
  2. After the process finishes, exit the application.

Configure Design Management on the WebSphere Application Server and restore the databases

This article is based on the assumption that you are familiar the configuration of Design Management on the WebSphere Application Server, so it does not provide those steps.

  1. Because you have installed the same version of Design Manager, you can copy the server directory that you copied in step 3 of the "Back up the directories and database" section to the new installation directory for Design Management.

Important:
After you have copied the directory, do not run jts/setup to configure the database server.

  1. Restore the Oracle database by using the repotools utility.
  2. At a command prompt, browse to the IBM/DesignManagement/server/. Directory, enter the following command, which is also shown in the screen segment in Figure 12:
    repotools-jts.bat –import fromFile=C:\temp\dbexport.tar
Figure 12. Repotools import command
Repotools command line to import file to database

Importing can take from several minutes up to several hours, depending on the database size that you originally backed up.

  1. After the process is finished, close the command prompt.

Now you can configure and deploy Design Management on the WebSphere Application Server. This article does not provide details for that process, because each setup process is different.

Important:
After this process is finished, do not run jts/setup as an administrator. You do not want to overwrite the database setup.

Reindex the Oracle database and restart the WebSphere Application Server

To reindex the Oracle databases by using the repotools utility and then restart the WebSphere Application Server, follow these steps:

Using the Administrative console, you must change the version for the JDBC driver to run the indexing command.

  1. To open the WebSphere Application Server "Environment Entries" page from the WebSphere Application Server administrative console, click Servers > Server Types > WebSphere application servers > your app server > Java and Process management > Process definition > Environment Entries.
  2. Locate the variable called ORACLE_JDBC_DRIVER_FILE. The variable name might differ, but the path should point to the ojdbc6.jar file.
  3. Change the path to point to the ojdbc14.jar file, save your changes, and exit.
  4. Restart the WebSphere Application Server.
  5. Using a command prompt, browse to the IBM/DesignManagement/server/ directory, and reindex the database by entering the following command:
    repotools-jts.bat –reindex all

Note:
Reindexing could take from several minutes up to several hours, depending on the size of the databases.

  1. After the process is finished, change the Java Database Connection (JDBC) driver back to this version: ojdbc6.jar
  2. Repeat step 2 above, and change the path so that it picks up the ojdbc6.jar file.
  3. Save and restart the WebSphere Application Server.


Important:

Do not run jts/setup on the new instances of Design Management and Oracle databases that you installed.

  1. Run the provision command in the browser to create a log of all of the installed plug-ins. Example:
    https://<fully_qualified_host_name>:<port number>/dm/provision
  2. Stop the WebSphere Application Server.
  3. Run Server Reset for the Jazz Team Server by using the following command in a web browser:
    https://<fully_qualified_host_name>:<port number>/jts/admin#action=com.ibm.team.repository.admin.serverReset

After you run this command, you should see a Request Server Reset button, as shown in Figure 13.

Figure 13. Request Server Reset button
Image shows the Request Server Reset button
  1. Click Request Server Reset.
  2. Log out of the WebSphere Application Server, and then stop and restart the server.

You should now be able to log in to the projects that you had before.

Resources

Learn

Get products and technologies

  • Download a free trial version of Rational software.
  • Evaluate other IBM software in the way that suits you best: Download it for a trial, try it online, use it in a cloud environment, or spend a few hours in the SOA Sandbox learning how to implement service-oriented architecture efficiently.

Discuss

Comments

developerWorks: Sign in

Required fields are indicated with an asterisk (*).


Need an IBM ID?
Forgot your IBM ID?


Forgot your password?
Change your password

By clicking Submit, you agree to the developerWorks terms of use.

 


The first time you sign into developerWorks, a profile is created for you. Information in your profile (your name, country/region, and company name) is displayed to the public and will accompany any content you post, unless you opt to hide your company name. You may update your IBM account at any time.

All information submitted is secure.

Choose your display name



The first time you sign in to developerWorks, a profile is created for you, so you need to choose a display name. Your display name accompanies the content you post on developerWorks.

Please choose a display name between 3-31 characters. Your display name must be unique in the developerWorks community and should not be your email address for privacy reasons.

Required fields are indicated with an asterisk (*).

(Must be between 3 – 31 characters.)

By clicking Submit, you agree to the developerWorks terms of use.

 


All information submitted is secure.

Dig deeper into Rational software on developerWorks


static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=1
Zone=Rational,
ArticleID=811651
ArticleTitle=Back up Oracle databases with the IBM Rational repotools utility
publish-date=04242012