Widgets

From Hornbill
Jump to navigation Jump to search

Home > Administration > Reporting > Widgets

Introduction

Widgets are provided to create plug in data that can be used to build Dashboards. Some widget types make use of existing measures and provide the ability to display them in a more appealing format. Certain widget types allow you to return and display data based on configuration carried out within the widget.

Creating a new Widget

Select the + Create New Widget button, give the new Widget a name, and choose which type of Widget you wish to create. Configuration options for each of the Widget types is explained below.

Widget Types

Data Chart

Charts can be in the form of a Bar or Line Graph

Scorecard

A Scorecard widget can be used to display one or more Measures which have previously been defined.

Data Measure / Data Formatter

  • Add previously configured Measures to the Scorecard by selecting the + button and choosing the Measure you wish to add from the drop down list. Add additional Measures using the + button.
  • Remove measures from the Scorecard by selecting the dustbin next to the Measure you wish to remove.

Scorecard Display

Configure the data which is displayed on each Scorecard by selecting the from the options below:

  • Show scorecard: This will display the actual sample data against each sample period for each measure. The number of samples displayed for each measure is configured against the measure not on the widget.
  • Show sparkline: This will display a visual trend line representing the data over the defined sample period for each Measure
  • Show target: This will display the target which was defined for each Measure
  • Show previous sample: This will display the previous actual sample value before the latest for each Measure
  • Show current value: This will display the latest actual sample value for each Measure
  • Show difference value: This will display the difference between the latest and the previous actual sample values for each Measure
  • Show direction indicator: This will display a graphical indicator of the direction of the latest actual sample value against the previous actual sample value against the target which has been defined for each Measure. If the direction is positive the indicator will be green, if it is negative or there is no change the indicator will be red. The arrow can be up or down for both positive and negative results depending on each Measure's target and if being above or below the target has been set as a positive or a negative outcome.

Target Counter

This type of widget is used to display how a single measure is performing against it's target.

Counter Data Measure

  • Choose the Measure which the widget will use from the drop down list
  • Change the Measure to be used by selecting another Measure from the drop down list

Display Data

By Default the latest sample (value) for the Measure will be displayed. It is possible to compliment this value with other measure attributes as explained below:

  • Show Desired Target: Select this option if you wish to display the predefined target for the Measure on the Target Counter Widget.
  • Show Previous Sample: Select this option is you wish to display the previous sample value alongside the current sample value.
  • Show difference value: Select this option if you wish to display a value which represents the between the current and the previous sample values.
  • Show Sparkline: Select this option if you wish to graphically display the available historical sample values for the Measure. The number of samples values displayed will reflect the number of sample of historical sample values you have configured to retain in the measure configuration.

Display Icon

  • Optional include an icon alongside the Counter values by selecting an appropriate icon from the icon picker
  • Change the displayed icon by choosing another icon, or remove an icon completely by selecting the Clear option

List of Data

Allows you to populate a widget with a list of data based on a user defined table query.

Widget Settings

Datalist Settings

  • List Type: Choose either Single Table Query or Custom sql Query

Single Table Query

Query Settings

Select No. Records: Define how many results to display on your data list.
From Table: Choose the table from which your datalist will be populated.
Select Columns: Choose the columns of data (in the order which you wish them to appear on your datalist) from the table above
Where Clause: Define any conditions which will filter the amount of data to be displayed in your datalist

Custom sql Query

List of Counters

This widget allows you to display a list of existing metrics that are based on an aggregate value such as count, average, max, and min. Alternatively, from within the widget, you are able to return aggregate values based on a user defined table query.

Custom

The custom widget type allows you to specify a URL and display the content as an image, in an iframe or div.

You may wish to compliment the Hornbill data which can displayed in Widgets, with that of content from external sources. The Custom widget option allows you to either add an image via a specific URL, or display the content from an external source via a URL.

Custom Widget Configuration

URL: Define the external content or image you wish to display.
Format: Choose Image, Iframe or Div

As with other widgets it maybe necessary to preview and fine tune the appearance of the Custom widget before making this available to be used in a Dashboard.

General Look and Feel

Using the paintbrush icon you can configure how the widget will appear when displayed on a Dashboard.

  • Container Header: Here the options include where to display the Header bar, if the title should be shown, if a border is needed, header text and background colors.
  • Container Border: Here you can decide if the widget's border should be shown, if so what color it should be and if curved edges enhance the appearance.
  • Container Coloring: Here the main body of the widget can be configured, the text colour if applicable, background, effect and background effect colors can be chosen.

Preview

It is important to understand how the Custom or other widgets are going to display before adding them to a Dashboard. Using the Preview Width and Height settings above the Widget content will allow you to preview different sizes and layouts which may influence the dimensions you need to allocate when adding the widget to a Dashboard.