Dashboards Programmability
Info
The following feature is available as public beta in Flex UI version 1.27 and later. To use this feature, please make sure Insights - Programmable Dashboards public beta feature is enabled in your admin interface.
Info
A developer proxy is needed for local development. Please refer to the article about Local Development.
Starting version 1.27, Flex allows users to programmatically configure the Dashboards navigation. Currently setting a filter for the Dashboards is supported.
Warning
Please note that this feature is for convenience use only and cannot be considered a security feature. Even with filtering enabled, agents are technically still able to access the whole list of the dashboards they have permissions to view.
To explain how the filtering works, it is important to establish some terms and explain how the navigation works.
We currently support 2 different kinds of dashboards:
- The Project Dashboards , which group sets of Tabs, which you can select to display a dashboard,
- and Analytical Dashboards , which by themselves are the dashboards.
The Sidebar is used to list all the dashboards and tabs in a way which is easy to navigate. On top, there is a dropdown, which allows you to select between All Dashboards, My Dashboards and also allows you to select a specific Project Dashboard.
When All Dashboards are selected, the list will display all the Analytical Dashboards first and then every Project Dashboard along with its tabs.
When a specific Project Dashboard is selected, the list will only display its underlying tabs.
The dashboardsFilter determines which dashboards will be available in the dropdown at the top of the sidebar and as part of the navigation. The return value from the function dictates if the particular Dashboard will be displayed or hidden.
The function takes dashboard as an argument. This can be either an Analytical Dashboard or a Project Dashboard.
If false is returned for a Project Dashboard, it will disappear from both the dropdown and from the navigation - if "All Dashboards" is selected, along with all of its tabs. If you want to hide only some of the tabs, use the dashboardTabFilter prop.
If false is returned for an Analytical Dashboard, it will be hidden from the top of the navigation, when "All Dashboards" is selected.
The dashboard argument has the following shape:
_10identifier: string;_10category?: string;_10link?: string;_10title?: string;_10author?: string;_10tabs?: Array<{_10 title: string;_10 identifier: string;_10}>;_10widgets?: string[];
In this example, let's say you want to hide a dashboard named "Control Center":
_10Flex.Insights.DashboardsSidebar.defaultProps.dashboardsFilter =_10 (dashboard) => _10 dashboard.title !== "Control Center"
Sometimes you might not want to hide the whole Project Dashboard, but only some of its tabs. That's when this function comes in handy.
The function takes tab and a dashboard as its arguments. Each Project Dashboard tab is checked against this filter and the return value for that tab determines if the tab should be displayed or not. The dashboard argument is the Project Dashboard which the tab is part of. This allows you to decide not only based on the tab title itself, but also by the properties of the dashboard, as displayed in the example below.
The tab argument has the following shape:
_10title: string;_10identifier: string;
Let's say you want to hide a tab named Conversations which is part of the Control Center dashboard:
_10Flex.Insights.DashboardsSidebar.defaultProps.dashboardTabFilter =_10 (tab, dashboard) => _10 tab.title !== "Conversations" && dashboard.title !== "Control Center"
It might, however, be a better idea to filter directly by ID. To find out ID for any dashboard, you can follow this guide. Please note that the ID in the URL corresponds with the tab.identifier key.
Please note that setting a dashboardTabFilter has no effect on Analytical Dashboards.