Skip to main content

Administrating MarkLogic Server

Configuring a MarkLogic Application Message and Banner

This topic describes how to configure your cluster to display a notification dialog and an application banner when users navigate to one of the built-in MarkLogic application pages, such as Query Console or the Monitoring Dashboard.

Administrators might want to use this feature in situations like these:

  • To notify users of important system status changes, such as a planned outage.

  • To make it easy for users to distinguish among MarkLogic clusters, such as testing versus production environments.

The notification dialog is only displayed to each user once per host from which he or she connects to a MarkLogic application. If the notification message changes, the dialog will be displayed again, next time the user navigates to one of the affected applications.

Specify the UI configuration in the configuration document in the App-Services database with the URI cluster-ui-settings.xml and point the method to http://pubs.marklogic.com:8011/11.0/admin:ui-set-banner. MarkLogic installs a deactivated default configuration that you can use as a baseline for customization.