ARCHIVED as duplicate Upgrade or Patch Installs for Clarity - Best Practices
search cancel

ARCHIVED as duplicate Upgrade or Patch Installs for Clarity - Best Practices


Article ID: 36520


Updated On:


Clarity PPM On Premise


Upgrading or patching a Clarity instance can result in errors, therefore it is important in taking the necessary steps to back up the current application folders and database files related to Clarity.

If a refresh from another environment to another is needed, please use the contents within this article as a guideline.

There are 3 phases in the process: Preparation, Execution, Rollback (if needed).


Release: All
Component: Installation



1. Have copies of the following:

  • Make a copy of each source PPM_HOME/config/properties.xml file
  • Make a copy of the source Clarity application folder.
  • Make a valid backup of the source Clarity database (MS SQL or Oracle).

NOTE: Please consult the DBA team on this procedure as this involves creating and obtaining a .dmp or .bak file.


2.Copy the files from the source to the destination environment

  • Copy the Clarity application folder to the destination environment.
  • Copy the Clarity database to the destination environment.

3. Restore the the following in the destination environment

  • Restore the Clarity application backup to the destination environment.
  • Restore the Clarity database backup to the destination environment.

    NOTE: Please consult the DBA team on this procedure as involves importing or restoring a .dmp or .bak file.

4. Verify the following paths are valid on the destination environment:



After verifying the refresh from the source to destination environment is complete, please do the following:
1. Modify the PPM_HOME\config\properties.xml file to have the valid paths:

a.current JAVA_HOME
b.current TOMCAT_HOME
c.current PPM_HOME

2. Bring up the CSA by performing the following:

  • Run from command line: service add start beacon nsa
  • Open a browser and log on to the CSA. Go to the Database page to enter the database connection information and click the Save button.

Confirm the database is 'Available'. If it is not available, please open a case to troubleshoot.

To ensure the information is saved in the database, run the command: admin general upload-config

NOTE: It may also be required that the Jaspersoft Service and DWH database be available. If this is required, please open a case to discuss the next steps.

  • If Database is 'Available', make a copy of the PPM_HOME\config\properties.xml

3. Start the upgrade installation.

  • Create an installation folder to execute the installation.
  • Obtain the installation media and required thirdparty.libs jar file and place them in the temporary installation folder.
  • From the temporary installation folder, extract the contents of the install.jar file with command: jar -xvf install.jar
  • Run the installation and follow provide the information from the prompted information. 

NOTE: Check if there are any WARNINGS or ERRORS that can cause an upgrade failure by reviewing the TEMP_INSTALL\checkinstall\check-logs\precheck-results.html
If there are any, please correct the error before rerunning the install again.

  • Allow the upgrade/installation to complete.

    NOTE: After it completes, check the following files:

If any errors are encountered, open a Clarity issue for assistance.

Rollback (if needed)
In certain situations, a rollback is needed to back out of a patch or upgrade.

A rollback consists of:

  • Restoring the backup Clarity application folder
  • Restoring the backup Clarity database.

If there are any questions or issues encountered, please open a case referencing this article and specify the step with the issue.