Dashboard Configuration

You create and configure dashboards by modifying the dashboards.json configuration file, in the customization directory in your Find installation home directory.

This configuration file contains the dashboards object, which is an array of dashboard configuration objects. To add a dashboard, you add an object to this array.

In the Find user interface, the Dashboards section in the navigation sidebar lists your dashboards in the same order that you list them in the configuration file.

When you add a dashboard, you can configure the name and the number of grid squares to divide your dashboard into, as well as how often to update the contents of the widgets.

TIP:

If you belong to the FindAdmin role, you can reload the dashboard configuration to make any configuration changes available to your users without restarting Find.

To reload the dashboards, you must send the following API call to Find directly, by typing the URL into your Web browser address bar. You must be logged into Find as a user with the FindAdmin role in the same Web browser, because Find uses the session cookie to authorize the action.

http://FindURL/api/admin/customization/config/reload

Where FindURL is the URL of your Find server.

This option also reloads any other customization configurations (for example, applications).

The following table lists the configuration properties that you can use for the dashboards.

Property Required Type Description
dashboardName Yes String The name to use for the dashboard. This name is displayed in the Dashboards navigation section.
enabled Yes Boolean Set to true to enable the dashboard and display it in the Dashboards navigation section. Set to false to hide the dashboard.
width Yes Integer The width of the dashboard grid, in grid squares (where a widget takes up a minimum of one grid square). For more information, see Dashboard Grid Size.
height Yes Integer The height of the dashboard grid, in grid squares (where a widget takes up a minimum of one grid square). For more information, see Dashboard Grid Size.
updateInterval Yes Integer The time (in seconds) to wait between each refresh of the widgets in this dashboard.
This parameter affects only widgets that reference a query saved search. It does not apply to static widgets and widgets that reference a snapshot.
widgets Yes Object Array An array of objects that define the widgets to include in the dashboard, their positions and sizes, and the individual widget configuration. For details of the properties to use for widget configuration, see Widget Configuration.
displayWidgetNames No String Enum A string that determines whether to display the names of the widgets. Use one of the following options:
  • always. Always display names, if provided in the widget configuration.
  • onhover. Display names only when a user mouses over the widget.
  • never. Never display names, even if they are provided in the widget configuration. This is the default value.

You can override this parameter for individual widgets by using the displayWidgetName option in the widget configuration. See Widget Configuration.
roles No String Array An array of strings that specify the role names of roles that can access the dashboard. Users can see the dashboard only if they belong to at least one of the roles that you specify.
If you do not set the roles property, the dashboard is accessible to all users.

The following example shows a simple configuration for one dashboard that contains a single widget:

{
   "dashboards": [
      {
         "dashboardName": "Static Content Dashboard",
         "enabled": true,
         "width": 4,
         "height": 4,
         "updateInterval": 1000,
         "roles": ["CustomRole"]
         "widgets": [
            {
               "name": "Static Image",
               "type": "staticImageWidget",
               "x": 1,
               "y": 1,
               "width": 2,
               "height": 2,
               "widgetSettings": {
                  "url": "http://example.com/image.png"
               }
            }
         ]
      }
   ]
}

_HP_HTML5_bannerTitle.htm