Try our conversational search powered by Generative AI!

Configuration - <episerver.framework> 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.framework>
<automaticSiteMapping>
<geolocation>
<scanAssembly>
<siteHostMapping>
<virtualRoles>
<visitorGroupStatistics> </episerver.framework>

<automaticSiteMapping>

As indicated by the name, this element is updated automatically by the application. There is normally no need to manually modify the collection.

<automaticSiteMapping>
   <add key="string"
        siteId="string" />
   ...
</automaticSiteMapping>

 

<add> Element Attributes

NameDefault ValueDescription

key

 

A unique key for an application. The value is a combination of an IIS application ID and a machine name.

siteId

 

The name of a site instance in the EPiServer CMS or EPiServer Community configuration.

The corresponding values can be found on the <site> elements in the <episerver> and <episerver.community> sections.

 

<geolocation>

<geolocation defaultProvider="string" >
   <providers>
      <add name="string"
           type="string" />
      ...
   </providers>
</geolocation>

 

<geolocation> Element Attributes

NameDefault ValueDescription

defaultProvider

 

The name of the provider to be used.

A provider with the specified name must exist in the <providers> collection.

 

<add> Element Attributes

NameDefault ValueDescription

name

 

A unique name idenitfying this provider.

type

false

The full name of the geoloaction provider class.

 

<scanAssembly>

<scanAssembly forceBinFolderScan="bool" >
   <add assembly="string" />
   ...
</scanAssembly>

 

<searchResultFilter> Element Attributes

NameDefault ValueDescription

forceBinFolderScan

false

Defines whether all asseblies in the /bin folder should be scanned to discover classes decorated with any of the EPiServer class decoration attributes.

 

<add> Element Attributes

NameDefault ValueDescription

assembly

 

Defines whether all asseblies in the /bin folder should be scanned to discover classes decorated with any of the EPiServer class decoration attributes.

 

<siteHostMapping>

<siteHostMapping>
   <siteHosts siteId="string" >
      <add name="string" />
      ...
   </siteHosts>
   ...
</siteHostMapping>

 

<siteHosts> Element Attributes

NameDefault ValueDescription

siteId

 

The name of a site instance in the EPiServer CMS or EPiServer Community configuration for which these site mappings apply.

The ID of the site The corresponding values can be found on the <site> elements in the <episerver> and <episerver.community> sections.

 

<add> Element Attributes

NameDefault ValueDescription

name

 

Host name that should be mapped to this site instance, may include a port number.

One of the <siteHosts> collection must contain the wildcard (name="*") mappping.

 

<virtualRoles>

<virtualRoles failSafeIsInRole="bool"
              replacePrincipal="bool"
              replicationType="string" >
   <providers>
      <add name="string"
           type="string" />
      ...
   </providers>
</virtualRoles>

 

<virtualRoles> Element Attributes

NameDefault ValueDescription

failSafeIsInRole

false

Defines whether the IsInRole method on VirtualRolePrincipal may throw an exception.

Set to true to stop IsInRole from throwing an exception.

This setting can be useful to emulate the behavior of IsInRole as it worked in .NET Framework 1.0 / 1.1. In these versions any exceptions thrown by code executing beneath IsInRole were caught and ignored.

replacePrincipal

false

Defines if the HttpContext.Current.User IPrincipal object should be wrapped in a VirtualRolePrincipal.

This value must me true to be able to use virtual roles.

replicationType

EPiServer.ApplicationModules.Security.VirtualRoleReplication, EPiServer.ApplicationModules

The full name of the class that will handle replication of changes in virtual roles.

 

<add> Element Attributes

NameDefault ValueDescription

name

 

Unique name for this virtual role provider.

type

 

The full name of the virtual role provider class.

 

<visitorGroupStatistics>

<visitorGroupStatistics commitToRepositoryInterval="TimeSpan"
                        enabled="bool" />

 

<visitorGroupStatistics> Element Attributes

NameDefault ValueDescription

commitToRepositoryInterval

0.00:20:00

How often collected statistics should be saved to the repository.

enabled

true

Defines whether statsitics should be collected.