HomeDev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunitySubmit a ticketLog In
GitHubNuGetDev CommunitySubmit a ticket

CmsUI section

Describes the various option classes that are part of the CmsUI section of the configuration.

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

UIOptions

Contain settings for CMS edit user interface.

NameDefault valueDescription
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.
ApprovalStepRoleUserLimit100Defines the number of user roles that would trigger a warning when an administrator sets up the approval step
WebSocketEnabledtrueDefines if the WebSocket connection between the server and the client should be enabled
PermanentEditRetainPeriod30 daysGets or sets the retain period for the page's "permanent edit" status.
PreviewTimeout15000 msThe timeout is in milliseconds for loading a preview of a content version.
UIShowGlobalizationUserInterfacetrueDefines if the globalization module should be used
DisableVersionDeletionfalseDefines if it should be possible to delete versions from UI.
AutoPublishMediaOnUploadtrueSpecifies if media should automatically be published when uploaded to Optimizely Content Management System (CMS).
ultValueForSetChangedOnPublishfalseDefines the default state of the Update modified date check box when editing a page.
UIDefaultValueForSetChangedOnPublishfalseDefines what the default state the Update modified date check box should be in when editing a page (available from EPiServer.CMS.UI 12.20.0)

PublicModuleOptions

Contain settings for public shell modules.

NameDefault valueDescription
RootPath"~/modules/"The root path; module directories are located below the root path.
AutoDiscoveryAutoDiscoveryLevel.ModulesSpecifies 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.

ProtectedModuleOptions

Contain settings for protected shell modules.

NameDefault valueDescription
The root path; module directories are located below the root path."~/EPiServer/"The root path below is where module directories are located.
AutoDiscoveryAutoDiscoveryLevel.MinimalSpecifies 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.
ItemsShell, CMS, EPiServer.Admin, EPiServer.Cms.UI.Settings, EPiServer.VisitorGroups.Management.UIA list of all protected shell modules to register.

ImageEditorOptions

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

NameDefault valueDescription
EnabledtrueSpecifies if the image editor should be enabled.
WindowWidth0Sets the preferred width of the image editor. 
WindowHeight0Sets the preferred height of the image editor.
SizePresets320*240, 640*480 A list of predefined PresetElement sizes that can be used in crop and resize operations.
SupportedEditExtensionjpg, jpeg, jpe, gif, bmp, png, tga, tiffA 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.

NameDefault valueDescription
NameSpecifies the name of the preset element.
Width0Sets the preset width in pixels. 
Height0Sets the preset height in pixels.
LanguageKey Specifies a language key used to localize the preset name.

UploadOptions

Contains settings for file uploads.

NameDefault valueDescription
FileSizeLimit4MBSpecifies the size limit for uploads in bytes.

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"
      }
    }
  }
}

ProjectUIOptions

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

NameDefault valueDescription
ProjectModeEnabledtrueIndicates if project mode should be enabled in UI.

ApprovalNotificationOptions

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

NameDefault valueDescription
ImmediatefalseIndicates if approval notifications should be sent immediately.

ApplicationOptions

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

NameDefault valueDescription
ConnectionStringOptionsConfigures the connection string to use.
DisableAutoCreateSchemafalseIndicates if the automatic creation of the ASP.net identity schema should be disabled.

RestCacheOptions

Contains settings for the cache of Rest responses.

NameDefault valueDescription
DisableResultCachingfalseSet to true to disable rest result caching.
SlidingCacheExpiration5 minSpecifies the sliding expiration for cached results