HomeGuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityOptimizely GitHubOptimizely NuGetLog In

episerver.framework

The following XML pseudocode describes the <episerver.framework> section of the configuration file for CMS 10 and 11.

The Configuration topic describes the syntax used in the description of the configuration elements.

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

<episerver.framework> element attributes

NameDefault valueDescription
createDatabaseSchemafalseDefines whether the database schema should be automatically created if missing from the configured database. See Installing database schema for more information.
updateDatabaseSchemafalseDefines whether the database schema should be automatically updated in case a newer schema is required by the current application. See Automatic schema updates for more information.

<clientResources>

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

<clientResources> element attributes

NameDefault valueDescription
debugfalseDefines if debug versions of included scripts are used instead of optimized versions.
compresstrueDefines if data from REST stores should be delivered in compressed format.

<geolocation>

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

<geolocation> element attributes

NameDefault valueDescription
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

NameDefault valueDescription
name Required. A unique name identifying this provider.
typefalseRequired. 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

NameDefault valueDescription
FallbackBehaviorFallbackBehaviors.EchoThe 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.
FallbackCultureenThe 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

NameDefault valueDescription
name Required. A unique name identifying this provider.
physicalPath A physical directory path to where language files are located.
fileSystemWatchPathSame 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 attribute

NameDefault valueDescription
forceBinFolderScanfalseDefines whether all assemblies in the /bin folder should be scanned to discover classes decorated with any of the EPiServer class decoration attributes.

<add> element attribute

NameDefault valueDescription
assembly Required. Defines whether all assemblies in the /bin folder should be scanned to discover classes decorated with any of the EPiServer class decoration attributes.

<virtualPathProviders>

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

<add> element attributes

NameDefault valueDescription
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"
                  addClaims="bool">
       <providers>
          <add name="string"
               type="string" />
          ...
       </providers>
    </virtualRoles>

<virtualRoles> element attributes

NameDefault valueDescription
FailSafeIsInRolefalseDefines 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.
ReplacePrincipalfalseDefines whether the HttpContext.Current.User IPrincipal object is wrapped in a VirtualRolePrincipal. Use addClaims instead when possible.
AddClaimsfalseDefines if virtual roles should be added as claims on the HttpContext.Current.User IPrincipal object. Cannot be combined with replacePrincipal. Requires EPiServer.CMS.Core 7.14 or higher.
ReplicationTypeEPiServer.ApplicationModules.Security.VirtualRoleReplication, EPiServer.ApplicationModulesThe full name of the class that will handle replication of changes in virtual roles.

<add> element attributes

NameDefault valueDescription
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

NameDefault valueDescription
commitToRepositoryInterval0.00:20:00How often collected statistics should be saved to the repository.
enabledtrueDefines whether statistics should be collected.

<licensing>

<licensing licenseFilePath="string"/>

<licensing> element attributes

NameDefault valueDescription
licenseFilePathLicense.configThe relative or absolute path to the license file.

<appData>

<appData basePath="string"/>

<appData> element attributes

NameDefault valueDescription
basePath The path to the application data.

<blob>

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

<blob> element attributes

NameDefault valueDescription
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

NameDefault valueDescription
name Required. A unique name identifying this provider.
typefalseRequired. The full name of the blob provider class.

<event>

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

<event> element attribute

NameDefault valueDescription
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

NameDefault valueDescription
name Required. A unique name identifying this provider.
typefalseRequired. The full name of the event provider class.

What’s Next