Widget Overview

Premium Checkbox Feature

Usage of this feature requires account access to Premium Checkbox features. For queries related to your licence agreement, ask your account administrator to contact your Checkbox Account Manager.

 

What is a Widget?

Broadly speaking, a Widget is a graphical interface, designed to display information to the user. Widgets can then be added to the Dashboard for reporting and data analytics.

Checkbox currently supports the following Widgets:

All of the above Widgets can be created and/or customised then added to the Dashboard with a premium feature licence. By default, Widgets in a Solution will only show the list view widgets showing in-progress and completed Assessments that cannot be edited or copied without a premium feature licence.

Important Note: To reference the data from a certain variable of your assessment, you'll need to expose it.

 

How to create a Widget

Important Note: To create a Solution Widget, you must be a Solution Owner or Author of the Solution. To create a Custom Widget, you must be a Team Owner of the Project Team.

  1. Solution Widget: Navigate to the App within your Solution you wish to create a Widget for;
    OR
    Custom Widget: Navigate to the App of a Solution within your Project Team you wish to create a Widget for
  2. Click onto the App name on the left panel and click on "Widgets" to view all the Widgets available for that App

    Note: By default, "In-progress" and "Completed" list view Widgets will be shown 

  3. Click onto the "+ New Widget" button

  4. Enter the relevant details required (i.e. Widget name, Create option and Widget type)

    Notes:
    • Widget name:Widget names can have up to 100 characters
    • Create option: You can choose to create and entirely new Widget from scratch or start by copying an existing Widget
    • Widget type: Widget types include list view Widgets and bar, line, pie charts

  5. Configure your Widgets to display the data or visualisation you wish to show to your end users

 

How to configure Widgets

Important Note: To configure a Solution Widget, you must be a Solution Owner or Author of the Solution. To configure a Custom Widget, you must be a Team Owner of the Project Team.

 

Widget Configuration includes 3 main components:

  1. Column/Visualisation

  2. Date Range
  3. Filters

1. Column/Visualisation

Note: "Columns" are used for list view Widgets while "Visualisation" is used in bar, line and pie charts.

In the Column/Visualisation component of the Widget, you will add the different variables you wish to display in your Widget:

  • In a list view Widget, you can add up to as many variables as you wish where one variable equals to one column.
  • In bar and line charts, you can only add up to 2 dimensions (i.e. the x-axis and y-axis) 
  • In a pie chart, you can only add up to 1 dimension

In the Visualisation component (i.e. for bar, line and pie charts) you are can also define how the results should be calculated and sorted.

Measure

The measure dimension is used so you can define how the result should be calculated. You can select:

  • 'Count' as an measure option (default)
    • This will simply display the number of records that match the variable added as a dimension in the visualisation
    • If the variable accepts multiple values (e.g. drop-down options), the record will be counted once for each value 
  • An exposed variable as an option
    • Only Numbers, Sliders, and number-type COMPs will be available to be used
    • Once a variable with one of the above variable types have been selected, you can choose between the following and manipulate the results of the data that will be displayed to the end user.
      • Sum
      • Average
      • Min
      • Max

Sort by

For bar and line charts you can sort the data by ascending or descending order in the "Sort" section of the Visualisation component.

Note: The sorting will only be applied to the primary dimension (i.e. the first variable or the x-axis).

 

2. Date Range

Date Range is a component that is also a filter specifically for date meta variables and exposed date variables. The date range options include:

  • "All time" - displays data for all dates
  • "Custom date range" - displays data for a specified custom date range

Custom date ranges require 3 things:

  1. Date meta variables and/or exposed variables
  2. Operator
  3. Range

Operators include:

  • is
  • is before
  • is between
  • is after
  • is last
  • is next

 

3. Filters

You can filter your widget using metavariables and/or exposed variables.

For example, if:

  • Your App has a ‘Task_Number’ variable inside of it; and
  • You set the filter condition Task_Number > 10 in the Widgets page

Data from any assessments in which a number less than 10 was provided for the Task_Number field will not be included in the list view widget. Click here to read the syntax rules for conditions.

The following types of conditions are available for the listed variable types:

Variable Type Operator
User Variables (i.e. User Picker and user-related column types) "include any of [me]"; "excludes [me]”
Text "equal to"; "not equal to"; "contains"; "does not contain"
Number, Slider "equal to"; "not equal to"; "less than or equal to"; "greater than or equal to"
Yes/No, Dropdown, Radio, Checkbox "include any of"; "excludes"