Web.config parameters

The system settings include appSettings keys and other settings, such as connection string placed in appropriate sections of the web.config file.

 

 

appSettings keys

 

appSettings keys are stored in section /configuration/appSettings.

 

Key

Description

Sample Value

CMSDirectoryProviderAssembly

Name of the assembly that should be used for operations in the file system. You can choose from the following options:

 

CMS.DirectoryProviderDotNet - this is a managed code library that uses System.IO methods for disk operations. It is useful for environment that allows only managed code. This is the default value.
 
CMS.DirectoryProviderWin32 - this is an unmanaged code library that uses Win32 API for disk operations. It is useful for environment that requires Win32 API calls.
 

<add key="CMSDirectoryProviderAssembly" value="CMS.DirectoryProviderDotNet" />

 

or

 

<add key="CMSDirectoryProviderAssembly" value="CMS.DirectoryProviderWin32" />

 

 

CMSProgrammingLanguage

Indicates the programming language used in transformations and in custom code added to web parts.

 

The default value is C#.

<add key="CMSProgrammingLanguage" value="C#" />

 

or

 

<add key="CMSProgrammingLanguage" value="VB" />
 

CMSSearchProviderAssembly

Name of the assembly that is used for full-text search. The default assembly is CMS.SearchProviderSQL.

<add key="CMSSearchProviderAssembly" value="CMS.SearchProviderSQL" />

CMSSendErrorsToEmail

E-mail address to which all exceptions are sent.

<add key="CMSSendErrorsToEmail" value="me@domain.com" />

 
 

CMSSendErrorsFromEmail

E-mail address from which exceptions are sent.

<add key="CMSSendErrorsFromEmail" value="me@domain.com" />
 

CMSStagingAcceptAllCertificates

Causes all certificates will be accepted when performing content staging tasks through SSL.

<add key="CMSStagingAcceptAllCertificates" value="true" />

CMSTrialKey

Contains a temporary trial key. You can remove this value after installation.


CMSUseAutomaticScheduler

Indicates if automatic scheduling should be used. The default value is false.

 

Automatic scheduler periodically requests the cmspages/scheduler.aspx page which ensures that scheduled tasks are processed automatically.

 

If it's turned off (false - by default), the tasks are processed at the end of page request. If it's true, the cmspages/scheduler.aspx page is requested periodically.

 

<add key="CMSUseAutomaticScheduler" value="false" />

CMSUseCustomHandlers

Indicates if custom handlers should be executed to process the system events.

 

The default value is false.

<add key="CMSUseCustomHandlers" value="true" />

CMSWebFarmServerName

Code name of the web farm server. This value is used for native web farm synchronization support.

<add key="CMSWebFarmServerName" value="server1" />

CMSWYSIWYGFixXHTML

Indicates if the WYSIWYG editor should automatically try to fix XHTML incompatibilities in the code.

 

Supported values are "true" and "false". The default value is true.

<add key="CMSWYSIWYGFixXHTML" value="true" />

CMSUseIFrameForHTMLEditorToolbar

Indicates if the WYSIWYG editor shared toolbar should be displayed in an iframe to avoid issues with design in the editing mode. The default value is false.

<add key="CMSUseIFrameForHTMLEditorToolbar" value="true" />

CMSUseVirtualPathProvider

Indicates if the virtual path provider should be used (true by default). Before you switch off the virtual path provider, please read chapter Pre-compilation (Publish function).

<add key="CMSUseVirtualPathProvider" value="false" />

CMSDefaultSpellCheckerCulture

Specifies the default culture of the built-in spell-checker. This culture is used when the dictionary for the currently selected content culture is not found.

<add key="CMSDefaultSpellCheckerCulture" value="en-US" />

CMSShowLogonCultureSelector

Indicates if the logon page should display the CMS Desk should display a dropdownlist with available user interface languages.

<add key="CMSShowLogonCultureSelector" value="false" />

CMSUsePermanentRedirect

Indicates if Response.Redirect (302, default mode) should be replaced with static redirect (301).

<add key="CMSUsePermanentRedirect" value="true" />

CMSShowWebPartCodeTab

Indicates if the Code tab is displayed in the web part properties. This parameter is used for backward compatibility.

<add key="CMSShowWebPartCodeTab" value="true" />

CMSShowWebPartBindingTab

Indicates if the Binding tab is displayed in the web part properties. This parameter is used for backward compatibility.

<add key="CMSShowWebPartBindingTab" value="true"/>

CMSShoppingCartExpirationPeriod

Number of days after which the shopping cart content is deleted from the database. It's used for deleting unused shopping carts of anonymous users that are stored in the database with ID stored in the browser cookie.

<add key="CMSShoppingCartExpirationPeriod" value="60" />

CMSUseCurrentSKUData

Indicates if the E-commerce module should use the price from the existing order items or from the current SKU data when re-calculating the order.

<add key="CMSUseCurrentSKUData" value="true"/>

CMSFullClientCache

Indicates if full client cache is enabled.

<add key="CMSFullClientCache" value="true"/>

CMSRenderGeneratorName

Indicates if generator meta tag is rendered.

<add key="CMSRenderGeneratorName" value="true"/>

CMSClearFieldEditor

Indicates if new field is empty (true) or has attributes from another field (false).

<add key="CMSClearFieldEditor" value="true"/>

CMSDeskKeepAlive

Indicates if refresh meta tag is inserted (true) or not (false).

<add key="CMSDeskKeepAlive" value="true"/>

CMSShowTemplateASPXTab

Indicates if ASPX tab is shown.

<add key="CMSShowTemplateASPXTab" value="true"/>

CMSDatabaseCulture

Specifies the default database culture.

<add key="CMSDatabaseCulture" value="en-us"/>

CMSDataProviderAssembly

Specifies custom data provider assembly.

<add key="CMSDataProviderAssembly" value="CMS.CustomDataProvider"/>

CMSWebFarmEnabled

Indicates if Web farms are enabled or not.

<add key="CMSWebFarmEnabled" value="true"/>

CMSDisposeConnectionAfterClose

If true, disposes connection after the connection is closed.

<add key="CMSDisposeConnectionAfterClose" value="true"/>

CMSUseSessionCookies

Indicates if session cookies are used or not.

<add key="CMSUseSessionCookies" value="true"/>

CMSImportWindowsRoles

Indicates if windows roles are imported or not.

<add key="CMSImportWindowsRoles" value="true"/>

CMSDefaultUICulture

Specifies the default UI culture.

<add key="CMSDefaultUICulture" value="en-us"/>

CMSFileScriptTimeout

Sets script timeout in seconds.

<add key="CMSFileScriptTimeout" value="7200"/>

CMSUseExtensionOnPostback

Indicates if extension is used on postback.

<add key="CMSUseExtensionOnPostback" value="true"/>

CMSUseSQLResourceManager

If true, SQL Resource manager is used to retrieve strings.

<add key="CMSUseSQLResourceManager" value="true"/>

CMSLoadHTMLEditorByIFrame

Indicates if HTML editor is loaded by iframe.

<add key="CMSLoadHTMLEditorByIFrame" value="true"/>

CMSUseFrameForHTMLEditorToolbar

Indicates if frame is used for editor toolbar.

<add key="CMSUseFrameForHTMLEditorToolbar" value="true"/>

CMSWYSIWYGFormatURL

If true, the editor runs the URL formatting.

<add key="CMSWYSIWYGFormatURL" value="true"/>

CMSAllowCheckIOPermissions

Indicates if IO (write) permissions checking is allowed.

<add key="CMSAllowCheckIOPermissions" value="true"/>

CMSEmailTransferEnconding

Specifies e-mail transfer encoding.

<add key="CMSEmailTransferEnconding" value="TransferEncoding.Unknown (-1)"/>

CMSEmailProviderAssembly

Specifies custom email provider assembly.

<add key="CMSEmailProviderAssembly" value="CMS.CustomEmailProvider"/>

CMSCheckParameters

Indicates if parameters checking is allowed.

<add key="CMSCheckParameters" value="true"/>

CMSReportCheckParameters

If true, exception reporting the parameters is thrown when the parameters do not match.

<add key="CMSReportCheckParameters" value="true"/>

CMSLogEvents

Indicates if logging is enabled.

<add key="CMSLogEvents" value="true"/>

CMSLogMetadata

Indicates if logging of metadata events is enabled.

<add key="CMSLogMetadata" value="true"/>

CMSLogKeepPercent

Coefficient for log deletion, keeps the specified percentage of log items alive and deletes the log by batch when the set percentage are exceeded.

<add key="CMSLogKeepPercent" value="10"/>

CMSCustomHandlersAssembly

Specifies custom event handler assembly.

<add key="CMSCustomHandlersAssembly" value="CMS.CustomEventHandler"/>

CMSWorkflowSendEmailToModerator

If true, e-mails will be sent to the current moderator.

<add key="CMSWorkflowSendEmailToModerator" value="true"/>

CMSControlElement

Overrides the generation of the SPAN tag with custom tag.

<add key="CMSControlElement" value="div"/>

CMSUseParsedSelfClose

Indicates if parsed self close tags operation (faster) are used instead of standard self close filter.

<add key="CMSUseParsedSelfClose" value="true"/>

CMSEnableOrderItemEditing

If true, order item's parameters, such as order item name and order item unit price, can be modified when editing an existing order.

<add key="CMSEnableOrderItemEditing" value="true"/>

CMSUseMetaFileForProductImage

Indicates if meta files should be used for product images.

<add key="CMSUseMetaFileForProductImage" value="true"/>

CMSUseCustomEcommerceProviders

Specifies whether to use custom e-commerce provider handlers.

<add key="CMSUseCustomEcommerceProviders" value="true"/>

CMSCustomEcommerceProviderAssembly

Specifies the custom e-commerce provider assembly.

<add key="CMSCustomEcommerceProviderAssembly" value="CMS.CustomECommerceProvider"/>

CMSVirtualPathProviderAssembly

Specifies the Custom virtual path provider assembly.

<add key="CMSVirtualPathProviderAssembly" value="CMS.CustomVirtualPathProvider"/>

CMSGetFileEndRequest

If true, ApplicationInstance.CompleteRequest() is used instead of Response.End() in CompleteRequest method.

<add key="CMSGetFileEndRequest" value="true"/>

CMSLogEventsToFile

If true, events are also logged into file.

<add key="CMSLogEventsToFile" value="true"/>

FCKeditor:BasePath

Specifies FCK editor base path.

<add key="FCKeditor:BasePath" value="/FCKeditor/"/>

FCKEditor:UserFilesPath

Specifies path to user files.

<add key="FCKEditor:UserFilesPath" value="/UserFiles/"/>

CMSDefaultUserID

Specifies default user ID.

<add key="CMSDefaultUserID" value="53"/>

ImportFilesDiskPath

Specifies path to files which may be imported.

<add key="ImportFilesDiskPath" value="C:\Temp"/>

UICulture

Specifies user interface culture.

<add key="UICulture" value="en-us"/>

 

 

Special settings for transaction isolation

 

You will use the following settings only in special cases when you encounter problems with deadlocks when updating a document:

 

 

Key

Description

Sample Value

CMSTransactionIsolationLevel

Isolation level for explicit transactions.
 

<add key="CMSTransactionIsolationLevel" value="ReadCommitted" />

 

 

CMSDefaultIsolationLevel

Isolation level for all queries, even without transactions. It's used only if the value is not ReadCommitted. The settings below modify the behavior for ReadUncommitted.

<add key="CMSDefaultIsolationLevel" value="ReadUncommitted" />

CMSUseDefaultIsolationLevelOnlyWithOpenTransactions

If true, the default isolation level is used only when some transaction is already running.

<add key="CMSUseDefaultIsolationLevelOnlyWithOpenTransactions" value="true" />

CMSAllowSimultaneousTransactions

If false, there can be only one transaction running at the same time.

<add key="CMSAllowSimultaneousTransactions" value="true" />

CMSMaxTransactionWaitTimeout

Indicates how many seconds a transaction should wait for completion of another running transaction if simultaneous transactions are not allowed.

<add key="CMSMaxTransactionWaitTimeout" value="1" />

 

 

 

Connection string

 

The database used by Kentico CMS engine is specified by the connection string CMSConnectionString in the /configuration/connectionStrings section. Here's an example of such connection string:

 

 

<add name="CMSConnectionString" connectionString="Persist Security Info=False;database=CMS;server=myserver;user id=sa;password=mypassword123;Current Language=English;Connection Timeout=120;" />