Environment

Retain 4.10 or earlier

Situation

The supported Retain upgrade process from 4.x to 24.x is to upgrade first to 4.11, then 24.x.  That requires two Index rebuilds.  This document shows how to do the same upgrade, but with only one Index building. 

Cause

The supported upgrade steps can take several weeks, depending on the size of the Index, the speed of the CPUs, and disk speed. That time can be cut in half if the 4.11 upgrade is skipped.  Additionally, there are issues with 4.11 and Solr8.  If the Index is large, some types of searches will time out.  For some situations, skipping Solr8 and jumping straight to Solr9 is preferred.

Resolution

It is recommended to perform these steps with an OpenText support engineer.

1. Create a backup of the Retain server, Retain Index, and Retain Database.
2. Shutdown the Retain Tomcat service
3. Create a backup of the current ASConfig
   • Linux location:
     • /opt/beginfinite/retain/RetainServer/WEB-INF/cfg/ASConfig.cfg
   • Windows location:
     • [Drive]:\Program Files\Beginfinite\Retain\RetainServer\WEB-INF\cfg
4. Rename Retain program directory
   • Linux location:
     • /opt/beginfinite/retain
   • Windows location:
     • [Drive]:\Program Files\Beginfinite\Retain
5. Rename j2ee (Linux only)
   • mv /etc/opt/beginfinite/retain/tomcat/j2ee /etc/opt/beginfinite/retain/tomcat/backup-j2ee
6. Change RetainInstall.sh to force install new Tomcat (Linux only)
   • Find this line:
     • if [ "$INSTALL_TOMCAT" = "1" ]; then
   • Just above that line, add this line:
     • INSTALL_TOMCAT="1"
7. Install the latest version of Retain 
   • Note: Windows will prompt about Java and Tomcat… continue anyway
8. Shutdown Retain Tomcat Service
9. Copy ASConfig to correct location
10. Start the Retain Tomcat Service.
    • Go to the WebUI. 
      • If you get a database schema prompt, proceed.
        • Watch the RetainServer log and see the schema updates happening. Once it is done, restart Retain Tomcat Service.  Again, watch the log and see if more database schema updates are happening.  Repeat until all database schema work done. Once it is all done, shutdown the Retain Tomcat Service.
      • If you get the Setup Wizard, Stop.  Shutdown the Retain Tomcat Service
11. Make these changes to the copied ASConfig
    • Delete this section from beginning tag to end tag, including the tags
      • <activeIndexEngines>
        • This section can be large
      • </activeIndexEngines>
    • Delete this line
      • <frontEndSearchEngine class="com.gwava.model.indexing.SolrCloudConfig" reference="../activeIndexEngines/com.gwava.model.indexing.SolrCloudConfig"/>
    • Changes these 2 settings from true to false
      • <initDone>true</initDone>
      • <initIndex>true</initIndex>
    • Changes this setting from false to true
      • <initRestConnection>false</initRestConnection>
12. Configure more CPUs to be dedicated to the Index building process
    • Within the solrcloud.indexing.properties, remove the # in the #indexingThreads=0 line
    • Change the value from 0 to something higher. 
      • Number to change to depends on how new technology of CPU and number of CPUs. If you are not certain, try 12.
      • Linux location:
        • /opt/beginfinite/retain/RetainServer/WEB-INF/classes/config/solrcloud.indexing.properties
      • Windows location:
        • [Drive]:\Program Files\Beginfinite\Retain\RetainServer\WEB-INF\classes\config\solrcloud.indexing.properties
13. Create Index9 directory with correct permissions (Linux Only)
    • If Index is in a non-default location, be sure to fix the ASConfig after the WebUI wizard completes.
14. Ensure there are no zookeeper directories.
15. Start the Retain Tomcat Service
16. Go to the Retain Web UI
    • All items should be filled out and grayed out, except for Index. If you see a screen asking about the database, do not proceed!
    • Set the Solr port to 8083
17. Confirm things are going well
    • Stats on Server Configuration -> Index will be wrong
    • Do a wildcard search to see the Index grow (be patient with the query)
    • Click on something with an attachment.  Be sure you can view the attachment
    • Startup logs will show lots of keystore messages.  Don’t worry about it. That should resolve itself overnight

Additional Information

The above steps are to be used at your own risk.  The recommended process to upgrade from 4.x to 24.x is listed in the documentation.

Access article on support portal