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.
You can make your own selections, about what you want to see or set preferences for how information is to be organized or displayed.
Open custom_ui
json file from this location.
Hosted Environment | Location |
Windows |
Check this location for Bold BI version 4.1.36 or later "{application-installed-drive}\BoldServices\app_data\data". Check this location for Bold BI version below 4.1.36 "{application-installed-drive}\Bold BI\app_data\data". |
Linux | /var/www/bold-services/application/app_data/data |
Fill the required fields in the same file and save.
Restart the application, now you can see the changes reflecting in the UI.
Custom UI JSON
CustomUI json file contains the following fields, which is used to customize UI in Bold BI application.
Sites
You need to provide the site name and matching profile name, which you want to customize UI.
Profiles
This section contains list of default left side menu options and custom menus.
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.
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.
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.
Navigation menu customization
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.
Let us customize the site1
using the profile profile1
and scheme scheme1
.
Here, changed order of each side menu and applied same page preview support.
Here, we provided different schemes for dashboards, datasources, schedules and slideshows.
For example, Open
option will be shown in dashboard context menu and hidden in slideshow context menu.
Provided two different custom menu options: