Proper steps to take when setting up or updating a test server for 2015.5 and below

By Iris posted 10-06-2015 15:35

This article assumes that a test server has already been configured. If you do not have an environment configured yet, follow the regular setup guide up to the 'Configure Database' section of the Jama Installation section.

Getting a backup

The first step is to create a database backup. The recommended method is to create a backup directly from your proprietary database.

If that is not possible, you can create a Jama generated backup. If you use an XML backup, move the backup to the test server before proceeding.

Whichever method is chosen, be sure that no users are logged into Jama while the backup is being taken and ensure the backup is complete before touching the backup file.

Note: There is also an option to take a .jama backup. This method can be less reliable than the other two methods and as such is not recommended.

Copying over contour home

Copy the contour home directory from your production environment to your test environment.

The location of contour home can be found when logged into Jama as the root user under the System Info tab. 

On your test environment, delete the following from contour home, if present:

  • activeMQdata directory
  • search directory
  • temp directory
Configuring contour home

Since this is a new environment, even if you are using a copy of the original contour home, Jama must know where to find the directory.

Start the Jama instance on your test environment and walk through the setup process. Once you get to 'Set Jama Configuration Location,' enter the location of contour home.

Note: It is very important that you enter the correct location in this step. Otherwise, Jama will create a brand new contour home.

Configuring the database

After configuring contour home, setup moves to configuring the database. Depending on the backup selected, the database population will consist of several steps. Follow the 'Configure Database' instructions in the setup guide to connect to your test environment's database. 

Populating the test environment with an XML backup

If you used an XML backup, you will need to create a blank database for the data to be loaded into. Once you get to the "Populate Database" section of the setup, you will be prompted to populate the database or load default data.

Enter the full path to the XML file in the second input field and select Load Backup Data.

Index Jama

With the new database connected to Jama and populated, Jama will need to populate search indexes. Complete the indexing process. Once that is complete, your test environment should be a replica of your production environment. 

Disable and update production-specific settings

Since this is an exact duplicate of the production environment, settings such as SMTP are still enabled. To avoid confusion for users, it is advised that these settings be disabled immediately after the test Jama environment starts or before you export the production environment. If you choose the latter, be sure to re-enable the settings in production once the export is complete.

Settings to check include:

  • Legacy connectors such as the JIRA, TFS, and Rally connectors
  • SMTP or IMAP
If SMTP or IMAP is enabled on the test server, it should use a completely separate mailbox than the production server uses. System "From" Address, Collaboration "From" Address and IMAP User Account should be changed. This prevents the test server from importing stream replies from the production environment and vice versa. 

In addition, your test environment will still have references to your production URL. These URL references should be updated to reflect the new URL.