How to hide the profile, notification and help icons | Bold BI Embedded Analytics Server

Published:

We can hide the below highlighted items under profile section, notification and help icons in the tenant site of Bold BI Embedded Analytics Server through the configuration file. These settings will be applicable only when using the site identifier in the BI tenant site.

Steps to hide using the configuration file

Login with UMS admin user.
Go to UMS Configuration Settings page and choose custom_ui.json in the Search your files drop-down
URL: {domain_name}/ums/administration/config-editor
Obtain the site identifier of the BI tenant site from the Site URL say example, in the URL http://localhost/bi/site/site1, site1 is the site identifier.
If we need to configure for specific BI tenant sites, then provide those site identifiers as list in the Sites -> Name node or if same settings need to apply for all the BI tenant site, then we can provide "*" which is the wildcard for all the tenant sites instead of the providing each individual site identifiers list as shown below,
Apply for specific tenants Apply same settings for all the tenant sites
Then provide the profile name to know which profile settings needs to apply for the tenant site, since we can apply different settings for different tenant sites in the Profiles -> Name and Sites -> Profile nodes. For more details, please refer to the section which contains sample configurations.
Refer to the table below to hide the corresponding menus or icons.

	Node name	Screenshot
Notification	Notification -> ShowMenu	Once set false icon will be hidden as below,
Help	Help -> ShowMenu	Once set false icon will be hidden as below,
Profile	Profile -> ShowMenu	Once set false icon will be hidden as below,
Your Sites sub menu	Profile -> ShowYourSites	Once set false sub section will be hidden as below,
Manage Sites sub menu	Profile -> ShowManageSites	Once set false sub section will be hidden as below,
My Profile sub menu	Profile -> ShowMyProfile	Once set false sub section will be hidden as below,
Logout sub menu	Profile -> ShowLogout	Once set false sub section will be hidden as below,

Note: In order to hide other sub menus (Your Sites, manage Sites, My Profile or Logout) under the Profile menu, the node Profile -> ShowMenu should be set to true and respective sub menu should be set to false.

Once configured the above settings, save the configuration file by clicking the save button.

Sample Configuration for specific tenant

"Sites": [
    {
      "Name": ["site1"],
      "Profile": "profile1"
    },
    {
      "Name": ["site2"],
      "Profile": "profile2"
    }
],
“Profiles”: [
    {
   "Name": "profile1",


   "Notifications": {
            "ShowMenu": false
     },
    "Help": {
           "ShowMenu": false
     },
     "Profile": {
           "ShowMenu": false,
           "ShowYourSites": false,
           "ShowManageSite": false,
           "ShowMyProfile": false,
           "ShowLogout": false
      }
  },
 {
   "Name": "profile2",

   "Notifications": {
            "ShowMenu": true
     },
    "Help": {
           "ShowMenu": true
     },
     "Profile": {
           "ShowMenu": true,
           "ShowYourSites": true,
           "ShowManageSite": false,
           "ShowMyProfile": false,
           "ShowLogout": false
      }
  }
]

Sample Configuration for all tenants

"Sites": [
    {
      "Name": ["*"],
      "Profile": "profile_name"
    }
],
“Profiles”: [
    {
   "Name": "profile_name",
   
   "Notifications": {
            "ShowMenu": false
     },
    "Help": {
           "ShowMenu": false
     },
     "Profile": {
           "ShowMenu": false,
           "ShowYourSites": false,
           "ShowManageSite": false,
           "ShowMyProfile": false,
           "ShowLogout": false
      }
  }
]

Sample Configuration for specific tenant override wildcard

If there is a case where you are applying settings for all tenants using the wildcard key, but you need to apply the different settings for specific or some tenants, then you can separately define those settings for that specific tenant as shown below. Here, it will prioritize specific settings only.

"Sites": [
    {
      "Name": ["site1", "site2"],
      "Profile": "profile1"
    },
    {
      "Name": ["*"],
      "Profile": "profile2"
    }
],
“Profiles”: [
    {
   "Name": "profile1",

   "Notifications": {
            "ShowMenu": false
     },
    "Help": {
           "ShowMenu": false
     },
     "Profile": {
           "ShowMenu": false,
           "ShowYourSites": false,
           "ShowManageSite": false,
           "ShowMyProfile": false,
           "ShowLogout": false
      }
  },
 {
   "Name": "profile2",

   "Notifications": {
            "ShowMenu": true
     },
    "Help": {
           "ShowMenu": true
     },
     "Profile": {
           "ShowMenu": true,
           "ShowYourSites": true,
           "ShowManageSite": false,
           "ShowMyProfile": false,
           "ShowLogout": false
      }
  }
]

Reference

For more details about custom_ui configuration for other settings, please refer below link,

User interface customization in Bold BI embedded analytics

Was this article useful?

Dislike

Written by Amrutha Asokan

Updated:

Comments (0)