User Interface Customization in Bold BI Embedded Analytics

This section explains how to customize Bold BI application user interface in terms of adding custom menus, menu items listing, showing preview, etc. with a configuration file.

NOTE: This feature is available in Bold BI Embedded Analytics but not in Cloud Analytics Server.

You can make your own selections, about what you want to see or set preferences for how information is to be organized or displayed.

Configuration for layout customization

Steps to open and edit the custom_ui.json file to customize the user interface.

Go to the UMS Settings page.

Example: http://{yourdomain}/ums/administration
Select the Configuration tab from the settings menu and choose custom_ui.json on the Search your files drop-down.
Fill in the required fields in the file and Save.
Restart the application and access the site. Refer to this link to learn how to restart the Bold BI application.

Custom UI JSON

CustomUI json file contains the following fields, which is used to customize UI in Bold BI application.

Sites
Profiles
Preview pane
Schemes
Custom menus

Sites

You need to provide the site name and matching profile name, which you want to customize UI.

Sites

Profiles

This section contains list of default left side menu options and custom menus.

profiles

Profile syntax

	  "Profiles": [
		{
		  "Name": "profile1",
		  "Dashboards": {
			"ShowMenu": true,
			"SamePagePreview": false,
			"Order": 1,
			"Scheme": ""
		  },
		  "Datasources": {
			"ShowMenu": true,
			"Order": 2,
			"Scheme": ""
		  },
		  "Schedules": {
			"ShowMenu": true,
			"Order": 3,
			"Scheme": ""
		  },
		  "Slideshows": {
			"ShowMenu": true,
			"Order": 4,
			"Scheme": ""
		  },
		  "Pinboards": {
			"ShowMenu": true,
			"Order": 5
		  },
		  "Publish": {
			"ShowMenu": true,
			"Order": 6
		  },
		  "Users": {
			"ShowMenu": true,
			"Order": 7
		  },
		  "Settings": {
			"ShowMenu": true,
			"Order": 8
		  },
		  "Notifications": {
			"ShowMenu": true,
		  },
          "Profile": { 
            "ShowMenu": true, 
            "ShowYourSites": true, 
            "ShowManageSite": true, 
            "ShowMyProfile": true, 
            "ShowLogout": true
          },
		  "Help": { 
			"ShowMenu": true 
		  },
		  "CustomMenu": [
			{
			  "Name": ""
			}
		  ]
		}
	  ]

Name: Provide the name of the profile which will be used to specify the profile in the sites.
ShowMenu: Decides whether that particular left side menu option is to be shown or hidden.
Order: It decides the position of the particular menu option.
Scheme: Provide the matching scheme name. The scheme will be used to customize the options in the item listing and the context menu.

Preview pane

You can preview the dashboards on the right side of the dashboard listing by using the SamePagePreview property in the configuration file.

SamePagePreview

Schemes

The scheme can be used to show or hide the context menu items in the item listing pages. These options are available in dashboards, slideshows, schedules, and data sources page.

Schemes

For example, you can show the Get Link option in the context menu by setting the GetLink property as true, and also the corresponding scheme name needs to be mentioned in the profile.

You can add new menu items which you want to show in the left side menu with the default side menu items.

Name: Specify the name of the scheme. This can be used to specify the scheme in the profiles.
Display: Name that needs to be displayed in the menu item.
Order: Position of the menu item while displaying in the left side menu bar.
ImageLink: URL of the image that needs to be shown in the menu item.
OpenLink: URL of the site/page that needs to be navigated on clicking the menu item.
OpenBehavior: Decides whether the custom menu page can be opened on the same page or in a new tab.
ShowMenu: Decides whether the custom menu is to be shown or hidden.