Solr Search During a DocuShare 8.0 Upgrade

Before You Upgrade

• Confirm your current DocuShare version, patch level, operating system, database, and search technology.
• Back up the DocuShare database, content, configuration, license information, and search data according to the applicable release instructions.
• Record the Solr host, port, collection name, authentication settings, and any customer-specific search configuration.
• Confirm whether your environment is remaining on IDOL or transitioning to Solr. Review the DocuShare KB guidance for the differences between IDOL and Solr and the supported transition procedure.

Solr and DocuShare 8.0

DocuShare 8.0 includes embedded Solr 9.8.1 in the General Availability and P1 releases, and embedded Solr 9.10.1 from P2 onward. Appendix A in the Solr Operations Guide provides a backup and restore process intended to preserve search indexes during upgrade.

Appendix A Procedure (Backup and Restore)

1. Review <DSHome>\config\FulltextSearchConfig.properties and record the Solr host, port, and collection name. The examples below use localhost, port 8983, and the DocuShare collection.

2. Before creating the backup, run the Solr cluster status request from a browser on the DocuShare server and confirm the current shard count: 

   http://localhost:8983/solr/admin/collections?action=CLUSTERSTATUS&collection=DocuShare

    

3. Create a Solr_bak folder in: $DSHOME\Solr\server\solr

4. Run the Solr backup request from a browser on the DocuShare server. For a large index, add a unique asynchronous request ID, such as &async=backup-20260826:

   http://localhost:8983/solr/admin/collections?action=BACKUP&name=SolrBackUpWithURL&collection=DocuShare&location=C:\Xerox\Docushare\Solr\server\solr\Solr_bak&async=backup-20260826

    

5. Poll the request from a browser until it completes:

   http://localhost:8983/solr/admin/collections?action=REQUESTSTATUS&requestid=backup-20260826

    

6. After the backup completes, move the Solr_bak folder outside of $DSHOME (outside the DocuShare folder). Keep it available throughout the upgrade.
7. Upgrade DocuShare to 8.0 and apply the complete approved patch path before restoring the index. If you are installing 8.0 P2 or later, do not restore before the final patch is installed.

8. After the final DocuShare patch is installed, run the Solr cluster status check from a browser on the DocuShare server:

   http://localhost:8983/solr/admin/collections?action=CLUSTERSTATUS&collection=DocuShare

    

9. Compare the post-upgrade shard count with the count recorded before the upgrade. The restore will fail if the counts do not match.
10. Move the Solr_bak folder back to: $DSHOME\Solr\server\solr

11. Run the Solr restore request from a browser on the DocuShare server. For a large index, use a unique asynchronous request ID:

    http://localhost:8983/solr/admin/collections?action=RESTORE&name=SolrBackUpWithURL&collection=DocuShare&location=C:\Xerox\Docushare\Solr\server\solr\Solr_bak&async=restore-20260826

     

12. Poll the restore request until it completes: 

    http://localhost:8983/solr/admin/collections?action=REQUESTSTATUS&requestid=restore-20260826

     

13. After successful validation, remove completed asynchronous request records if required by your Solr administration procedure:

    http://localhost:8983/solr/admin/collections?action=DELETESTATUS&requestid=backup-20260826

    http://localhost:8983/solr/admin/collections?action=DELETESTATUS&requestid=restore-20260826

     

14. Validate search results for representative content before returning to production.

When Index Preservation Is Required

If avoiding a full re-index is a strict requirement, run the Appendix A backup and restore sequence during the upgrade window and keep a copy of the backup folder outside $DSHOME until validation is complete. Restore only after the final DocuShare patch is installed.

• Current DocuShare version and patch level
• Target DocuShare 8.0 build
• Operating system
• Solr version and collection name
• Solr host and port
• Whether Solr authentication or TLS is enabled
• Whether the upgrade is in place or on a new server
• The planned backup location and available disk space
• The exact Solr BACKUP, CLUSTERSTATUS, and RESTORE URLs that will be used

Post-Upgrade Validation

• Confirm that DocuShare starts without search-service errors.
• Search for recently added content and older content.
• Verify document names, metadata, permissions, and expected result counts.
• Confirm that scheduled indexing and content updates continue to operate.
• Review the DocuShare and Solr logs for errors, failed requests, or unavailable collections.

Troubleshooting

• If Solr does not start, verify the Solr service configuration and review the startup logs before attempting a restore.
• If the collection is unavailable, confirm the configured collection name and Solr endpoint with the installation settings.
• If searches return incomplete results, confirm whether indexing is still running before starting another indexing operation.
• If a backup or restore request fails, do not repeatedly retry it. Save the request URL, response, Solr logs, and DocuShare version information for DocuShare Support.

Support Request

When contacting DocuShare Support, state whether you need to preserve the existing Solr index or can perform a full re-index. Include the complete upgrade path, environment details, backup plan, and any error messages. Support will confirm the applicable procedure for your release and deployment.