Clarity Data Recovery Plan

Document ID : KB000047946
Last Modified Date : 14/02/2018
Show Technical Document Details

Clarity Home Directory Backup

  1. Stop the Clarity application and bg services
  2. Make a copy of your current CLARITY_HOME directory
  3. Once copied, modify your CLARITY_HOME\config\properties.xml file to remove any username/password sensitive information
  4. Compress the directory into a single file using a ZIP utility, or JAR or TAR commands. NOTE: Do not use the Windows built-in zip feature. It sometimes drops folders during the zip operation (specifically, it drops the .setup folder)
  5. Example: Open a command prompt, navigate to the copied CLARITY_HOME folder and run the following:

    jar -cvf CUSTOMERNAME_CLARITY_VERSION_DATE.jar clarity

  6. Clarity Filestore and Search Index Folders (Optional)
  7. If the filestore and searchindex folders are on separate locations, please compress into a single file

Oracle Database Backup

  1. Create an export of your database. Stop the Clarity application and bg services beforehand. Failure to do so can result in application problems once the database is restored. Use the Oracle Datapump utility (expdp) to create a backup of your database. Export only the user schema associated with the Clarity installation. Consult the Oracle Datapump documentation if needed
  2. Example:

    expdp CLARITY_DBUSER/CLARITY_DBPASSWORD DIRECTORY=export_dir_alias DUMPFILE=mycompany_CLARITY_VERSION_oraORACLE_VERSION.dmp SCHEMAS=clarity_schema LOGFILE=exp.log

  3. Compress the dump file using a file compression utility
  4. Oracle Initialization Parameters: Please include a copy of your Initialization parameters in a text file and include with your database backup. Execute the query "create pfile from spfile;" and send us the pfile that is generated by the query
  5. Create a zip (or other compression utility) file and add all of the above items. Don't forget to add a copy of your oracle initialization file (init.or or spfile)
  6. Name the zip file with your company name, clarity version, database type & version and date