How to dashboards rendered in the dashboard listing page

Published:

In Bold BI Embedded Analytics Server, we can be able to render the dashboards in the dashboard listing page directly instead of opening it in new browser tab. This article will guide you on how to achieve it using the configuration file.

Configuring Dashboard view in the dashboard listing page using configuration file

To configure the dashboard to be viewed in the dashboard listing page in Bold BI Embedded Analytics Server, follow the steps below:

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.
Set the value of the 'SamePagePreview' node under “Profiles” -> “Dashboards“ to true, and save the changes,
Sample output:

Here’s a sample code for configuring the SamePagePreview in Profiles section:

  "Profiles": [
    {
      "Name": "profile1",
      "Dashboards": {        "ShowMenu": true,
        "SamePagePreview": true,
        "Order":1,
        "Scheme":""         
       }
    }
  ]

Allowed Values for SamePagePreview

The allowed Boolean values for the SamePagePreview node are:

false
true

Sample Configuration for specific tenant

"Sites": [
    {
      "Name": ["site1"],
      "Profile": "profile1"
    },
    {
      "Name": ["site2"],
      "Profile": "profile2"
    }
],
"Profiles": [
  {
   "Name": "profile1",
   "Dashboards":{
    "ShowMenu": true,
    "SamePagePreview": true,
    "Order":1,
    "Scheme":"" 
   } },
 {
   "Name": "profile2",
   "Dashboards": {
       "ShowMenu": true,
       "SamePagePreview": false,
       "Order":1,
       "Scheme":""
  }
 }
]

Sample Configuration for all tenants

"Sites": [
    {
      "Name": ["*"],
      "Profile": "profile_name"
    }
],
“Profiles”: [
 {
   "Name": "profile_name",
   "Dashboards": {
      "ShowMemu": true,
      "SamePagePreview": true,
      "Order":1,
      "Scheme":""
  }
 }
]

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"
    }
],
"Profile": [
  {
      "Name": "profile1",
      "Dashboards": {
         "ShowMenu": true,
         "SamePagePreview" true,
         "Order": 1,
         "Scheme": ""
     }
   },
   {
      "Name": "profile2",
      "Dashboards": {
         "ShowMenu": true,
         "SamePagePreview: true,
         "Order": 2,
         "Scheme": ""
   }
  }
]

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 Nagaraj Manimaran

Updated:

Comments (0)