Adding a Reports Widget

 The process of adding a Reports widget to a Dashboard is similar to adding any other widget type. 

It follows the three standard steps:

  1. Selecting a Widget Type
  2. Configuring the widget
  3. Preview and visual settings

Selecting a Widget Type


This starts with the "Add widget" menu item, shown below:

Subsequent to this, one has to simply select the Historical/Reports widget from the next screen:


Once the widget type has been selected, you proceed to the next step. 

Configuring the widget

The configuration step exposes ways for configuring a specific widget, based on a report data.
To facilitate this, it loads all available Reports for the current user context, on the left side of the wizard step. You then need to select the specific report from the list, either by just clicking on it, or utilising the search element on the top:

Once a specific report is selected, all of its configuration data is loaded to the right, as shown below:

The configuration options are a 1:1 correspondence with existing Reports settings, to minimise the learning curve and preserve the user experience. 
For completeness, these are listed below: 

  1. Service Number - this is the Service Number, which needs to be selected to get the report 
  2. Select Columns - this section allows you to select all the columns, from the report, that you want to see in the visualisation.
    Please note, that for each report, there may be one or more Column Keys - Columns that are pre-selected and cannot be deselected, in order for the report to be properly visualised.
    All other columns can be selected or deselected, as in a standard widget. 
    In the screenshot above, all columns other than "Queue" are deselect able, as denoted by the enabled "x" symbol. The Queue column, on the other hand, is always present in the final visualisations.
  3. Visual Type - this section allows one to select the type of visualisation to show the data on - Line Chart, Bar Chart, Area Chart or Table. 
    This looks as shown below:
    Please note, that for a chart type to be enabled, one needs to select between 1 and 4 columns, which are of a numeric type - integers, decimals or time, but not a string. If a string is included, the only available visualisation type would be Table. 
    Also, it is important to mix data that is comparable with one another, in chart series - for example integers and integers, and not integers and time, which would produce renderings that are not symmetric. 
  4. Period - From (Fixed Date) - A fixed date and time, such as "05/10/2022 00:00" that would determine the start date for the data to fetch from the report. 
  5. Period - To (Fixed Date) - A fixed date and time, such as "12/12/2022 00:00" that would determine the end date for the data to fetch from the report. 
  6. Period - From (relative Date) - This is a relative date, such as "Today", or "Yesterday", which will be evaluated at the time the report loads, based on the date when it loads, to determine the exact translation of "Today" or "Yesterday". This is the start date range for the report
    The possible values are:
    1. Today
    2. Yesterday
    3. This week
    4. Last week
    5. This month
    6. Last month
    7. January this year
  7. Period - To (relative Date) - This is a relative date, such as "Today", or "Yesterday", which will be evaluated at the time the report loads, based on the date when it loads, to determine the exact translation of "Today" or "Yesterday". This is the end date range for the report. 
    The possible values are:
    1. Today
    2. Yesterday
    3. This week
    4. Last week
    5. This month
    6. Last month
    7. January this year
  8. Group By - an option to group the data by a specified time period. The possible options are:
    1. Quarter - this is quarter of an hour, or 15 minutes
    2. Hour
    3. Day
    4. Week
    5. Month
  9. Filter - an option to select one or more fields to show data for, ignoring all other data fields. This is handy in cases when you want to focus on a specific field, or set of fields only. 

 

Preview and visual settings

The last and final step from the configuration of the Reports in Dashboards is choosing the Theme and Visual settings. 
As with other widget types, this follows the standard interface shown below:
 

Here you can set the Theme, as well as visual settings for the widget, such as Fond Size and Colour.  

Report Widget View

Once the widget has been fully configured and rendered, it will look like this:

In the case of a Chart widget, at the top you see a chart representation with one or more series. 
At the bottom, you can see a range selector, which allows you to zoom-in on a specific range within the series. 

Published

05/12/2022 - 10:33

Last updated

06/03/2023 - 09:49
0
0