HomeGuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityLog In

CmsUI section

This topic 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 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.
ApprovalStepRoleUserLimit100Defines the amount of user roles which would trigger a warning when an administrator sets up approval step
WebSocketEnabledtrueDefines if the WebSocket connection between server and the client should be enabled
PermanentEditRetainPeriod30 daysGets or sets the retain period for the page's "permanent edit" status.
PreviewTimeout15000 msThe timeout in milliseconds for the time to load 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 of media should automatically be published when uploaded to CMS.

PublicModuleOptions

Contain settings for public shell modules.

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

    ProtectedModuleOptions

    Contain settings for protected shell modules.

    NameDefault valueDescription
    RootPath"~/EPiServer/"The root path below which 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.

    ImageEdtiorOptions

    Contain settings for the Image Editor in CMS user interface.

    NameDefault valueDescription
    EnabledtrueSpecifies if the image editor should be enabled.
    WindowWidth0Sets a preferred width of the image editor. 
    WindowHeight0Sets a 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 supports editing (with a limited support for tiff files). Other file extensions may not work with editing.

    PresetElement

    Contain 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

    Contain settings for file uploads.

    NameDefault valueDescription
    FileSizeLimit4MBSpecifies 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.

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

    ApprovalNotificationOptions

    Contain settings for configuring approval notifications in CMS user interface.

    NameDefault valueDescription
    ImmediatefalseIndicates if approval notifications should be sent immediately.

    ApplicationOptions

    Contain settings for configuring the cms asp net identity integration.

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

    RestCacheOptions

    Contain settings for cache of Rest responses.

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

    Did this page help you?