Create Dashboards

Create dashboards that meet the needs of users. You can modify built-in dashboards or leverage dashboard examples and templates. Or you can start with blank dashboards and add everything yourself.

Tip When you create a dashboard, you don’t build and build and build some more and then, at the end of the process, see if it works. If you configure the dashboard to use existing data and add a Filtering panel, then panels in the dashboard work as you add and configure them.

Start with Built-in Dashboards

Fusion ships with these built-in dashboards:

  • default.json – The Fusion Logs dashboard is the default dashboard.

    Fusion Logs dashboard

    You can modify the default dashboard to suit your needs. Each user can also choose a different dashboard as a browser default (for a specific browser). The Fusion Logs dashboard is similar to the Fusion Search Logs dashboard. Both access the logs collection. The layout and panels present differ slightly. The Fusion Search Logs dashboard sends queries to Solr (/api/apollo/solr). The Fusion Logs dashboard sends queries to a Fusion query pipeline (/api/apollo/query-pipelines/_system/collections/), and it specifies the global query parameter &df=message_t (use the field message_t as the default field).

    To open the default dashboard, click Analytics on the Fusion Launcher. With any dashboard open, click Goto saved default Goto saved default.

  • blank.json – An entirely blank dashboard. Open this dashboard and the next three in this list from links in the default dashboard.

  • lucidworks-metrics.json – The Fusion Metrics dashboard displays key Fusion metrics from the Fusion collection system_metrics.

    Fusion Metrics dashboard

  • lucidworks-searchanalytics.json – The Fusion Search Analytics dashboard displays search analytics derived from collection logs.

    Search Analytics dashboard

  • lucidworks-signals.json – The Fusion Signals dashboard is a type of time-series dashboard that you can use to monitor signals collections. It uses the signal timestamp as the time field.

    Fusion Signals dashboard

  • default-nts.json – The default non time-series dashboard. At the top right of a dashboard, click New New > New non time-series dashboard to open this dashboard. This is an example of a non time-series dashboard:

    Non time-series dashboard

  • default-ts.json – The default time-series dashboard. click New New > New time-series dashboard to open this dashboard. This is an example of a time-series dashboard:

    Time-series dashboard

Tip You can modify the built-in dashboards. If you do, make copies of them first. Or you can save the new dashboards in Solr.

Start with Examples and Templates

Dashboard examples and templates are in this directory, which also contains the built-in dashboards described in Built-in Dashboards (you can use those as examples and templates too):

/path/to/fusion/3.1.x/apps/jetty/ui/webapps/root/WEB-INF/classes/public/banana/app/dashboards

Noteworthy among the examples and templates are:

  • new-dashboard.json – This is a blank dashboard, identical to blank.json.

  • fusion-searchlogs.json – The Fusion Search Logs dashboard is similar to the Fusion Logs dashboard. Both access the logs collection. The layout and panels present differ slightly. The Fusion Search Logs dashboard sends queries to Solr (/api/apollo/solr). The Fusion Logs dashboard sends queries to a Fusion query pipeline (/api/apollo/query-pipelines/_system/collections/), and it specifies the global query parameter &df=message_t (use the field message_t as the default field).

  • guided.json – A dashboard with notes about how to construct a dashboard. In a browser, the dashboard has the name "Basic DashBoard With Pointers."

  • noted.json – An additional dashboard with notes about how to construct a dashboard. In a browser, the dashboard has the name "A few notes."

Tip If you use these examples and templates as starting points for new dashboards, save copies of them first. Then save the new dashboards in Solr, which makes it easier for users to open them.

Create a Dashboard

The steps for creating a dashboard are:

  1. Choose the best starting point.

  2. Configure dashboard settings.

  3. Lay out the dashboard. A dashboard consists of rows and panels, and possibly columns (if you use Column panels).

  4. Configure the panels as you add them. Below we present general tasks that apply to all panels and tasks that apply to specific types of panels.

  5. Save the dashboard.

  6. Test the dashboard.

Choose a starting point

Choose a dashboard as a starting point for your dashboard. Possibilities include:

Tip Save a copy of the original first, or plan to save your modified dashboard as a new dashboard.

Configure Dashboard Settings

Configure dashboard settings, which affect all panels on a dashboard.

  1. Choose where Fusion sends queries from a dashboard – Fusion can send queries to a Fusion query pipeline or to Solr. At the top right of the dashboard, click Configure dashboard. On the Solr tab, select Use Fusion to use a Fusion query pipeline. Deselect Use Fusion to send queries to Solr.

  2. Choose a default collection to query – On the Solr tab, specify the name of the collection to query. Fusion queries this collection when the dashboard opens.

    To use the same dashboard for multiple collections, let the dashboard user choose a collection. On the Controls tab, select Show Collections Picker.

  3. Specify global query parameters to append to all dashboard queries (optional). On the Solrs tab, enter Global Query Parameters. For example, to set the default search field to the field message_t, specify the global query parameter &df=message_t.

Lay Out the Dashboard

  • Add a row to a dashboard – Click Add a Row Add a Row.

  • Configure a row – At the left of the row, click Configure row Configure row.

  • Add a panel to an empty row – Click Add panel to empty row Add panel to empty row. Click Add panel Add panel and select the Panel Type. Configure the panel, and then click Add Panel.

  • Add a panel to a row that already has panels – Click Add a panel to this row Add a panel to this row. Click Add panel Add panel and select the Panel Type. Configure the panel, and then click Add Panel.

  • See that a row is full – On the left side of a row, the Row Full Row Full indicator shows you that the row is full.

  • Resize a panel Click Configure Configure. On the General tab, choose a Span (width) between 1 (one twelfth) and 12 (twelve twelfths).

  • Drag a panel to a different location Click-and-hold the panel type (in the upper right corner of the panel), and drag the panel to an empty location or on top of a different panel (which moves out of the way).

  • Remove a panel – At the top right of the panel you want to remove, click Remove Panel Remove Panel.

  • Place panels in a column – A Column panel lets you lay out panels in a column.

  • Add text – A Text panel lets you add text to a dashboard, for example, for user instructions (how to use the dashboard to interact with data), descriptions of content (what am I seeing), etc.

Configure Panels

  • Configure a panel – At the top right of the panel, click Configure Configure. The primary tab for configuration is Panel. This is what the tabs let you do. Not all tabs are present for all panel types.

    • General – The name and width of the panel, whether it is editable, and whether the panel will let users inspect the queries.

    • Panel – The primary tab for configuring the panel. This configuration affects how data is displayed, but also in some cases, which data is displayed.

    • Info – Optionally, add a help message that Fusion displays when a user inspects the queries for a panel.

    • Fields – Add and remove fields in a Table panel.

    • Paging – Control pagination of a Table panel.

    • Queries – View the panel query. Optionally, add one or more custom Solr query parameters. Fusion adds these to the panel query.

    For the Histogram and Range Facet panels, you can perform some configuration by clicking View View. Click View Close view to hide the configuration.

    Panel configuration

  • Display help for a setting – Hover over the Help Help icon.

  • Inspect a query – At the top right of a panel, click Inspect Inspect to inspect the query that a panel sends to Solr. Fusion displays both the panel query and the custom query (if any).

  • Make a panel not editable – Click Configure Configure. On the General tab, deselect the Editable check box.

  • Make a panel editable – Remove the panel, and then add it back. Click Remove Panel Remove Panel, and then click Add panel to empty row Add panel to empty row or Add Panel Add a panel to this row to add the panel back.

Configure Input Panel Settings

What goes into input panels determines what comes out on display panels. This determination has these parts: – panel configuration, panel contributions to the query, and user interactions with the panels.

  • Add a custom query for a panel (optional; only possible for some panel types) – Some panels let you specify a a custom query to add to the panel query. The combined query is sent to the Fusion query pipeline or to Solr.

  • Filter – Filters select subsets of the data in a collection, for example, records in a time range or in which the field Gender has the value Female. A filtering panel is required for data interactivity to work. The filtering panel displays the filters that are in effect. You can also use a Filtering panel to add, remove, edit, and toggle filters.

  • Facet – A user can use a Facet panel to choose data in a specific facet of one or more facets. For example if the facets Gender and Graduation Year are defined, a user could choose the Gender Male and the Graduation Year 2010.

Configure Specific Types of Panels

  • Add a query-entry field to a Query panel – Click Add Search Box Add Search Box.

  • Delete a search box from a Query panel – Hover over the search box you want to delete, and then click Delete Delete.

  • Move a column in a table to the left – At the top of the column you want to move, click Move Column to Left Move column to left.

  • Move a column in a table to the right – At the top of the column you want to move, click Move Column to Right Move column to right.

Save a Dashboard

Click Save Dashboard Save Dashboard. You can save a dashboard to Solr, a file, or a GitHub gist. We recommend that you always save dashboards to Solr (even if you also save them as files or gists).

  • Save in Solr – Click Save Dashboard Save Dashboard. Under Solr, enter a name for the dashboard, and then click Save. Ignore the Make Public checkbox.

  • Export to File – Click Save Dashboard Save Dashboard > Export. Fusion downloads the dashboard as a file in the browser’s download directory. The filename is named dashboard\_name-large\_number, for example, Storefront-1502124761166. The file is a JSON file. It lacks the file type .json, which isn’t really needed (you could add it). If you want to place the file in a different location, move it.

  • Save as a GitHub gist – When you save a dashboard as a GitHub gist, you don’t need to log in to Github first. Fusion stores the gist as an anonymous gist.

    To save a dashboard as a gist, the dashboard must be configured to allow that. Click Configure dashboard. On the Controls tab under Allow saving to, select Gist. At the top right of the dashboard, click Save. Under Gist, enter a name for the dashboard. The name becomes the title of the dashboard, which is stored in the JSON file as the value of "title". The filename is kibana-dashboard.json Then click the Save Gist icon. Fusion displays the URL at which the gist resides. If you save the dashboard again, you get a different anonymous gist and a different URL. For example:

    Gist URL

    Important Visit the URL immediately. Save the URL. Bookmark it. Write it down. You can’t find the gist by searching for it, and Gist identifiers don’t persist for long in the Fusion UI. (The last gist saved is available in the Load dialog for the duration of the browser session.)

Test the Dashboard

Ensure that the dashboard displays the expected data when users use the dashboard. Adjust the panels present, their placement, and their configuration based on user feedback.