Shell module

Introduction

The EPiServer Find integration comes with a shell module that adds a new top level menu item to the EPiServerOnline Center view. The shell module has three main views:

• Index
• Statistics
• Optimizations

In order for the shell module to be visible it needs to be configured. The configuration settings are described below.

Configuration settings

Configuring EPiServer Find to work with CMS is done by adding a new element to the episerver.shell element in web.config. To configure the general EPiServer module along with the CMS specific UI components, add the below element to the protectedModules element.

<add name="Find">
  <assemblies>
    <add assembly="EPiServer.Find.Framework" />
    <add assembly="EPiServer.Find.Cms" />
  </assemblies>
</add>

After doing this, the complete episerver.shell element in web.config should look something like this:

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

Access rights

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

• WebAdmins
• Administrators
• SearchAdmins

Note that the first of these two are groups that typically have Admin view access in EPiServer CMS. This means that administrators will most likely have access to the shell module views by default. Users that do not have administrator access, such as those in the role WebEditors, can be granted access by creating a new group named SearchAdmins and adding them to it.

Supported browsers

As the shell module relies heavily on CSS 3, only modern browsers are supported. Refer to the system requirements for EPiServer Find for more information.