This content is archived. See latest version here

Last updated: Jun 10 2014

Introduction

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

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

Configuration settings

First you need to create an index. After the index is created you will get an email with episerver.find section that should be added to the sites web.config

EPiServer shell module registration and configuration is done automatically when you install EPiServer.Find.* NuGet packages.

This is changes done in configuration when installing EPiServer Find packages:

Register Find module:

C#
<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>

Add handler for embedded resources:

C#
<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 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 for more information.


Do you have feedback on this documentation? Send an email to documentation@episerver.com. For development-related questions and discussions, refer to our Forums on https://world.episerver.com/forum/