Widgets

From Hornbill
Revision as of 09:21, 9 August 2019 by ConorH (Talk | contribs)

Jump to: navigation, search
Home > Administration > Advanced Analytics > Widgets Index

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.

Related Articles

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 and an example video for each of the Widget types is given below.

Widget Types

Data Chart

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

When creating Data Charts it is possible to define how the data for the chart will be created using the following options:

  • Measured Sample - This type allows you to add multiple measures data to a single chart, and to display the data using definable sample intervals, and history.
  • Measured Group By - This type allows a single measures data to be displayed and grouped by Saved Data Columns.
  • Measure Samples Group By - This type allows a single measures sampled data to be grouped and displayed by Saved Data Columns and by definable sample periods (manual or predefined date settings).
  • Sql Group By - This type allows you to specify a database table, which column to group on, which to count on as well as define filter conditions for the data, and the sample history duration.

Measured Sample

Data Source Details

  • Data Type - Choose Measured Sample
  • Tick Type - By default this will be set to Automatic and will inherit the Sample period for the measures added to the chart. If when configuring the measure, you recorded date fields in the Saved Data Columns for the measure you will be able to switch the Tick Type to look at the data by any of the other sample periods (Hourly, Daily, Weekly, Monthly, Yearly). Examples of the date columns could be h_datelogged or h_dateresolved from the primary h_itsm_requests table
  • Sampling Type - This will control the values by which you can view the sample data. Choosing Use manual sample setting will allow you to manually specify the number of samples to display on the data chart using the tick type sample periods. For example Tick Type = Monthly and Samples to use = 6 will show (if the data is available) the last 6 Months samples. If the Samplying Type is set to Use predefined data setting the Samples to use field will change to Sample Periods and a list of predefined sample periods will be available to select from
  • Add Series - Choose this option to select a measure to add to the data chart, give the Series a Display Name, and select a measure from the predefined list. Once added the Measures Data will be displayed on the Chart using the sample period and history options defined above.
  • Change the Series Display name, Colour and Measure to use from the available fields if required.
  • Add new series - Add additional Series to the chart by selecting this optionand again choosing a Display name for the series and a Measure to use.

Chart Settings

  • Chart Type - Choose the display type for the Chart
  • Stack Multi-Series - If Bar Type is chosen above, the option to stack the Bars will be presented
  • Bar Direction - If Bar type is chosen the Bar direction can be set

Data Label, Background and Border options can be configured as required.

Axis Options

Define if Axis titles are required to appear on the chart.

Grid Options

Define if the grid is visible and the color to use

Legend Options

Define if the Legend is to displayed and the position for the legend

Target Lines

If required one or multiple target lines can be added to the Chart, and be shown in the Legend.

  • Add Target - Choose this option to add a target, give the Target a name, thickness of the target line, display colour and value for the Target
  • Add additional targets if required, or remove targets if no longer needed.

Measured Group By

Data Source Details

  • Date Type: Choose Measure Group By
  • Sample Period: By default this will use the sample history for the measure added to the chart. However it is also possible for the data to reflect any of the other predefined sample periods from the list.
  • Use Measure: Choose the measure to be used for chart data
  • Group By: Choose which column of data you want the data to be grouped by. *Only columns predefined in the Saved Data Columns of the chosen measure will be displayed in this list. If no values are displayed this will indicate no Saved Data Columns were added when configuring the measure.
  • Show: Decide if the group by data will be presented by the Top or Bottom value column first on the chart
  • Number of Records: If large number of results are returned, you may choose to only display the Top x group by values.





Chart Settings

  • Chart Type - Choose the display type for the Chart
  • If Bar is chosen
  • Bar Direction - If Bar type is chosen the Bar direction can be set
  • Data Label, Background and Border options can be configured as required.
  • If Pie is chosen
  • Data Label, Background and legend options can be configured as required.

Axis Options - Bar Chart Only

Define if Axis titles are required to appear on the chart.

Grid Options - Bar Chart Only

Define if the grid is visible and the color to use

Target Lines - Bar Chart Only

If required one or multiple target lines can be added to the Chart, and be shown in the Legend.

  • Add Target - Choose this option to add a target, give the Target a name, thickness of the target line, display colour and value for the Target
  • Add additional targets if required, or remove targets if no longer needed.

Measure Sample Group By

Data Source Details

  • Data Type - Choose Measure Sample Group By
  • Sampling Type - This will control the values by which you can view the sample data. Choosing Use manual sample setting will allow you to manually specify the number of samples to display on the data chart. If the Samplying Type is set to Use predefined data setting the Samples to use field will change to Sample Periods and a list of predefined sample periods will be available to select from
  • Use Measure - Choose the measure you want to provide the data for the data chart, and by which the sample data can then be grouped.
  • Group By - Choose which column of data you want the data to be grouped by. *Only columns predefined in the Saved Data Columns of the chosen measure will be displayed in this list. If no values are displayed this will indicate no Saved Data Columns were added when configuring the measure.
  • Show - Choose to display the first or last sample data of the sample period first on the chart





Chart Settings

  • Chart Type - Choose the display type for the Chart
  • Stack Multi-Series - If Bar Type is chosen above, the option to stack the Bars will be presented
  • Bar Direction - If Bar type is chosen the Bar direction can be set

Data Label, Background and Border options can be configured as required.

Axis Options

Define if Axis titles are required to appear on the chart.

Grid Options

Define if the grid is visible and the color to use

Legend Options

Define if the Legend is to displayed and the position for the legend

Target Lines

If required one or multiple target lines can be added to the Chart, and be shown in the Legend.

  • Add Target - Choose this option to add a target, give the Target a name, thickness of the target line, display colour and value for the Target
  • Add additional targets if required, or remove targets if no longer needed.

Sql Group By

Data Source Details

  • Data Type - Choose Sql Group By
  • Show - Choose to order the data by the top or bottom value.
  • Number of Records - If a large number of values are returned, you can choose to display the top or bottom x values.
  • From Table - Choose the table from which you wish to populate the data for your chart. For Example h_itsm_requests for the primary requests table.
  • Group On - Choose the column from the defined table which you wish to group the data by.
  • Count On - Choose the column from the defined table which you wish to count the data records by. For the primary request table (h_itsm_requests) this maybe the unique reference number (h_pk_reference).
  • Filter - Define any conditions to filter the returned data by. For example by type, category, status.





Chart Settings

  • Chart Type - Choose the display type for the Chart
  • If Bar is chosen
  • Bar Direction - If Bar type is chosen the Bar direction can be set
  • Data Label, Background and Border options can be configured as required.
  • If Pie is chosen
  • Data Label, Background and legend options can be configured as required.

Axis Options - Bar Chart Only

Define if Axis titles are required to appear on the chart.

Grid Options - Bar Chart Only

Define if the grid is visible and the color to use

Target Lines - Bar Chart Only

If required one or multiple target lines can be added to the Chart, and be shown in the Legend.

  • Add Target - Choose this option to add a target, give the Target a name, thickness of the target line, display colour and value for the Target
  • Add additional targets if required, or remove targets if no longer needed.

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.

There are two options for defining the content which will appear on your datalist and these can be chosen from the 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 if a large number of results are returned.
  • 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

This advanced option provides you with the ability to define a SQL statement to populate the content of the Datalist.

Select the Edit Custom SQL option to open the Datalist SQL query editor


List of Counters

This widget allows you to display one or a list of metrics that are based on an aggregate value such as count, average, max, and min.

Widget settings

Add a new counter by selecting on the Add button

Configure the new counter:

  • Icon: Optionally browse and select an icon which will appear next to the new counter name and counter value on the widget.
  • Name: Define a name for the new counter, this name will appear on the widget next to the counter value.
  • Edit List item sql: select this option to open the configuration options for the counter value

SQL Query Configuration

  • Select: Choose the appropriate aggregate for the counter - Count, Ave, Sum, Max, Min
  • From: Choose the table from which the counter data will be selected
  • Where: Define the where conditions which will filter the counter data as necessary

Optionally it is possible to have the colour of the counter value change depending on the current value. By default the value will be black, but it is possible to define what colour the value should display in, if the value is equal to or above or below defined thresholds.

Once the configuration is complete, select the Apply Changes button.

  • Add additional counters to the widget by selecting the Add button and repeating the steps defined above.
  • Remove counters by selecting the dustbin icon next to the counters you wish to remove from the widget

Define the Widget settings, and the General look and feel as required and then save the widget using the disc icon.

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.

Pre-Defined Date Settings

When creating widgets within Hornbil Advanced Analytics, some widget types provide the ability to set the sampling type and the sampling period. The sample period when using predefined date settings consist of multiple options to provide you the flexibility to set the widget to report on a specific period in time. Some of these options relate to the beginning of a week (this week or last week), and because the week start day can be different for organisations based in different countries Hornbill have also provided a setting to enable this to be set per Hornbill instance within the System -> Settings -> Advanced from your Hornbill admin portal. Search for system.regionalSettings.weekStartDay to set it for your instance. By default this setting is set to Sunday as the start of the week. There are also settings for the beginning of the calendar year - reporting.calendarYearStart which by default is set to 01/01, and a setting for the beginning of the financial year - reporting.financialYearStart which by default is set to 01/04.

The pre-defined date settings are explained here:

  • Start Of This Week - 00:00:00 hours on the last Sunday before today
  • Start Of This Month - 00:00:00 hours on the first day of the current month
  • Start Of Financial Year - 00:00:00 hours on the first day of the current financial year
  • Start Of This Year - 00:00:00 hours on the first day of the current year
  • Start Of Calendar Quarter - 00:00:00 hours on the first day of the current quarter. A quarter can start in January, April, July or October
  • Start Of Financial Quarter - 00:00:00 hours on the first day of the current financial quarter. A quarter can start in January, April, July or October
  • Start Of Last Week - 00:00:00 hours on last week's Sunday
  • Start Of Last Month - 00:00:00 hours on the first day of the last month
  • Start Of Last Financial Year - 00:00:00 hours on the first day of the last financial year
  • Start Of Last Year - 00:00:00 hours on the first day of the last year
  • Start Of Last Calendar Quarter - 00:00:00 hours on the first day of the last quarter
  • Start Of Financial Quarter - 00:00:00 hours on the first day of the last financial quarter
  • Last Calendar Years Samples - 00:00:00 hours on the first day of the last year to 23:59:59 hours on the last day of last year
  • Last Financial Years Samples - 00:00:00 hours on the first day of the last financial year to 23:59:59 hours on the last day of last financial year
  • Last Calendar Quarter Samples - 00:00:00 hours on the first day of the last quarter to 23:59:59 hours on the last day of the last quarter. A quarter can end in March, June, September or December
  • Last Financial Quarter Samples - 00:00:00 hours on the first day of the last financial quarter to 23:59:59 hours on the last day of the last financial quarter. A quarter can end in March, June, September or December
  • Last Months Samples - 00:00:00 hours on the first day of last month to 23:59:59 hours on the last day of last month
  • Last Weeks Samples - 00:00:00 hours on last week's Sunday to 23:59:59 hours on last week's Saturday
Personal tools
Namespaces

Variants
Views
Actions
Navigation
Tools