Public Release Note - SolrCloud Search Service Adapter 3

Table of Contents

Product Version


Product To Version



1 Introduction

The SolrCloud Search Service Adapter connects the Intershop Commerce Management (ICM) with a Solr server that runs in cloud mode. The search index configuration and maintenance in the ICM back office uses the Schema- and ConfigSet-REST-APIs provided by the newer Solr server version. Thus, the Solr Server is separate and independent of the ICM application server cluster.

1.1 References

1.2 Version Information and Dependencies

Intershop Commerce ManagementSolrCloud Search Service AdapterSolr Server
7.10.31+3.0.0 - - 8.6.3
7.10.31+3.0.3 - - 8.11

Due to Solr™ Security News - 2021-12-10, Apache Solr affected by Apache Log4J CVE-2021-44228 it is recommended to use Solr version >=8.11.1 or to follow the mitigation advices given in the security news article.

There is a backward compatibility issue with SolrJ (SOLR-15145). Solr 8.6.3/Solr 8.7+ requires additional configuration: (ISSEA-167 - Can't Create a Configset - Solr Cloud 8.6.3 8.7).

The listed Solr server versions were tested to work with the listed SolrCloud Adapter version. In general, minor and patch version upgrades of the Solr server are usually compatible with the adapter.

The following table lists the cartridges contained in the SolrCloud Adapter:

ac_solr_cloudThe main implementation cartridge of the adapter defining and registering the search service.(tick)
ac_solr_cloud_boAdditional functionality for the Commerce Management application. It provides additional configuration options for the index management, especially for suggest and spell-check.(tick)
solrcloud_configAdditional configuration to be deployed to share.(tick)

2 Deployment

Please see the Cookbook - Deployment of Solr Search Adapters on how to set up your project.

The SolrCloud Search Service Adapter requires a Solr server that runs in cloud mode. Please see the Guide - Deployment Solr Cloud Server on how to set up a Solr server for development or production. This guide also provides information on how to configure ICM to use a Solr server.

Solr server versions higher than 8.6.2 require setting up authentication or enabling upload of config sets from the ICM application server.
SOLR_OPTS="$SOLR_OPTS -Dsolr.disableConfigSetsCreateAuthChecks=true"

3 Data Replication

The data replication of indexes has changed with this adapter implementation. The standard ICM file replication is not used anymore to replicate the index data. Instead, the adapter comes with its own replication decorator that uses the backup/restore collection API functionality of Solr. Please see Guide - Solr Replication for the description and configuration of the index replication with the SolrCloud server.


Data replication with a SolrCloud cluster requires to mount a shared file system at the same path on each Solr node. The ICM must configure the property solr.cloudBackupLocation to point to this shared location.

Solr Server version 8.6.3 or higher in conjunction with data replication requires setting the backup location as an allowed path for the Solr server cluster. You can specify the allowed paths by setting a system property via environment in the startup script:
SOLR_OPTS="$SOLR_OPTS -Dsolr.allowPaths=/mnt/solr_backup"

4 Changelog

4.1 Release 3.0.5

To fix issues while closing SolrClient objects in a cache implemented with the common ICM cache framework (71243 AlreadyClosedException), the component SolrClientCache is no longer used and is deprecated.

If customized code is used, SolrClientCache must be replaced with SolrServerProvider instead.

4.1.1 Bugfixes

70612Suggested search terms disappear again due to wrong default target data type of QueryTerm in SFObject Search Suggest Solr Index
71243AlreadyClosedException when updating Solr search index
71440New Java product search fallback to query search does not work

4.2 Release 3.0.4

4.2.1 Bugfixes

70139Replication for New Search Index/EDIT Deleted Search Index/LIVE fails
70256Inconsistent Search Results after Search Index Replication in Solr Cluster with Multiple Nodes/Replicas

4.3 Release 3.0.3

4.3.1  Bugfixes

64443Index replication fails - invalid backup - Solr 8.9.0
65087Replicated Solr schema changes are not visible - Solr 8.8+
69230Initial index replication fails with 'Collection Not Found'

4.4 Release 3.0.1

4.4.1 Bugfixes

64594NPE in CatalogFilterViewingHelper::isCurrentlyVisible in case the given CatalogCategory is "null"
63472[ISSEA-188] BackupAndRestoreDecorator is not added to the SearchIndexesStagingProcessor

[ISSEA-191] Replication failure - deletion of not existing configset fails

4.5 Release 3.0.0

This release is dedicated to ICM releases 7.10.31 and higher (Tomcat 9 Release). The adapter release contains the required dependency changes for Tomcat 9. There are no functional or API changes in the adapter compared to the adapter release 2.3.4.


The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources