com.atlassian.confluence.content.render.xhtml.migration.exceptions.UnknownMacroMigrationException: The macro 'html' is unknown.

Dashboard Settings

Owned by Omry Koschitzky
Dec 29, 2015
4 min read

The dashboard settings contain different settings on the dashboard level. Unless changed individually, Gadgets inherit the dashboard's settings. There are several options to open the general settings of a dashboard:

  1. In the dashboards screen, mouse over a dashboard and click the   icon to displays the menu items and select Edit Dashboard.
  2. Click a dashboard to load it and then select the 'Edit Dashboard' from the  icon on the top right hand side of the Dashboard toolbar.

Dashboard's general settings screen is opened.

General

The general settings section allows to configure the Name and Description of a dashboard

Time Settings

The time settings section allows to configure the following:

  • Time Range: the default dashboard time range which all gadgets will display by default unless configured individually otherwise.
    Time Range which is set to Live determines a real time execution of the dashboard - gadgets will not be generated in the background, results will be calculated and displayed in real time only and while the dashboards is opened.
  • Generation Frequency: the frequency that new data will be processed and displayed in the gadgets.
    Generation frequency which is set to Never determines an offline mode of the dashboard - gadgets will be generated only on the exported time definition and/or on demand.

 

Dashboard Sources

The dashboard sources enables a generic definition of the dashboard's logs/folder/servers sources which will be added to all used search queries in the gadgets.
For example if the dashboard should refer to servers x, y, z then it is possible to specify this directly in each gadget's search query. Alternatively, it is possible to use generic queries in the gadgets and specify the list of sources in the Dashboard Sources section.

Using Dashboard Sources makes it very simple to duplicate, maintain and manage the list of sources that will be analyzed by the dashboard. 

User Inputs

Users Inputs provide an interface for users to supply values that effect gadgets search terms and displayed results based on their selection. Typically, the inputs are displayed in a checkbox, text area, dropdown menus or radio buttons. 

The forms allow users to visually make selections which impact the underlying searches and focus only on points of interest while viewing dashboard's results.


There are 2 aspects the should be configured in order to use Inputs - 

  • General Definition (Dashboard's Settings section)
    In the Dashboard Settings section the general settings of the inputs are configured - type of input, input key, label, etc. 
    Based on these definitions the user inputs form at the top of a dashboard will be built and displayed.
  • Searches Definition (Gadget's underlying searches) 
    It is also mandatory to use inputs keys within the gadgets underlying searches so in case a user uses an input the correspondent gadget will be updated based on the selection.

Export Settings

The export settings section determines if/when to export this dashboard.

  • Exporting Frequency: a frequency, a specific time or several times in which the dashboard will be exported according the Export to Email / Export to File definition.
  • Exporting:
  • The export mechanism supports an export of all selected dashboards as PDF and/or CSV files by email and/or by saving a file in the specified location.
    • Export To Email: the email settings that will be used when exporting the dashboard  by email (for multiple recipients use a comma separated list).
    • Export To File: the format, location and retention settings that will be used when exporting the dashboard to files on the file system. 

Note: no images are exported in a CSV formatted file.

  • XpoLog dashboards support definition of multiple export schedulers. Using more than one export scheduler allows a configuration of a specific date range and specified user inputs for each scheduled export. For example it is possible to configure on the same dashboard an export scheduler once a week on the last week in a daily granularity (per day view) and another scheduler once a day on the last day on an hourly granularity (per hour view) - the result will be a daily export presenting the last day on an hourly basis and a weekly export presenting the last week on a daily basis.Â