CmsUI section

11 min

The Configuration topic describes the syntax used to configure options from various configuration sources, such as configuration files or environment variables.

ApplicationOptions

Contains settings for configuring the CMS ASP.net identity integration.

Name	Default value	Description
ConnectionStringOptions		Configures the connection string to use.
DisableAutoCreateSchema	false	Indicates if the automatic creation of the ASP.net identity schema should be disabled.

ApprovalNotificationOptions

Contains settings for configuring approval notifications in the CMS user interface.

Name	Default value	Description
Immediate	false	Indicates if approval notifications should be sent immediately.

ImageEditorOptions

Contains settings for the Image Editor in the CMS user interface.

Name	Default value	Description
Enabled	true	Specifies if the image editor should be enabled.
WindowWidth	0	Sets the preferred width of the image editor.
WindowHeight	0	Sets the preferred height of the image editor.
SizePresets	320240, 640480	A list of predefined PresetElement sizes that can be used in crop and resize operations.
SupportedEditExtension	jpg, jpeg, jpe, gif, bmp, png, tga, tiff	A list of file extensions that support editing (with limited support for tiff files). Other file extensions may not work with editing.

PresetElement

Contains settings for an entry in ImageEditorOptions.SizePresets.

Name	Default value	Description
Name		Specifies the name of the preset element.
Width	0	Sets the preset width in pixels.
Height	0	Sets the preset height in pixels.
LanguageKey		Specifies a language key used to localize the preset name.

ProjectUIOptions

Contains settings for how projects should be handled in the CMS user interface.

Name	Default value	Description
ProjectModeEnabled	true	Indicates if project mode should be enabled in UI.

ProtectedModuleOptions

Contain settings for protected shell modules.

Name	Default value	Description
The root path; module directories are located below the root path.	"~/EPiServer/"	The root path below is where module directories are located.
AutoDiscovery	AutoDiscoveryLevel.Minimal	Specifies how module detection should be performed. AutoDiscovery enum has the following values: Minimal – Only modules explicitly added to Items will be registered. Modules – Will scan configured directory for modules.
Items	Shell, CMS, EPiServer.Admin, EPiServer.Cms.UI.Settings, EPiServer.VisitorGroups.Management.UI	A list of all protected shell modules to register.

PublicModuleOptions

Contain settings for public shell modules.

Name	Default value	Description
RootPath	"~/modules/"	The root path; module directories are located below the root path.
AutoDiscovery	AutoDiscoveryLevel.Modules	Specifies how module detection should be performed. AutoDiscovery enum has the following values: Minimal – Only modules explicitly added to Items will be registered. Modules – Will scan configured directory for modules.
Items		A list of public shell modules to register.

RestCacheOptions

Contains settings for the cache of Rest responses.

Name	Default value	Description
DisableResultCaching	false	Set to true to disable rest result caching.
SlidingCacheExpiration	5 min	Specifies the sliding expiration for cached results

UIOptions

Contain settings for CMS edit user interface.

Name	Default value	Description
UtilUrl	"~/Util/"	Gets or sets the URL to the Util part of the UI application. It must be a Web URL and may include a scheme and port.
EditUrl	"~/EPiServer/CMS/"	Gets or sets the URL to the edit UI. It must be a Web URL and may include a scheme and port.
ApprovalStepRoleUserLimit	100	Defines the number of user roles that would trigger a warning when an administrator sets up the approval step
WebSocketEnabled	true	Defines if the WebSocket connection between the server and the client should be enabled
PermanentEditRetainPeriod	30 days	Gets or sets the retain period for the page's "permanent edit" status.
PreviewTimeout	15000 ms	The timeout is in milliseconds for loading a preview of a content version.
UIShowGlobalizationUserInterface	true	Defines if the globalization module should be used
DisableVersionDeletion	false	Defines if it should be possible to delete versions from UI.
AutoPublishMediaOnUpload	true	Specifies if media should automatically be published when uploaded to Optimizely Content Management System (CMS).
UIDefaultValueForSetChangedOnPublish	false	Defines what the default state the Update modified date checkbox should be in when editing a page (available from EPiServer.CMS.UI 12.20.0)
UsePreviewTokens	false	Gets or sets a value indicating whether preview token should be appended to the preview url.

MediaFileOptions

Contains settings for file uploads.

Name	Default value	Description
FileSizeLimit	4 MB	Specifies the size limit for uploads in bytes.
AllowedFileExtensions		Specifies a comma separated list of file extensions that are allowed to be uploaded as assets. Empty or * will allow all.

SelectionFactoriesOptions

Provides options for selection properties. The option class inherits Dictionary<string,Dictionary<string,string>> and can be configured like:

"EPiServer": {
  "CmsUI": {
    "SelectionFactories": {
      "Test": {
        "Selection1": "Value1",
        "Selection2": "Value2"
      }
    }
  }
}