Integrating Solr in Studio Server – Home

Info: Performing the steps described in this article requires direct server access. Depending upon how your system is hosted and the level of access you have to that system, coordination may be required with your Partner or WoodWing Support team. For a full overview of the steps that need to be done by WoodWing and how to request them, see WoodWing Cloud - Change management.

Solr can be integrated in Studio Server by performing the steps outlined below, listed in the order in which they should be performed.

1. Installing Solr

Perform the following steps by following the applicable reference guide:

Step 1. Install Solr.

Step 2. Configure Solr.

Step 3. Create a Solr Core (to be used by the Studio Server installation).

Make sure to have completed these steps before continuing.

2. Solr configuration for Studio Server

After performing basic configuration steps during the installation of Solr, additional settings need to be configured for use with Studio Server.

Step 1. Open the Solr configuration file on Studio Server (recommended: config_overrule.php file):

<Studio Server installation directory>/config/config_solr.php

Step 2. Verify if the correct URL is defined in the SOLR_SERVER_URL setting.

Example: define ('SOLR_SERVER_URL', 'http://localhost:8983/solr');

Step 3. Verify if the correct collection is defined in the SOLR_CORE setting.

Example: define ('SOLR_CORE', 'collection1');

Step 4. (Optional) Define the time-out duration in the SOLR_TIMEOUT setting.

Example: 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 Studio Server Schema

In this step, the default Solr schema file is replaced by the Studio Server version.

Step 1. Unpack the Solr package that is delivered as part of the Studio 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 Studio Server, activate the Server plug-in named Solr Search. by doing the following:

Step 1a. In Studio 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 Studio Server, access the Health Check page and run the Solr Search Server test by doing the following:

Step 2a. In Studio 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.

5. Additional configuration

Once Solr has been integrated and is fully working with Studio Server, additional functionality can be enabled by configuring the system. This includes adding custom metadata properties, setting up synonyms or words to ignore, and more.

For more information, see the articles in the Solr section.

Troubleshooting

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 <Studio Server installation directory>/config/config_solr.php file (recommended: config_overrule.php file).