Loading TOC...
XQuery admin:ui-set-banner

admin.uiSetBanner

admin.uiSetBanner(
   banner-options as Object
) as emptySequence

Summary

This function sets the banner that will appear on the qconsole page and the admin GUI page.

Parameters
banner-options The banner-options parameter is a JavaScript Object that specifies different attributes of the UI banner. Keys that are omitted will use default value to set up the banner. The accepted keys are the following:
active
The banner will show up if the value is set as fn:true(). The banner will be hidden if it is set as fn:false().
label
The label text that will be displayed on the banner. The default value is "Envirnoment Label".
headerColor
The color of the banner background. The value of this key should be HTML color hex code. The default value is "#FF6666".
headerTextColor
The color of the banner text. The value of this key should be HTML color hex code. The default value is "#000000".
message
The text message that will be displayed when the user log into the qconsole/admin GUI for the first time. The default value is "Message of the Day".
topBannerLabel
The label text that will be displayed on the banner that goes across the top of the UI. The default value is null which means the banner will not be displayed.
topBannerStyle
The CSS style to use as an inline style for the banner that goes across the top of the UI. The default value is null which uses the default banner style.

Required Privileges

http://marklogic.com/xdmp/privileges/admin/ui-banner

Example


//This set the UI banner for the qconsole and admin GUI

const admin = require('/MarkLogic/admin.xqy');

admin.uiSetBanner({
  "active": true,
  "label": "Welcome to the PRODUCTION STAGING cluster",
  "headerColor": "#33CC99",
  "headerTextColor": "#000000",
  "message": "This cluster will be unavailable on odd Tuesdays of even months.",
  "topBannerLabel": "This goes at the top",
  "topBannerStyle" : "background-color:#33CC99;color:#000000;font-family:arial;font-size:16px;font-style:bold;text-align:center;"
})

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.