Backing up and restoring Lifecycle Query Engine and Link Index Provider

Edit online

You can back up and restore data that is indexed by Lifecycle Query Engine (LQE) or Link Index Provider (LDX). The copy of the indexed data can be used in the future to restore LQE or LDX to a previous state.

Note: The server on which you are creating the backup must be mapped or mounted - Uniform Resource Identifiers (URIs) are not supported.

Before you begin

Before you can perform backups, you must specify a directory on the server as the backup directory. For more information, see Specifying a backup directory.

Ensure that the disk space is at least three times the current size of the indexes under <JTSInstallDir>\server\conf\lqe or <JTSInstallDir>\server\conf\ldx.

About this task

You can create a backup of the indexed data, which you can then use to restore the data to a previous state.

To find backup and restore instructions for all IBM® Engineering Lifecycle Management products, see the Interactive guides.

Procedure

  1. On the LQE or LDX Administration page, in the navigation pane, under Configuration, click Backup.
    Screen capture of the Backup wizard showing available time intervals for creating backups.
  2. You can back up LQE or LDX in the following ways:
    • To create backups on a regular basis, in the Scheduled backups section, click Edit. Select the time and days of the week when you want the backup to be created, and then type the path of the backup directory.
    • To create a backup immediately, in the One Time Backup section, click Backup Now, and then type the path of the backup directory. When you request a backup, it starts as soon as all the current activity finishes.
    Screen capture of the Backup page

Restoring LQE or LDX from a backup directory

Edit online
Based on the number of backups, one or more time-stamped directories exist within the backup directory. Each time-stamped directory contains the following directories:
  • datasets: This directory contains one subdirectory for each partition in the index. Each of the subdirectory contains the following content:
    • <partition-name>\config_manifest.json: Manifest file that indicates where the indexes for the partition must exist on the disk.
    • <partition-name>\indexTdb: Backup of the LQE or LDX index database for the partition.
    • <partition-name>\textIndex: Backup of the LQE or LDX Lucene index for the partition. This index enables full text search of the indexed data.

      The creation of the textIndex is configurable. In the LQE Advanced Properties page, if you select the Create Index for Full Text Search option, then the default\textIndex subdirectory is created. Otherwise, it is not created.

    Note:
    The following partitions appear in LQE and LDX backups:
    • default: Contains the backup of the Artifact (primary) partition, which holds the artifacts and relationships that are created by ELM tools.
    • version: Contains the backup of the internal metadata partition, which holds metadata that is used to optimize reindexing and validation. The version partition does not contain the indexTdb index.
    The following partitions appear in LQE backups:
    • shapes: Contains the backup of the Artifact Type Data partition. It holds the resource shape information that defines the properties and links, which are available on the specific artifact types.
    • history: Contains the backup of the Historical Data partition, which holds the historical metric data that is used to create trend reports.
  • metadata: Contains backup properties and settings. It contains files that represent all the data in the LQE relational database.

Procedure

  1. Shut down the servlet engine that contains LQE or LDX.
  2. Rename the current indexes.
    • For LQE rename any of the following directories that exist in <JTSInstallDir>\server\conf\lqe:
      • indexTdb
      • textIndex
      • shapeTdb
      • shapeText
      • historyTdb
      • historyText
      • versionTdb
    • For LDX, rename any of the following directories that exist in <JTSInstallDir>\server\conf\ldx:
      • indexTdb
      • textIndex
      • versionTdb
  3. Copy the backed-up LQE indexes to the server.
    1. Copy the backed-up directory Backup<timestamp>\datasets into <JTSInstallDir>\server\conf\lqe, or <JTSInstallDir>\server\conf\ldx.
    2. Copy the backed-directory Backup<timestamp>\metadata into <JTSInstallDir>\server\conf\lqe or <JTSInstallDir>\server\conf\ldx.
  4. Edit the lqe.properties file in <JTSInstallDir>\server\conf\lqe\lqe.properties or <JTSInstallDir>\server\conf\ldx\ldx.properties. Set the property lqe.restore=true.
  5. Start the servlet engine that contains LQE or LDX.