Jama Connect User Guide

Backup to JAMA or XML

Before starting a backup, please be aware of the following:

  • If SAML is enabled, you must disable it while Jama Connect is running and before using the restored instance of Jama Connect.

  • Backups must be done manually and can't be scheduled automatically.

  • Be sure you have enough disk space available.

  • Backup when Jama Connect is in maintenance mode.

  • If you are using a version of Jama Connect prior to version 8, generate backups during a maintenance window and inform users, including API users, not to use the application.

  • Regardless of what version you are using, all integrations must be disabled.

  1. Log in to the Jama application as system administrator and select the Backup tab.

  2. Choose one of the following methods for backup:

    1. If you are migrating between versions greater than 8.0, you can save a JAMA file to the application server Recommended

      Select Save JAMA file to server to download a zip file with an XML backup of your data along with related documents.

    2. Save XML database backup to a different server Second best option

      Select Save to server to save an XML backup directly to the database server (you must enter the path). Since the data is being generated and saved in the same location, it reduces the likelihood of data corruption. Use this option if you are migrating between different types of databases or if you migrating from a version of Jama Connect prior to 8.0.

    3. Download XML database backup to your workstation Least preferred

      This method is best for when you are unable to access the application server for any reason. Do not use this method for larger data sets as the download process can time out, resulting in a corrupted backup.

    4. Download document type definition to your workstation Not recommended

      This is an older backup type that should only be used when the other methods failed.