Vulnerability in EPiServer.Forms

Try our conversational search powered by Generative AI!

AI OnAI Off

Configuration - <episerver.shell> Section

Product version:

EPiServer CMS 6 R2 / Relate 2 R2

Document version:

1.0

Document last saved:

Section Hierarchy - Table of Contents

This is a pseudocode description of the element structure of the episerver.community section. Each element name is also a link leading to the detailed information for that element

<episerver.shell>
   <clientResources>
   <dashboard>
   <navigation>
   <protectedModules>
   <publicModules>
</episerver.shell>

<clientResources>

<clientResources debug="bool" />

 

<clientResources> Element Attributes

NameDefault ValueDescription

debug

false

Defines if debug versions of included scripts are used instead of compressed/optimized versions.

 

<dashboard>

<dashboard defaultService="string" >
   <disabledGadgets>
      <add name="string" />
      ...
   </disabledGadgets>
   <templates>
      <add forRoles="string" >
         <tabs>
            <add layout="string"
                 name="string" >
               <gadgets>
                  <add column="int"
                       name="string" >
               </gadgets>
            </add>
            ...
         </tabs>
      ...
   </templates>
</dashboard>

 

<disabledGadgets>/<add> Element Attributes

NameDefault ValueDescription

name

  

The class name, including namespace, of the gadget to be disabled.

 

<templates>/<add> Element Attributes

NameDefault ValueDescription

forRoles

  

Comma-separated list of roles for which the template should apply. 

 

<tabs>/<add> Element Attributes

NameDefault ValueDescription

layout

  

The name of the layout to be used on this tab.

Example: "2 Column".

name

  

The name of the tab.

 

<gadgets>/<add> Element Attributes

NameDefault ValueDescription

column

  

The zero-based index of the column in which this gadget should be placed. 

name

  

The class name of the gadget, including namespace.

 

<navigation>

<navigation>
   <add alignment="MenuItemAlignment"
        menuItemType="MenuItemType"
        menuPath="string"
        sortIndex="int"
        target="string"
        text="string"
        url="string" />
   ...
</navigation>

 

<navigation> Element Attributes

NameDefault ValueDescription

alignment

MenuItemAlignment.Left

The alignment of the menu item.

Possible values are Left and Right.

menuItemType

MenuItemType.Link

The type of this menu item.

Possible values are Link, Section and DropDown.

Link items must be children of container items - either a Section or a DropDown. The hierarchy of menu items is controlled by via the menyPath attribute.

menuPath

  

The menu path/key of this menu item. The path defines the structure and is also the unique key to this menu item.

"/global/" refers to the full menu area - menuPath must start with "/global/" to be visible in the menu.

Example: the following configuration will create one new menu section containing one link.

<add text="MySection" menuPath="/global/mySection" menuItemType="Section" />
<add text="MySectionLink" menuPath="/global/mySection/myLinkt" url="/folder/file.aspx" />

sortIndex

   The sort index of this menu item. Menu items are sorted from low to high within each section.

target

  

The frame in which to open the linked file.

text

  

The text that should appear in the menu item.

url

  

The url of the file to be opened.

 

<protectedModules>

<protectedModules autoDiscovery="AutoDiscoveryLevel"
                  rootPath="string" >
   <add clientResorcePath="string"
        name="string"
        resourcePath="string" >
      <assemblies>
         <add assembly="string" />
         ...
      </assemblies>
   </add>
   ...
</protectedModules>

 

<protectedModules> Element Attributes

NameDefault ValueDescription

autoDiscovery

AutoDiscoveryLevel.Minimal

Option for probing the the module folder and load of module assemblies automatically on start-up.

Possible values are:

  • Minimal: Will only load modules configured by web.config and associate assemblies explicitly configured in web.config.
  • Modules: Auto-discover modules in the module directory and load assemblies defined in the module's module.config file and load assemblies located in the module's bin directory in addition to those defined in the module's module.config file.

rootPath

  

The root path below which module directories are located.

 

<protectedModules>/<add> Element Attributes

NameDefault ValueDescription

clientResourcePath

   The client resource path. If no value is specified the resourcePath is used.

name

 

The name of the module/folder.

If no resourcePath value is specified the name value is combined with the rootPath value to form the path to the module folder.

resourcePath

   The path to the module directory.

 

<assemblies>/<add> Element Attributes

NameDefault ValueDescription

assembly

 

An assembly to load and associate with the module.

The assemblies listed in this collection may be combined with assemblies defined by the module depending on the auto discovery option.

 

<publicModules>

<publicModules autoDiscovery="AutoDiscoveryLevel"
                  rootPath="string" >
   <add clientResorcePath="string"
        name="string"
        resourcePath="string" >
      <assemblies>
         <add assembly="string" />
         ...
      </assemblies>
   </add>
   ...
</publicModules> 

<publicModules> Element Attributes

NameDefault ValueDescription

autoDiscovery

AutoDiscoveryLevel.Minimal

Option for probing the the module folder and load of module assemblies automatically on start-up.

Possible values are:

  • Minimal: Will only load modules configured by web.config and associate assemblies explicitly configured in web.config.
  • Modules: Auto-discover modules in the module directory and load assemblies defined in the module's module.config file and load assemblies located in the module's bin directory in addition to those defined in the module's module.config file.

rootPath

  

The root path below which module directories are located.

 

<publicModules>/<add> Element Attributes

NameDefault ValueDescription

clientResourcePath

   The client resource path. If no value is specified the resourcePath is used.

name

 

The name of the module/folder.

If no resourcePath value is specified the name value is combined with the rootPath value to form the path to the module folder.

resourcePath

   The path to the module directory.

 

<assemblies>/<add> Element Attributes

NameDefault ValueDescription

assembly

 

An assembly to load and associate with the module.

The assemblies listed in this collection may be combined with assemblies defined by the module depending on the auto discovery option.