Configuring episerver

This is a pseudocode description of the element structure of the episerver section of the configuration file. Refer to the Configuration section for an explanation of the syntax used in the description of the configuration elements.

<episerver>
   <imageEditor>
   <linkValidator>
   <contentProvider>
   <applicationSettings>
   <tinyMCE>
   <urlRewrite>
   <visitorGroup>
   <workflowSettings>
</episerver>

<imageEditor>

<imageEditor enabled="bool"
             windowHeight="int"
             windowWidth="int">
   <sizePresets>
      <preset height="int"
              name="string"
              languageKey="string"              
              width="int" />
      ...
   </sizePresets>
</imageEditor>

<imageEditor> element attributes

Name	Default Value	Description
enabled	true	Indicates if the image editor is used in edit mode.
windowHeight	600	The preferred height and width of the image editor. This is the final fallback, settings on the property level have precedence.
windowWidth	900

The values for the imageEditor section have defaults defined in code equivalent to the following:

<imageEditor windowWidth="900" windowHeight="600" enabled="true">
  <sizePresets>
    <preset width="320" height="240" />
    <preset width="640" height="480" />
  </sizePresets>
</imageEditor>

<preset> element attributes

Name	Default Value	Description
height		The image preset height in pixels.
name		Name for to be shown in the preset selection list. If not specified the name shown will be "width x height"
languageKey		A language key to where localized name strings can be found.
width		The image preset width in pixels.

<linkValidator>

<linkValidator externalLinkErrorThreshold="int"
               internalLinkValidation="EPiServer.Configuration.LinkValidator.ValidationType"
               maximumRunTime="TimeSpan"
               proxyAddress="string"
               proxyDomain="string"
               proxyPassword="string"
               proxyUser="string"
               recheckInterval="TimeSpan"
               userAgent="string" />
   <excludePatterns>      
        <add regex="string" />
      ...
   </excludePatterns>
</linkValidator>

<linkValidator> element attributes

Name	Default Value	Description
externalLinkErrorThreshold	100	The threshold for the number of consecutive errors that need to occur before the job stops.
internalLinkValidation	ValidationType.Api	How the link validator will validate internal links. The ValidationType enum has three possible values: Off. Do not validate internal links. Api. Validate by API, in other words call GetPage for the referenced page and verify that the page exists. Does not detect errors that occur in page template code. Request. Validate by HTTP request. This method is the most thorough as it simulates clicking the link. Detects errors that occur in page template code.
maximumRunTime		The maximum time the job will run at one time.
proxyAddress		Optional web proxy address for the link checker to use when validating links.
proxyDomain		Optional web proxy domain to authenticate the proxy connection.
proxyPassword		Optional web proxy password to authenticate the proxy connection.
proxyUser		Optional web proxy user for to authenticate proxy connection.
recheckInterval	7.00:00	The time that must elaps before a link is rechecked.
userAgent	EPiServer Link Checker	The user agent string to use when checking validity of links.

<add> element attributes

Name	Default Value	Description
regex		Required. A regular expression matching a link that should be ignored by the link validation.

<contentProvider>

<contentProvider>
   <providers>
      <add capabilities="EPiServer.Core.ContentProviderCapabilities"
           entryPoint="int"
           iconPath="string"
           name="string"
           pageFolderVirtualPathProvider="string"
           supportedVirtualPathProvider="string"
           type="string"
           wastebasketName=string />
      ...
   </providers>
</contentProvider>

<add> element attributes

Name	Default Value	Description
capabilities	ContentProviderCapabilities.None	The capabilites that are supported by this content provider. ContentProviderCapabilities is a Flags enum, meaning that you can combine any number of values. Please refer to the SDK documentation for more detailed information about the possible values.
entryPoint		Required. The ID of the page that will act as a container for the contents delivered from this content provider.
iconPath		The path to an icon image file. The icon will be shown in the page tree to distinguish pages served by this content provider instance. The path given should be relative the theme folder "App_Themes/Default/Images/ExplorerTree/PageTree/".
name		A short descriptive name used to identify the content provider. If you set name to "default" that content provider will replace the DefaulteProvider as the default  content provider.
pageFolderVirtualPathProvider		The name of the virtual path provider that should be used for page folders for this page provider.
supportedVirtualPathProvider		A comma separated list of virtual path provider names. Only files contained within the listed virtual path providers can be referenced from pages hosted by this page provider.
type		The full classname of the page provder class.
wastebasketName		The name of the wastebasket for this provider instance. If this attribute is not present the name will be equal to the value of the name attribute.

<applicationSettings>

<applicationSettings
              disableVersionDeletion="bool"
              enableScheduler="bool"
              globalErrorHandling="RemoteOnly|On|Off"
              googleMapsApiV3Url="string"
              httpCacheability="System.Web.HttpCacheability"
              httpCacheExpiration="TimeSpan"
              httpVaryByCustom="string"
              httpVaryByParams="string"
              IISHiddenSegments="string"
              mirroringMonitoringMaxDataPerJob="int"
              mirroringSource="string"
              operationCompatibility="EPiServer.Configuration.EPiServerCompatibility"
              pageCacheSlidingExpiration="TimeSpan"
              pageFolderVirtualPathProvider="string"
              pageUseBrowserLanguagePreferences="bool"
              pageValidatePageTemplate="bool"
              permanentEditRetainPeriod="TimeSpan"
              remotePageCacheSlidingExpiration="TimeSpan"
              remoteWebServiceCulture="int"
              sgmlParserDecodeCharEntities="bool"
              stringCompressionThreshold="int"
              stringDelayedLoadThreshold="int"
              subscriptionHandler="string"
              uiKeepUserLoggedOn="bool"
              uiMaxVersions="int"
              uiOptimizeTreeForSpeed="bool"
              uiSafeHtmlTags="string"
              uiShowGlobalizationUserInterface="bool"
              uiTheme="string"
              uiUrl="Uri"
              UrlPreventRewriteAttribute="string"
              urlRebaseKind="string"
              urlRewriteExtension="string"
              utilUrl="Uri"
               />

<applicationSettings> element attributes

remotePageCacheSlidingExpiration2:0:0The page cache for remote sites.

Name	Default Value	Description
backgroundCopyThreshold	50	The threshold value for the maximum number of pages that can be copied in the current thread. If a copy operation is requested with a larger number of pages than the threshold the copy operation is performed in a background thread.
disableVersionDeletion	false	Defines if the UI should disable tools that allow page and file versions to be deleted.
enableScheduler	true	Set to false to disable this application's connection to the scheduler service. This setting is typically used in a load balanced scenario when you want to make sure that scheduled jobs are only run on a specific machine.
globalErrorHandling	RemoteOnly	Set whether to use EPiServer CMS error handling with the following possible values: On, Off or RemoteOnly. On. EPiServer CMS hides the original error and a generic error message is displayed instead. Off. Errors are not handled by EPiServer CMS. Errors will be handled by ASP.NET as defined in the customErrors element. RemoteOnly. Error handling is On for all visitors except for those accessing the site from the web server itself.
googleMapsApiV3Url	http://maps.google.com/maps/api/js?v=3.1&sensor=false	The URL for Google Maps API v3, possibly site-specific.
httpCacheability	HttpCacheability.Server	The HttpCacheability enum for the Cache-Control HTTP header.
httpCacheExpiration	0:0:0	The amount of time that a page should be cached in the outputcache, this value will be set in the http request policy. It will activate both client side caching and server caching outputcache. Policy will only apply to anonymous users and when http request method is GET. The cache will automatically be updated when changes are made to a page in EPiServer CMS.
httpVaryByCustom	browser	Specifies a custom text string to vary cached output responses by. Passed to Response.Cache.SetVaryByCustom.
httpVaryByParams	id	The parameters to the page (in other words query string) that the cache should vary by. HttpVaryByParams should read httpCacheVaryByParams. Forwarded to Response.Cache.SetVaryByParams.
IISHiddenSegments	bin, app_code, app_globalresources, app_localresources, app_webreferences, app_data, app_browsers	Defines IIS’ hidden segments in comma-separated format.
mirroringFileWriteRetryDelay	0:0:5	Setting for the EPiServer CMS 5 version of mirroring which by default is not enabled when you install an EPiServer CMS 6 site. Delay time between retrying to transmit mirroring files.
mirroringHtmlTextEncoding	String.Empty	Setting for the EPiServer CMS 5 version of mirroring which by default is not enabled when you install an EPiServer CMS 6 site. Sets which encoding should be used when mirroring to HTML.
mirroringMonitoringMaxDataPerJob	1000	The maximum number of monitoring data messages that are kept during a mirroring session. For example, if mirroringMonitoringMaxDataPerJob is set to 100 and the 101st monitoring data messsage is recieved, the oldest/first message will be pushed out of the log.
mirroringRetries	5	Setting for the EPiServer CMS 5 version of mirroring which by default is not enabled when you install an EPiServer CMS 6 site. Number of retries when a mirroring job fails.
mirroringRetryDelay	0:0:1	Setting for the EPiServer CMS 5 version of mirroring which by default is not enabled when you install an EPiServer CMS 6 site. The time delay between mirroring retries.
mirroringSource	mirroringSourceEndpoint	The name endpoint to use when communicating with the mirroring service. A client endpoint with the specified name must be registered in the <system.serviceModel> element in web.config.
operationCompatibility	EPiServerCompatibility.None	A set of EPiServerCompatibilty flags, currently no flags are being used but more may be added as required. None. There is no Compatibility at all. PageStoreSave. *Compatibility removed in CMS 7* Simulate Save behaviour from CMS 5 R1 in the DataFactory class. PageStoreDelete. *Compatibility removed in CMS 7* Simulate Delete behaviour from CMS 5 R1 in the DataFactory class. Full. Enable all compatibility flags.
pageCacheSlidingExpieration	12:0:0	The page cache for the local database.
pageFolderVirtualPathProvider	EPiServerPageDirectory	Name for the VirtualPathProvider that is responsible for handling of page folders. The provider collection in the virtualPathProvider element in the episerver.framework section must contain a provider with the specified name.
pageUseBrowserLanguagePreferences	false	Determines if the browser language should define which language is used.
pageValidatePageTemplate	true	Defines if the current template has to match the page type template.
permanentEditRetainPeriod	30.0:0:0	The amount of time that a page's permanent edit status should be retained. The permanent edit status will be cleared by the Remove Permanent Editing scheduled job if the status has been active longer than the time span specified in permanentEditRetainPeriod.
remoteWebServiceCulture	0	The culture to be used when communicating with a remote web service.
sgmlParserDecodeCharEntities	false	Defines whether SgmlParser should decode character entitities (like "&#32;") or not.
stringCompressionThreshold	0	The threshold value for the number of characters required in properties deriving from PropertyLongString to enable compression. A value of 0 turns string compression off.
stringDelayedLoadThreshold	255	The threshold value for the number of characters required in properties deriving from PropertyLongString to enable delayed loading of the property value. A value of 0 turns delayed loading off.
subscriptionHandler	EPiServer.Personalization.SubscriptionMail, EPiServer	Full class name to the class that should handle subscription mail. The class must implement ISubscriptionHandler.
uiKeepUserLoggedOn	true	Sets if the current windows authenticated user must reauthenticate after session timeout.
uiMaxVersions	20	The maximum number of page versions that EPiServer will retain. Set to 0 for unlimited number of versions.
uiOptimizeTreeForSpeed	false	Defines if page tree controls should evaluate if tree nodes have children. If set to false, tree controls will not evaluate if a node has children when it becomes visible. Only nodes that have children will display an expand icon ([+]), i.e. [+]NodeName. If set to true, tree controls will not evaluate if a node has children when it becomes visible. Thus all nodes will display an expand icon, regardless of if it has children or not. This behaviour will increase performace when displaying large tree structures.
uiSafeHtmlTags	b,i,u,br	Defines which tags should not be encoded.
uiShowGlobalizationUserInterface	false	Defines if the globalization tools should be available in the UI.
uiTheme	String.Empty	Setting for what graphical theme should be used. The value must correspond to a name of a subfolder in the App_Themes folder. The Default theme is used if no other value is specified.
uiUrl	~/UI/	Required. The URL to the relocateable UI folder. It must be a Web URL, and may include scheme and port.
UrlPreventRewriteAttribute	EPiNoRewrite	This setting only applies to the EPiServer CMS 5 editor. For internal use, do not use. Defines the HTML attribute name that is used by the CMS 5 legacy editor when writing / parsing content.
urlRebaseKind	Default	Defines the type of rebasing to do for links when using Friendly URLs. Possible values are any combination of EPiServer.UrlBuilder.RebaseKind flags.
urlRewriteExtension	String.Empty	Defines an extension that is mapped to ASP.NET for the URL. During the URL rewrite step, before a HTTP response is sent to the client, the urlRewriteExtension value will be added as a suffix to all links that points to pages on the site. Likewise, during the URL rewrite step at the beginning of a request, the suffix is removed.
utilUrl	~/Util/	Required. The URL to the relocateable Util folder. It must be a web URL, and may include scheme and port.
enableModelSyncCommit	true	Set to false to disable the commit phase when synchronizing typed models. Block types and page types will not be updated automatically in the database. This can be useful when a team of developers shares a database.

<tinyMCE>

<tinyMCE mergedConfigurationProperties="string" />

<tinyMCE> element attributes

Name	Default Value	Description
mergedConfigurationProperties	valid_elements, extended_valid_elements, invalid_elements, valid_child_elements	Properties that will be mergable for plugins in TinyMCE. If several TinyMCE plugis set different values for any of the configuration options listed in this attribute these values will be merged.

<urlRewrite>

NOTE: The urlRewrite element configures a legacy feature that is not supported due to the introduction of Routing.

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

<urlRewrite> element attributes

Name	Default Value	Description
defaultProvider	HierarchicalUrlRewriteProvider	The name of the default provider. A provider with the specified name must exist in the providers collection.

The values for the urlRewrite section section have defaults defined in code equivalent to the following:

<urlRewrite defaultProvider="HierarchicalUrlRewriteProvider" >
  <providers>
    <add name="HierarchicalUrlRewriteProvider" description="EPiServer standard Friendly URL rewriter" type="EPiServer.Web.HierarchicalUrlRewriteProvider,EPiServer" />
    <add name="EPiServerIdentityUrlRewriteProvider" description="EPiServer identity URL rewriter" type="EPiServer.Web.IdentityUrlRewriteProvider,EPiServer" />
    <add name="EPiServerNullUrlRewriteProvider" description="EPiServer bypass URL rewriter" type="EPiServer.Web.NullUrlRewriteProvider,EPiServer" />
  </providers>
</urlRewrite>

In the event you want to change these defaults, you just need to specifiy the overriden values. The configuration specified in the file is merged with the default in code. As with the Microsoft standard, providers added in the providers element are merged with the defaults. To completely replace the defaults, add the <clear /> element as the first element in the providers collection.

<providers> and <add> element attributes

The HierarchicalUrlRewriteProvider (EPiServer.Web.HierarchicalUrlRewriteProvider), EPiServerIdentityUrlRewriteProvider (EPiServer.Web.IdentityUrlRewriteProvider) and EPiServerNullUrlRewriteProvider (EPiServer.Web.NullUrlRewriteProvider) providers are automatically added to the providers collection. To remove one or more of these, use the standard <remove> and <clear> elements.

Name	Default Value	Description
name		Required. A short descriptive name used to identify the URL rewrite provider.
type		Required. The full classname of the url rewrite provider.

<visitorGroup>

<visitorGroup>
   <searchKeyWordCriteria pattern="string" />
</visitorGroup>

<searchKeyWordCriteria> element attributes

Name	Default Value	Description
pattern	([#?&](amp;)?(q|p)=(?<query>[^&]+))	Regular expression used by the Search keyword visitor group criterion to extract search keywords from the referrer adress. If you choose to write you own regex to replace the default one, make sure that each keyword is caught by the "?<query>" capture group.

<workflowSettings>

<workflowSettings workflowDelayedLoading="bool" >
   <definitions>
      <definition description="string"
                  name="string"
                  type="string" />
      ...
   </definitions>
   <externalServices>
      <externalService type="string" />
      ...
   </externalServices>
   <externalTypes>
      <externalType type="string" />
      ...
   </externalTypes>
   <references>
      <reference path="string" />
      ...
   </references>
   <workflowHost type="string" />
</workflowSettings>

<workFlowSettings> element attributes

Name	Default Value	Description
workflowDelayedLoading		Defines if delayed loading should be used. If enabled instances and definitions are not loaded before first access

<definition> element attributes

Name	Default Value	Description
description		A description of the workflow.
name		Required. A short descriptive name used to identify the workflow.
type		Required. The full classname of the workflow.

<externalService> element attributes

Name	Default Value	Description
type		The full classname of an external type that is referenced from an external XAML file.

<reference> element attributes

Name	Default Value	Description
path		Path to an assembly that is needed by any of the registered workflows. Assemblies registered in the GAC need not be listed here.

<workflowHost> element attributes

Name	Default Value	Description
type	EPiServer.WorkflowFoundation.AspNetWorkflowManager, EPiServer.WorkflowFoundation	Full classname of the host that will host workflow instances. Registered class must implement IWorkflowManager.