10017---Managing Solr Search Configuration

Currently there are two applications which you can use to configure the Solr facet search: the hybris Management Console (hMC) 

and the Backoffice Administration Cockpit.

Overview 

The hybris  hMC and Backoffice Administration Cockpit are user-centric backend interfaces that enable you to easily manage any kind of data 

within the hybris system. Both applications allow you to manage the platform functionalities.

The data model of the Solr Facet Search configuration consists of the main element SolrFacetSearchConfig, which is the item representation of a single configuration. The configuration can be maintained through the hMC or the Backoffice Administration Cockpit applications. 

The sections below will instruct you on how to access and manage the existing Solr Facet Search configurations.

Creating a New Configuration in the hMC 

1Navigate to the  Facet Search Config node (System>Facet search>Facet Search Config) and click it open the page 
where you can search for and display the available configurations.2

Right-click the Facet Search Config node to open a context-menu and select the Create Facet search configuration option.

3In the hMC, the you can manage the Solr configuration using the configuration editor tabs. For details on Customization, 
refer to theCustomization section of this document.

Creating a New Configuration in the Backoffice Administration Cockpit

1Click the Facet Search Config node to open the page where you can search for and display the available configuration items.2

Click the Facet Search Config button to open the wizard.

3

Enter the Configuration Name of your choice and use the  to select a desired Search Configuration item.

4In the second step enter the Item Types for indexing.5In the third step select the desired Solr Server Configuration andIndexer Configuration from the list. Click Done to complete the process.6The newly created facet search configuration is now added to the list. Double-click the item on the list to
 access the tab editor in which you can provide additional information.

Configurable Items

The data model of the Solr Facet Search configuration consists of the main element SolrFacetSearchConfig, which is the item representation

 of a single configuration. This item stays in relation to the other items, which all together define different aspects of the configuration 

such as related languages, currencies, catalog versions, and so on.

The SolrFacetSearch features customizable through items are:

• Name and description
• Supported languages
• Supported currencies
• Supported catalog versions
• Page size and sorting order of search result
• Supported value ranges

SolrFacetSearchConfig Attributes

Qualifier

Type

Role in Configuration

name                      

String                       

Unique identifier of SolrFacetSearch configuration.

description            

String                      

Description of the configuration.

catalogVersions  

CatalogVersion     

Determines which catalog versions (in other words, contained products) should be indexed in the Solr engine.

languages             

Language               

Determines which languages are supported by this configuration. For localized attributes the 

corresponding values will be indexed separately. Hence, searching for items

 gets independent of the chosen language.

currencies                    

Currency                        

Determines which currencies are supported by this configuration. 

Price values in different currencies will be indexed separately. 

Hence, searching for items gets independent of the chosen currency.

document                     

Document                       

Contains all remaining configuration that is stored in a nested XML configuration files.

solrSearchConfig      

SolrSearchConfig         

Determines form of the query results. Defines pagination size and sort attributes.

solrValueRangeSets

SolrValueRangeSet

Defines range sets available for this configuration. Single range values consist of name and 

upper and 

Customization

The data model of the SolrFacetSearch configuration consists of the main element SolrFacetSearchConfig, 

which is the item representation of a single configuration. The configuration editor enables user to set up the configuration 

for the Solr facet search. It contains several tabs with options described in the further sections of this document. 

Properties Tab

Using the Properties tab you can specify the configuration item's name and description, as well as the supported catalog version, 

currencies, and languages. You can enable the fallback language mechanism and add a set of ranges predefined in the Ranges node.

Note

It is also possible to point to a media containing the SolrFacetSearch - XML Configuration File. This is not a requirement, however, the option is present for backward compatibility reasons.

Indexed Types Tab

The indexed types can be defined in the hMC/Backoffice Administration Cockpit in the Indexed types tab. 

The user can choose one of the predefined types or create a new type by right-clicking the Item types table and 

selecting the appropriate action from the context menu.

The Item corresponding to the indexed type has its own tree node in the hMC/Backoffice Administration Cockpit. 

It called SOLR Item types and is present in the Facet Search directory. A User can define and browse through the types.

Search Configuration Tab

Use this tab to define the pagination of the search results and sorting fields in a way that suits you best. 

This search configuration is wrapped inside a separate item. You can choose the setup from the existing ones or create a new item.

1The search configuration can be either selected from the existing ones or create a new one.
 Use the symbol to search for the available configurations.
2

In the hMC, right-click the configuration name and choose Edit to open the configuration setup window.

In theBackoffice Administration Cockpit, double click the configuration name.

SOLR Configuration Tab

The tab layout provides information on the Solr configuration name. Additionally, you find here two sections that allow you to add, 

change or remove the Solr server configuration and the Indexer configuration. Each of these elements is a separate platform type,

 hence, they have their own editors. Right-click on the element and select required option from the context menu.

SOLR Server Configuration

The SOLR server configuration editor enables you to set up necessary configuration options.

 For example, configurations can be done for several server modes

1

Embedded

Note

This configuration mode is supportedup to version 5.7

2Standalone3

Standalone Clustered

It is the case of several servers where one server plays the master server role while other servers are slave servers. 

In such setups the master server is included in query load balancing by default. To avoid partial query results during full indexing runs, 

disable queries on the master server by checking Use Master Node(s) exclusively for indexing or use TWO_PHASE indexing.

Solr Indexing Configuration

The solr indexer configuration editor enables you to configure several options of the Indexer. 

Mode Name     indexer mode

• DIRECT: In case of the  full index operation, the current index is removed and replaced by a new index.

       For a certain period of time the index is not fully available for the users for query.

• TWO_PHASE: The current index remains active until the new index has been built in the new Solr core.

   After that, new index takes place of the old index and can be queried by users without any shutdown periods.
 External front-end applications do not need to know which Solr indexer core is active at the current time.commitMode

• NEVER: a commit operation will not be executed explicitly
• AFTER_INDEX: hard commit after the indexing, this is the default;
• AFTER_BATCH: hard commit after each batch;
• MIXED: soft commit after each batch, hard commit after the indexing.

optimizeMode

• NEVER: an optimize operation will not be executed explicitly, this is the default;
• AFTER_INDEX: optimize after the indexing.

Note

If the ignoreErrors flag is enabled, this means that some errors are ignored during indexing.

Keyword Redirects Tab

The Keyword redirects tab enables users to define the words used to redirect them to the certain search results like URL targets or items. 

These keyword redirects are defined for specific facet search configuration and can be created for several languages separately.

Synonyms Tab

The Synonyms tab enables users to create additional word to be used as a search parameter. 

These synonyms are defined for specific facet search configuration and can be created for several languages separately.

Synonyms Tab

The Synonyms tab enables users to create additional word to be used as a search parameter. These synonyms are defined for specific facet search configuration and can be created for several languages separately.

Stopwords Tab

For indexes with lots of common words like the, a, these words make the index large and slow down phrase queries. 

A simple solution is to filter common words out of fields where they show up often. 

The Stopwords tab enables users to add words to be used as filtering parameters. 

These stop words are defined for specific facet search configuration and can be created for several languages separately.