How to Create A Databox Widget
**Please note to add a Databox Widget the Login must have permissions to have the ability to edit layout and add widgets. [Check with a KeyedIn Administrator]
A Databox widget can be added to specific dashboards, the dashboards listed below will allow a Databox to be configured:
- My Projects
- My Work
- Custom Dashboards
A databox cannot be configured for the following dashboard:
- Portfolio Analysis Scenario Dashboard
In this example the ‘My Work’ dashboard will be used to demonstrate how to add a Databox.
Before a dashboard can be configured to add widgets, the dashboard must have a ‘View’ setup.
To add a ‘View’ select the Wrench Icon and within here click on ‘Add New View’
This will open the following screen which will allow you to specify a name for the view:
This will now create a new blank view which can now be configured to add widgets.
To begin configuring the view please select the wrench icon and select ‘Configure Current View’
This will then show the following screen:
Clicking on the ‘+’ icon will open the ‘Add Widget’ screen.
Within here select ‘Databox’
There will be two Databox Widgets which can be used.
- Databox Count: This will display the number of records returned by a search filter
- Databox Sum: This will display the total of the field selected, using the records returned by a search filter.
Select the databox type you wish to add. In this example ‘Databox Sum’ will be demonstrated.
The chosen databox widget will be added to the dashboard.
Click on the Databox ‘Configuration’ icon to start the databox configuration.
This will open the following screen ‘Databox Sum Configuration’
Name: Databox Display Name
Type: The ‘Entity’ Type this databox will be configured for.
Filter: The filter to be applied to this databox, the filter listed in the drop-down menu will show filters for the Entity Type selected
Field: The field selected will be where the databox sum will take place
Background: This allows setting up colours for the databox to highlight any changes to the databox values.
For example; a Green colour could be set to show if the value is greater than or equal to 20 and then a different colour could be added to show if any value is greater than or equal to a 100.
In this particular example the databox has been configured as follows:
The Entity ‘Type’ selected is ‘Timesheets’
The ‘Filter’ selected is ‘Unapproved Time’ so this will report on all unapproved timesheets hours.
The ‘Field’ selected is ‘Hours’, this is where the sum will take place so in this scenario it will include all unapproved timesheet hours defined by the filter .
- Show light green databox colour if sum of unapproved hours is more or equal to 5
- Show darker green databox colour if sum of unapproved hours is more or equal to 10
- Show an Orange databox colour if sum of unapproved hours is more or equal to 15
- Show a red databox colour if sum of unapproved hours is more or equal to 20
Select ‘Save’ once this has been configured.
The databox will be added to the dashboard, select the ‘Save’ Icon so the dashboard is no longer in the ‘Configuration’ mode
The databox is now configured and will show the Sum Value and relevant background colour isset against each result set based on defined ranges.
This is a live widget so any changes that are made against the filter applied will update the databox in real time.
Currently the databox shows there are 10 unapproved timesheets so the background colour is showing the Dark green colour.
If a change is made to the unapproved hours, this will update the databox sum and colour as shown below.
There are now 15 unapproved timesheet hours so the colour will change in the databox to an orange colour.
END OF DOCUMENT