HomeGuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityLog In

Shell module

This topic describes how to set up the shell module, which adds the menu options and user interface views available for Optimizely Search & Navigation to your solution.

Configuration settings

The shell module needs to be configured in order for user interface options to become visible. When you have created an index, you get an email with an episerver.find section that you add to the site's web.config. The Episerver shell module registration and configuration are done automatically when you install using NuGet packages.

Below are the changes made in configuration when installing the packages.

Registering Search & Navigation module

<episerver.shell>
  <publicModules rootPath="~/modules/" autoDiscovery="Minimal" />
  <protectedModules rootPath="~/epiui/">
    <strong>
      <add name="Find">
        <assemblies>
          <add assembly="EPiServer.Find.Framework" />
          <add assembly="EPiServer.Find.Cms" />
        </assemblies>
      </add>
    </strong>
    <add name="Shell" />
    <add name="CMS" />
  </protectedModules>
</episerver.shell>

Adding handler for embedded resources

<location path="EPiServerFindEmbeddedResources">
  <system.webServer>
    <handlers>
      <clear />
      <add name="wildcard" path="*" verb="*" type="EPiServer.Web.StaticFileHandler, EPiServer.Framework" />
    </handlers>
  </system.webServer>
</location>

Access rights

Access to views in the shell module is restricted to users in one of three groups:

  • WebAdmins
  • Administrators
  • SearchAdmins (Search & Navigation-specific)

📘

Note

The first two groups have Admin view access in Optimizely CMS, and access to shell module views by default. To grant users without administrator access, create the SearchAdmins group for the membership and role provider you are using, and add those users to it.

Supported browsers

The shell module relies heavily on CSS 3, so only modern browsers are supported. See the system requirements for Optimizely.

Added views

When properly configured, the shell module adds the views and subviews described below to the editing interface.

Manage

Statistics

  • This view shows Search statistics for the top most frequent searches, searches without hits, and searches without relevant hits. Statistics can be displayed for last 24 hours, last week, last month or last year.

Optimization

  • Best Bets. Can be site and language-specific or site and language-independent, depending on choices made in the site and language drop-downs (near the top of the view).

📘

Note

To apply Best bets to search results, you must apply an ApplyBestBets extension method.

  • Related queries. Can be either site and language-specific or site and language independent.

📘

Note

To use related queries, you must apply a DidYouMean method.

  • Synonyms. Can be language-specific or apply to any language, but cannot be site specific.

📘

Note

To use synonyms, you must apply a UsingSynonyms extension method.

Configure

  • Boosting. Provides a form for fine tuning weights of different parts of the content in search results. Site and language independent.
  • Index. Lets you to clear data stored in the index and index statistics.
  • Connectors. Provides a view for creating and listing connectors.

Overview

The Overview and Explore views let you browse indexed content, displaying information about indexed documents count grouped by type. Filtering by type and arbitrary search query is supported.


Did this page help you?