episerver.framework

30 min

The Configure CMSConfigure CMS topic describes the syntax of the configuration elements.

<episerver.framework>
  <clientResources>
  <geolocation>
  <localization>
  <scanAssembly>
  <virtualPathProviders>
  <virtualRoles>
  <visitorGroupStatistics>
  <licensing>
  <appData>
  <blob>
  <event>
</episerver.framework>

<episerver.framework> element attributes

Name	Default value	Description
createDatabaseSchema	false	Defines whether to automatically create the database schema if it is missing from the configured database. See Install database schema.
updateDatabaseSchema	false	Defines whether to automatically update the database schema in case the current application requires a newer schema. See Automatic schema updates.

<clientResources>

<clientResources debug="bool" compress="bool" />

<clientResources> element attributes

Name	Default value	Description
debug	false	Defines whether to use debugged versions of included scripts instead of optimized versions.
compress	true	Defines whether to deliver data from REST stores in compressed format.

<geolocation>

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

<geolocation> element attributes

Name	Default value	Description
defaultProvider		Required – The provider's name. 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 geolocation 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	Use the fallback behavior if it cannot find a resource in the requested culture. See EPiServer.Framework.Localization.FallbackBehaviors for possible values.
FallbackCulture	en	Use the name of the fallback culture in the languagecode-country/regioncode format that the LocalizationService if it cannot find a resource 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 you do not set a value, it uses the physicalPath value.

<scanAssembly>

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

<searchResultFilter> element attribute

Name	Default value	Description
forceBinFolderScan	false	Defines whether to scan assemblies in the /bin folder to discover classes decorated with any of the EPiServer class decoration attributes.

<add> element attribute

Name	Default value	Description
assembly		Required – Defines whether to scan assemblies in the /bin folder to discover classes decorated with any of the EPiServer class decoration attributes.

<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. It can have any name and is arbitrary in number.

<virtualRoles>

<virtualRoles failSafeIsInRole="bool"
              replacePrincipal="bool"
              replicationType="string"
              addClaims="bool">
   <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 (when replacePrincipal is set to true). Set to true to stop IsInRole from throwing an exception.
ReplacePrincipal	false	Defines whether the HttpContext.Current.User IPrincipal object is wrapped in a VirtualRolePrincipal. Use addClaims instead when possible.
AddClaims	false	Defines whether to add virtual roles as claims on the HttpContext.Current.User IPrincipal object. You cannot combine it with replacePrincipal. Requires EPiServer.CMS.Core 7.14 or higher.
ReplicationType	EPiServer.ApplicationModules.Security.VirtualRoleReplication, EPiServer.ApplicationModules	The full name of the class handling 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 should collected statistics be saved to the repository.
enabled	true	Defines whether to collect statistics.

<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.

<blob>

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

<blob> element attributes

Name	Default value	Description
defaultProvider		Required – The provider's name. 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 blob provider class.

<event>

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

<event> element attribute

Name	Default value	Description
defaultProvider		Required – The provider's name. 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 event provider class.