Articles in this section
Category / Section

How to set default custom sorting for dashboard listing

Published:

In Bold BI Embedded Analytics Server, the dashboard listing page is sorted with Recently Updated by default. This article will guide you on how to set preferred dashboard custom sorting using the configuration file.

Configuring Dashboard Sorting using configuration file

To configure the dashboard custom sorting in Bold BI Embedded Analytics Server, follow the steps below:

  1. Login with UMS admin user.

  2. 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

    image.png
  3. 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.
  4. 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,
    img3.pngApply for specific tenants 
    Apply same settings for all the tenant sites
  5. 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.
  6. Add the ItemSorting node if it is not present in the Profiles section with the desired sorting value and save the changes.

    image.png

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

{
  "Profiles": [
    {
      "Name": "profile1",
      "Dashboards": {},
      "Datasources": {},
      "Schedules": {},
      "Slideshows": {},
      "Pinboards": {},
      "Publish": {},
      "Users": {},
      "Settings": {},
      "CustomMenu": [
        {}
      ],
      "ItemSorting": "ItemNameDescending"
    }
  ]
}

Allowed Values for ItemSorting

The allowed values for the ItemSorting node are:

  • RecentlyUpdated
  • ItemNameAscending
  • ItemNameDescending


Sample Configuration for specific tenant

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

Sample Configuration for all tenants

"Sites": [
    {
      "Name": ["*"],
      "Profile": "profile_name"
    }
],
“Profiles”: [
    {
   "Name": "profile_name",   
   "ItemSorting":"ItemNameDescending"
  } ]

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",
   "ItemSorting":"ItemNameAscending"

  },
 {
   "Name": "profile2",
   "ItemSorting":"ItemNameDescending"

  }
]


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?
Like
Dislike
Help us improve this page
Please provide feedback or comments
DG
Written by Dhivyabharathi Govindaraj
Updated
Comments (0)
Please  to leave a comment
Access denied
Access denied