000038811 - Reporting Engine Migration Recovery Tool for RSA NetWitness Platform 11.3 and later

Document created by RSA Customer Support Employee on Apr 30, 2020
Version 1Show Document
  • View in full screen mode

Article Content

Article Number000038811
Applies ToRSA Product Set: NetWitness Logs & Network
RSA Product/Service Type: Reporting Engine
RSA Version/Condition: 11.3 and later
Platform: CentOS
O/S Version: 7
IssueAfter upgrading to RSA NetWitness Platform 11.3 and later, the Reporting Engine service does not restart from the upgrade process.
CauseThe Reporting Engine service may not restart after the upgrade due to any of the following reasons:
  • The workspace.xml is not updated.
  • Time is not converted properly in the live chart H2 database.
  • JCR (Jackrabbit repository) is corrupted with a primary key violation.
Resolution

The Reporting Engine Migration Recovery Tool (rsa-nw-re-migration-recovery.sh) helps to restore the Reporting Engine service when the Reporting Engine service fails to restart after an upgrade. When running this tool, it checks for the following errors in the Reporting Engine logs.



  • The workspace.xml is not updated.
  • Time is not converted properly in the live chart H2 database.
  • JCR (Jackrabbit repository) is corrupted with a primary key violation.

If the Reporting Engine service does not restart after the upgrade, running the tool will search the Reporting Engine logs and fix any of the above issues. Once the fixes are applied, the Reporting Engine service is restarted automatically. During this process, a backup is created for the Reporting Engine data if the errors are data related.



Warning: Use this tool only if the Reporting Engine service does not restart properly directly after an upgrade. Running this tool at any other time could cause unexpected issues. This tool should only be ran from the NW server (Node 0) where the Reporting Engine service is installed.


 

Running the Reporting Engine Migration Recovery Tool



  1. If on RSA NetWitness 11.3.x or 11.4.x, download the rsa-nw-re-recovery-tool-bundle.tar file from this article. If on RSA NetWitness 11.5 and above, the script is already installed.
  2. Upload the tar file to the NW Server (Node 0).
  3. SSH into the NW Server (Node 0).
  4. Untar the recovery tool bundle.


tar -xvf rsa-nw-re-recovery-tool-bundle.tar


  1. Run the recovery tool script.


./rsa-nw-re-recovery-tool.sh


  1. If the Reporting Engine backup data is needed, it can be found at the following locations:

  • Backup Data: /root/reporting-engine-backup/
  • Log Files: /root/reporting-engine-backup/log/

Outcomes