This documentation supports the 19.02 version of Remedy Action Request System.

To view the latest version, select the version from the Product version menu.

Backing up the mid tier cache

BMC recommends that you back up the mid tier cache in a separate directory. When the Tomcat server crashes or Windows explicitly stops the Tomcat service, that event causes an abrupt shutdown of the mid tier. When you restart the mid tier after an abrupt shutdown, the mid tier cache becomes corrupted or truncated. (A smooth shutdown leaves the mid tier cache intact.) If you have backed up your cache, you can avoid the time-consuming process of preloading the mid tier cache when the mid tier restarts. The mid tier restores the cache from the backup location only when the cache becomes corrupted.

The following topics are provided:

To verify whether the cache is intact

  1. Stop Tomcat.
  2. Open the .lck file located in the midTierInstallationDirectory\cache directory.
  3. Verify whether the SHUTDOWN_COMPLETED state is available in the file.
  4. Restart Tomcat.

The cache is intact only if the SHUTDOWN_COMPLETED state is available.

To back up and restore the mid tier cache

  1. Create a directory in any location on the computer where the mid tier is running, and copy the intact cache to this location.
    For example, copy the mid tier cache directory located in the midTierInstallationDirectory\cache folder to the /opt/cache_backup folder.


    Ensure that you retain the timestamps of the data and index files. The backed up copy is not considered as a good copy if the timestamp does not match.

  2. On the Cache Settings page, in the Backup Directory field, enter the path and name of the directory that you created in the previous step.
  3. On the Cache Settings page, click Save Changes.
  4. (Linux) Stop Tomcat and use the backup utility to take a back up of the cache.
  5. Restart Tomcat and click Sync Cache to sync the cache for the AR System server.

Using the cache backup utility

Instead of manually copying the cache on Linux systems, use the cacheBackup utility to back up a cache and restore it for further use. The cacheBackup utility ( is a command-line utility available in the midTierInstallationDirectory/tools directory.


  • This utility is available for Linux only. For Windows, you must manually back up the cache.
  • BMC recommends that you use the cache backup utility so that you always get a good copy of the cache without a timestamp mismatch.
  • Before running this utility, ensure that the mid tier is not running.

To use the cache backup utility

  1. Navigate to the mid tier root by using the following command:

    cd /opt/bmc/ARSystem/midtier/tools

  2. Assign execute permission to the file, as follows:

    chmod 755

  3. Run the backup script and provide the backup directory name as the parameter.
    For example: / /opt/cache_backup/

Using good copy of the cache

  1. Ensure that the target mid tier, on which you want to use good copy of the cache, is not running.
  2. Copy the /opt/cache_backup/cache.tar from the first mid tier to the target mid tier and extract it on the target mid tier. For example, use the following commands to copy and extract the .tar file:

    To copy:
    scp /opt/cache_backup/cache.tar root@targetMidTier:/opt/cache_backup
    To extract on the target mid tier:
    cd /opt/cache_backup
    tar -xvf cache.tar
  3. Ensure that the path to the backup directory is set to /opt/cache_backup in the arsystem.ehcache.midTierBackupCacheDir property. 
  4. Go to the target mid tier and delete the midTierInstallationDirectory/cache directory.
  5. Start the mid tier which will automatically start using the good copy of the cache.

Related topics

Was this page helpful? Yes No Submitting... Thank you