Configuring the MATRIXX Backoffice Customer Tool Display Header

MATRIXX Backoffice Customer Tool administrators can customize the appearance of the header in MATRIXX Backoffice Customer Tool UI.

The HEADER setting in the settings.json file allows you to configure the appearance of the header in the MATRIXX Backoffice Customer Tool UI. The following example shows the format of the HEADER settings:
"HEADER": {
  "element_display": {
    "header": true,
    "logo": true,
    "username": true,
    "navigation": true,
    "recents": true,
    "help": true,
    "logout": true
  },
  "custom_elements": {
    "links": [],
    "logo": ""
  }
}
The HEADER setting specifies two objects: element_display and custom_elements.

By specifying true or false for the parameter values in the element_display object, you can turn the following elements of the UI header on or off, as shown in element_display Object Settings.

Table 1. element_display Object Settings
Parameter Value
header Specifies whether the header appears in the UI.
logo Specifies whether the MATRIXX logo appears in the header.
username Specifies whether the username of the logged in user appears.
navigation Specifies whether navigation links appear in the header.
recents Specifies whether the Recents selection appears in the header. The "NUM_ITEMS_IN_RECENTS" setting in the settings.json file controls how many items are listed when a user clicks Recents in the MATRIXX Backoffice Customer Tool header. The default setting is "NUM_ITEMS_IN_RECENTS": 10.
help Specifies whether the online help icon (a question mark that appears between the username and the Logout selection if that setting is enabled) is displayed at the top of the page. The default setting is true (the online help system is enabled).
logout Specifies whether the Logout selection appears in the header.

The custom_elements object lets you add custom links or override the logo image The following example shows a HEADER setting with links and a logo specified: 

{
  "element_display": {
    "header": true,
    "logo": true,
    "username": true,
    "navigation": true,
    "recents": true,
    "logout": true
  },
  "custom_elements": {
    "links": [
      { name: "← Return to Home",
        param: "hmUrl" },
      { name: "← Return to Jendesk",
        param: "jdUrl" }
    ],
    "logo": "https://placekitten.com/100/40"
  }
}

custom_elements Object Settings describes the settings specified in the custom_elements object.

Table 2. custom_elements Object Settings
Parameter Value
links Specifies an array of links that appear in the UI header.
Each link is specified as an object with attributes name and param. For example: 
{ name: "Return to OtherApp",
  param: "oaUrl" }

The name value is the text that appears in the header. The param value should match a URL query parameter. For example: http://127.0.0.1/home? oaUrl=http:%2F%2Fgoogle.com
logo Specifies the path to a logo image. This image overrides the default MATRIXX Backoffice Customer Tool logo. For example: 
"logo": "https://placekitten.com/100/40"
  }