Name: Customizing Solr Configuration - SAP Commerce Cloud
Uploaded: 2021-7-5
Duration: 610 s
Description: This video shows how to customize Solr Configuration in SAP Commerce Cloud in Public Cloud.

Share feedback

<p><u><strong>Planned maintenance of Practice Systems</strong></u></p>

Planned maintenance of Practice Systems

Why create an SAP account?

Enhance your learning experience

SAP Learning

Choose your subscription

Manage your subscription

Live Sessions

Hands-on Practice

Certification

My Learning

Ready to start learning?

<div><div><div>This video shows how to customize Solr Configuration in SAP Commerce Cloud in Public Cloud.</div></div></div>

Customizing Solr Configuration - SAP Commerce Cloud

Hello and welcome!  My name is Varsha.  In this video, I’m going to tell you how to customize Solr configuration in SAP Commerce Cloud in the public cloud.  To begin with, I’ll introduce you to the different Solr running modes within SAP Commerce Cloud.  I’ll then go into the various details about how to customize Solr configuration, such as how to configure Solr directly into the Backoffice.  How to customize Solr configuration files to override the existing ones used in SAP Commerce Cloud in the public cloud.  How to install a third-party library into Solr and finally, how to add a new language into Solr.  Let’s look at how Solr is run in different modes within SAP Commerce Cloud.  Firstly, Solr can run in embedded mode, which means Solr runs together with SAP Commerce Cloud in the same Java virtual machine.  This mode can be used for development; however, it isn’t recommended for the production environment.  That’s because in case a problem arises it’ll crash both SAP Commerce Cloud and Solr.  It’s also very difficult to monitor and scale Solr.  Another mode is called stand alone, which means Solr runs on its own on the Java virtual machine.  This is usually on its own server, so that it won’t imply the problems as embedded mode would have.  However, to improve the performance and scalability, SAP Commerce Cloud in a production environment should always use a Solr cluster.  One Solr server dedicated for indexing, and another Solr server for querying.  In the third option, Solr is run in Solr cloud.  Basically, this is the default mode in SAP Commerce Cloud in the public cloud.  Solr performance can be further optimized with a horizontal sharding mechanism.  Solr cloud also guarantees high availability and scalability of the Solr server nodes or pods within the managed cloud environment.  We’re going to focus on the Solr configuration in SAP Commerce Cloud in the public cloud.  Let’s now look at how to configure Solr directly in the backoffice.  In SAP Commerce Cloud in the public cloud, we must pay attention to the following two configurations.  First, in Solr server configuration set the mode of operation as “cloud”.  You can easily do this by choosing a Solr facet search configuration in backoffice and select the server configuration.  Then set the mode as “cloud”.  Also, make sure that you utilize all pods in the production environment.  SAP Commerce Cloud in the public cloud provides a predefined number of Solr nodes.  A common mistake is to utilize only one node of the four nodes available in the production environment.  For example, you can see that in this environment.  It only uses one Solr node to store the collection of electronic product data.  To make sure that all Solr nodes are utilized,  To make sure that all Solr nodes are utilized,  you can go into the default Solr server configuration  and set the replication factor as two or more.  So that two or more nodes will be used to serve the collection.  Furthermore, if your collection is getting too large and causing performance problems,  you can also set the number of shards to two or more.  This will allow Solr cloud to create shards and distribute them into different server nodes.  After you make the changes, go back to Solr Admin portal and delete the existing collection.  Then do a full index to enforce collections to be re-created.  Then do a full index to enforce collections to be re-created.  Now, you can see that there are two shards, and they’re distributed to different Solr nodes.  Additionally, in the indexer configuration, use “two-phase” instead of “direct” as the default indexer mode.  This is the recommended indexer commit strategy in Solr cloud solution, in our case, in SAP Commerce Cloud in the public cloud.  You can easily set the value by going into the indexer configuration.  Set the value of indexer mode to “two-phase”.  Now, let’s see how we can customize Solr configuration files.  There are a few mandatory steps that you must follow. Note the Solr configuration file structure in a specific version of SAP Commerce installation for example the solrserver extension shown here. Besides the manifest.json file, I’ll create an identical file structure as I noted in the solrserver extension.  If I change any configuration files, for example the solrconfig.xml or schema.xml files,  I just need to place them here, corresponding to the same configuration file structure.  I’ll edit the manifest.json file.  Here it’s recommended that you specify Solr version, so that a different Solr version during SAP Commerce upgrades, won’t break the previously created configuration file structure.  Also, I need to specify the location of the custom folder containing the custom configuration files.  Finally, I’ll submit the changes to the repository and trigger a new build via SAP Commerce Cloud portal.  During the building, all custom folder’s configuration files, such as the solrconfig.xml or schema.xml will override the Solr configuration files on the server side.  Please note that a file extension filter is invoked to copy only the files with predefined extensions under the custom folder.  The supported file extensions include json, vm, xml, xsl, txt, properties, cfg, html, png, and jar.  How about installing a third-party library into Solr, in SAP Commerce Cloud in the public cloud?  This is in fact very similar to customizing configuration files.  First, create a contrib folder under Solr custom folder.  In this example, I’ve named it contrib folder, but you can name it as you wish.  In the contrib folder, I can include the third-party library, usually one or more jar files, in a lib folder of a custom library named folder.  Now, I can specify the library location in solrconfig.xml.  Also, in solrconfig.xml, I can use the third-party library wherever possible.  Similar to customizing Solr configuration files, I must submit my changes and create a build in SAP Commerce Cloud portal.  During the building process, the third-party library jar files will be installed to the corresponding location on the Solr server.  Finally, let’s know how to add a new language into Solr in SAP Commerce Cloud.  To do this, we need to add the new language into the two configuration files, which are Schema.xml and Solrconfig.xml.  Let’s say, in schema.xml, I want to add a new language called American English,  I’ll first add the text underscore language fieldtype as shown in this example.  Please note that you should specify for both index and query analyzer.  When adding different languages, different tokenizer and filters should be used.  I’ll then add the text spell underscore language fieldtype, specifying the analyzers and their tokenizers, and filters.  I’ll add new dynamic fields for the text underscore language type.  I’ll add new dynamic fields for the text underscore language type.  I’ll also add a new field for text spell for a specific language and create the copy field for spellcheck underscore language.  Similarly, I’ll add the new field for autosuggest with the specific language.  And also create a copy field for it.  Secondly, I need to edit the solrconfig.xml.  I need to add a new entry into the spellcheck search component definition.  I can do this by adding a new spellchecker to refer to the new language spellcheck field.  I must also add a new entry in the suggest search component.  I’ll do this by adding a new spellchecker to refer the new language autosuggest field.  After the modification, make sure you submit the changes to the repository, trigger a new build via SAP Commerce Cloud portal  and redeploy the modified image.  When the server is available, go to backoffice and reindex the specific collection.  Then you should be able to check the new language added in Solr admin portal.  For example, in cloud portal, I’ll go into the Solr admin portal.  I’ll select the specific collection, and do a simple query.  I can see that the new language has been included in the query response.  This video gave you a brief introduction to different aspects of customizing Solr configurations in SAP Commerce Cloud in the public cloud.  If you want to know more about customizing Solr, check the links in the video description where you’ll find more details about the customization possibilities shown in this video.  Thanks for watching!