Solr 6 or 7 can be integrated in Enterprise Server by performing the steps outlined below, listed in the order in which they should be performed.
Before you start
For an overview of which versions of Enterprise Server can be used with Solr 6 and 7, see the Compatibility Matrix.
Also closely follow the Enterprise Server Release Notes for any changes that may have been made.
1. Installing Solr
Perform the following steps by following the applicable reference guide:
Step 1. Install Solr.
Step 2. Configure Solr.
Step 3. Creating a Solr Core (to be used by the Enterprise Server installation).
Make sure to have completed these steps before continuing.
2. Solr configuration for Enterprise
After performing basic configuration steps during the installation of Solr, additional settings need to be configured for use with Enterprise Server.
Tip: Easily manage and configure settings of all configuration files by adding them to a single configuration file.
Step 1. Open the Solr configuration file on Enterprise Server:
<Enterprise installation directory>/config/config_solr.php
Step 2. Verify if the correct URL is defined in the SOLR_SERVER_URL setting.
define ('SOLR_SERVER_URL', 'http://localhost:8983/solr');
Step 3. Verify if the correct collection is defined in the SOLR_CORE setting.
define ('SOLR_CORE', 'collection1');
Step 4. (Optional) Define the time-out duration in the SOLR_TIMEOUT setting.
define ('SOLR_TIMEOUT', 5);
Note: Changing this value may be necessary when time-outs occur while indexing many objects. However, usually it is better to adjust the solrconfig.xml file by changing settings such as ramBufferSizeMB, mergeFactor, and autoCommit.
3. Installing the Enterprise Schema
In this step, the default Solr schema file is replaced by the Enterprise version.
Step 1. Unpack the file SolrEnterprise_10.x.x_Buildyz.zip that is delivered as part of the Enterprise Server installation.
Step 2. Copy the file named schema.xml to <solr>/<corename>/conf/. Confirm that you want to overwrite the already existing schema.xml file.
Note: The core name is usually 'collection1'.
Step 3. Copy the file named solrconfig.xml to <solr>/<corename>/conf/. Confirm that you want to overwrite the already existing solrconfig.xml file.
Step 4. Access the admin page of Solr 6 and click Reload for the appropriate collection.
4. Testing the integration
Step 1. In Enterprise Server, activate the Server plug-in named Solr Search.
Step 1a. In Enterprise Server, click Server Plug-ins in the Maintenance menu or on the Home page.
The Server Plug-ins page appears.
Step 1b. Locate the Solr Search plug-in and when the icon is red, click it to activate the plug-n.
Step 2. In Enterprise Server, access the Health Check page and run the Solr Search Server test.
Step 2a. In Enterprise Server, click Advanced in the Maintenance menu or on the Home page. A page with all advanced Maintenance features appears.
Step 2b. Click Health Check.
The Health Check page appears.
Step 2c. At the bottom of the page, click Clear All.
Step 2d. Select the test named Solr Search Server.
Step 2e. Click Test.
The test is executed and the result is displayed next to the test. It should display “OK”.
Note: If the test fails, an error is displayed together with instructions for solving it. Follow the instructions and then run the test once more.
Error when (re-)indexing Solr: "Operation timed out after 5000 milliseconds with 0 bytes received"
When this error is shown in the log files after (re-)indexing Solr, increase the value of the SOLR_TIMEOUT setting (for example by doubling it) in the <Enterprise installation directory>/config/config_solr.php file.
- 25 February 2019: Updated section 1 'Installing Solr' by adding the Reference Guide for Solr 7.6.