User Tools

Site Tools


about:dashboard-configuration

Configuration of dashboards

Dashboards are defined in the <yourDashboard-dir>/etc/dashboard-configuration.xml configuration file.

Please see the following example below:

<dashboard-configuration>
      <dashboard name="default">
              <row>
                      <dashlet class="DashletClock" refresh="10000">
                              <parameter key="location" value="Berlin, DE" />
                              <parameter key="clockDiffUTC" value="+1" />
                              <parameter key="clockSummertime" value="true" />
                              <parameter key="displayUpdateString" value="false" />
                      </dashlet>
                      <dashlet class="DashletClock" refresh="10000">
                              <parameter key="location" value="London, UK" />
                              <parameter key="clockDiffUTC" value="+0" />
                              <parameter key="clockSummertime" value="true" />
                              <parameter key="displayUpdateString" value="false" />
                      </dashlet>
              </row>
              <row>
                      <dashlet class="DashletOpenNMSOutages" refresh="30000">
                              <parameter key="title" value="OpenNMS Outages" />
                              <parameter key="restUrl" value="http://10.0.1.106:8980/opennms/rest" />
                              <parameter key="restUser" value="admin" />
                              <parameter key="restPassword" value="admin" />
                              <parameter key="linkUrlBase" value="http://10.0.1.106:8980/opennms" />
                              <parameter key="maxEntries" value="10" />
                      </dashlet>
                      <dashlet class="DashletOpenNMSOutages" refresh="30000">
                              <parameter key="title" value="OpenNMS Outages in category Cisco" />
                              <parameter key="restUrl" value="http://10.0.1.106:8980/opennms/rest" />
                              <parameter key="restUser" value="admin" />
                              <parameter key="restPassword" value="admin" />
                              <parameter key="outagesCategory" value="Cisco" />
                              <parameter key="maxEntries" value="10" />
                      </dashlet>
              </row>
      </dashboard>
</dashboard-configuration>

You define a dashboard using the <dashboard>-tags. Each dashboard must have a unique name, that will be shown on the drop down menu in the WebUI, to select the dashboard.

The dashlets are defined in rows (<row>-tags) using the <dashlet>-tags. Each dashlet must have a class-name (the name of the dashlet class) and a refresh interval, which is the interval (in ms) to reload the dashlet. Most of the dashlets needs some parameters to be set, which can be done using the <parameter>-tags. Each dashlet has its own set of parameters. The following parameters can be used global in all dashlets:

parameterdescriptionmandatory
displayUpdateString By default, a string with the dashlet's last update time will be shown. By setting this to false, you can disable this behavior no

Please see the dashlet documentation to get an overview of the available dashlets, with functionality and details on configuration.

about/dashboard-configuration.txt · Last modified: 2014/06/22 12:25 by michael