Configuring episerver.framework Section

Section Hierarchy – Table of Contents

This is a pseudo code description of the element structure of the episerver.community <episerver.framework> section in EPiServer Framework. Each element name is also a link leading to the detailed information for that element.

<episerver.framework>
        <automaticSiteMapping>
        <clientResources>
        <geolocation>
        <localization>
        <scanAssembly>
        <siteHostMapping>
        <virtualPathProviders>
        <virtualRoles>
        <visitorGroupStatistics>
        <licensing>
        <appData>
</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

Name	Default Value	Description
key		Required. A unique key for an application. The value is a combination of an IIS application ID and a machine name.
siteId		Required. 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> section in the EPiServer CMS Developer Guide SDK and <episerver.community> section in EPiServer Relate Developer Guide SDK.

<clientResources>

<clientResources debug="bool" />

<clientResources> Element Attributes

Name	Default Value	Description
debug	false	Defines if debug versions of included scripts are used instead of compressed/optimized versions.

<geolocation>

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

<geolocation> Element Attributes

Name	Default Value	Description
defaultProvider		Required. The name of the provider to be used. A provider with the specified name must exist in the <providers> collection.

<add> Element Attributes

Name	Default Value	Description
name		Required. A unique name identifying this provider.
type	false	Required. The full name of the geoloaction provider class.

<localization>

<episerver.framework>
  ...
  <localization fallbackBehavior="FallbackCulture, MissingMessage, Echo" fallbackCulture="en">
    <providers>
      <add physicalPath="c:\temp\resourceFolder"
           name="customResources"
           type="EPiServer.Framework.Localization.XmlResources.FileXmlLocalizationProvider" />
    </providers>
  </localization>
  ...
</episerver.framework>

<localization> Element Attributes

Name	Default Value	Description
fallbackBehavior	FallbackBehaviors.Echo	The fallback behavior that should be used if a resource could not be found in the requested culture. See EPiServer.Framework.Localization.FallbackBehaviors for possible values.
fallbackCulture	en	The name of the fallback culture in the 'languagecode-country/regioncode' format that the LocalizationService should use if a resource could not be found and the FallbackBehavior includes the FallbackBehavior.FallbackCulture flag.

<add> Element Attributes

Name	Default Value	Description
name		Required. A unique name identifying this provider.
physicalPath		A physical directory path to where language files are located.
fileSystemWatchPath	Same value as specified physicalPath.	A physical directory path that the FileSystemWatcher uses. If no value is set it uses the physicalPath value.

<scanAssembly>

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

<searchResultFilter> Element Attributes

Name	Default Value	Description
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

Name	Default Value	Description
assembly		Required. 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

Name	Default Value	Description
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> section in the EPiServer CMS Developer Guide SDK and <episerver.community> section in EPiServer Relate Developer Guide SDK.

<add> Element Attributes

Name	Default Value	Description
name		Required. 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.

<virtualPathProviders>

<virtualPathProviders> 
      <add name="string"
           type="string" />
      ...
</virtualPathProviders>

<add> Element Attributes

Name	Default Value	Description
name		Required. Unique name for this virtual path provider.
type		Required. The full name of the virtual path provider class.
...		Implementation specific settings. Can have any name and arbitrary in number.

<virtualRoles>

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

<virtualRoles> Element Attributes

Name	Default Value	Description
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

Name	Default Value	Description
name		Required. Unique name for this virtual role provider.
type		Required. The full name of the virtual role provider class.

<visitorGroupStatistics>

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

<visitorGroupStatistics> Element Attributes

Name	Default Value	Description
commitToRepositoryInterval	0.00:20:00	How often collected statistics should be saved to the repository.
enabled	true	Defines whether statistics should be collected.

<licensing>

<licensing licenseFilePath="string"/>

<licensing> Element Attributes

Name	Default Value	Description
licenseFilePath	License.config	The relative or absolute path to the license file.

<appData>

<appData basePath="string"/>

<appData> Element Attributes

Name	Default Value	Description
basePath		The path to the application data.