Loading...
Area: Optimizely CMS
Applies to versions: 12 and higher
Other versions:

Configuring episerver UI

Recommended reading 
Note: This documentation is for the preview version of the upcoming release of CMS 12/Commerce 14/Search & Navigation 14. Features included here might not be complete, and might be changed before becoming available in the public release. This documentation is provided for evaluation purposes only.

This 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.

In this topic

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 scheme and port.
EditUrl "~/EPiServer/CMS/" Gets or sets the URL to the edit UI. It must be a Web URL, and may include scheme and port.
ApprovalStepRoleUserLimit 100 Defines the amount of user roles which would trigger a warning when an administrator sets up approval step
WebSocketEnabled true Defines if the WebSocket connection between 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 in milliseconds for the time to load 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 of media should automatically be published when uploaded to CMS.

PublicModuleOptions

Contain settings for public shell modules.

Name Default value Description
RootPath "~/modules/" The root path below which module directories are located.
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 all public shell modules to register.

ProtectedModuleOptions

Contain settings for protected shell modules.

Name Default value Description
RootPath "~/EPiServer/" The root path below which 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.

ImageEdtiorOptions

Contain settings for the Image Editor in CMS user interface.

Name Default value Description
Enabled true Specifies if the image editor should be enabled.
WindowWidth 0 Sets a preferred width of the image editor. 
WindowHeight 0 Sets a preferred height of the image editor.
SizePresets 320*240, 640*480  A list of predefined PresetElement sizes that can be used in crop and resize operations.

PresetElement

Contain 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.

UploadOptions

Contain settings for file uploads.

Name Default value Description
FileSizeLimit 4MB Specifies the size limit for uploads in bytes.

SelectionFactoriesOptions

Provide 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

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

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

ApprovalNotificationOptions

Contain settings for configuring approval notifications in CMS user interface.

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

ApplicationOptions

Contain 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 aspnet identity schema should be disabled.

RestCacheOptions

Contain settings for 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
Do you find this information helpful? Please log in to provide feedback.

Last updated: Jul 02, 2021

Recommended reading