Skip to main content

Administrating MarkLogic Server

Configuration Reference

The /cluster-ui-settings.xml document in the App-Services database must have this structure. All elements are required:

<env-ui:environment-ui xml:lang="zxx" 
    xmlns:env-ui="http://marklogic.com/environment-ui">
  <env-ui:ui-active>boolean</env-ui:ui-active>
  <env-ui:ui-label>banner_text</env-ui:ui-label>
  <env-ui:ui-header-color>color_code</env-ui:ui-header-color>
  <env-ui:ui-header-text-color>color_code</env-ui:ui-header-text-color>
  <env-ui:ui-message>notification_dialog_text</env-ui:ui-message>
</env-ui:environment-ui>

This table describes the child elements in more detail:

Element Local Name

Description

ui-active

Set to true for the configuration to take effect. Set to false to return to the default behavior (no notification dialog or banner).

ui-label

Text to be displayed in the banner.

ui-header-color

The background color of the banner.

ui-header-text-color

The color of the message text in the banner.

ui-message

The message to be displayed in the notification dialog box. The message is displayed to user only once (per host from which the user connects to the cluster), unless you update the configuration with a new message.