Databoard Reporting
- Kye Hush
Along with in the box, grid view and dashboard reporting, in WorkBook you can also create databoards for your reporting needs.
Databoards is a built-in functionality within WorkBook that enables users to query the database and retrieve results using the common language SQL. A databoard is usually used for creating data extraction that requires gathering information from different tables within the WorkBook database with/without conditions applied.
This data extraction can be used for:
The customised WorkBook dashboards
Integration with other systems via API
Periodic data extractions to fetch into other Business Intelligence (BI) tools
Only the system administration role has access to the databoards menu in the settings module.
ON THIS PAGE YOU WILL FIND: |
|---|
DATABOARD NAVIGATION
Go to settings module > advanced tools sub-menu > databoards
NUMBER | FUNCTIONALITY |
|---|---|
1 | Further options menu (a.k.a. “hamburger menu”) gives the option to:
|
2 | View tab : to manage the views under the selected databoard The view is the output of a databoard based on the SQL script and parameters set. A different view can be created as the output, e.g. grid data overview, chart view, or a data export which can be enabled in the finance & administration module > databoard export menu. |
3 | The databoard list, displays the selected databoard from the drop-down list. |
4 | View tab > further options menu (a.k.a. “hamburger menu”) gives the options to:
|
DATABOARD SETTINGS
Allows editing of the basic settings of the databoard.
NUMBER | FUNCTIONALITY |
|---|---|
5 | Settings : allows to edit the details of the databoard, such as:
Access settings : allows to manage the user access on this databoard Statistic : allows to check who has run the databoard and when |
6 | Data view name: to define the name of the databoard. |
7 | Source type: SQL or StoreProcedure. Only Deltek has the permission to create a databoard with the type StoreProcedure. Please contact your Tangram Consultant if you would like to create this type of databoard. |
8 | Default file name: Not in use. |
9 | Active checkbox: to set the databoard as active /in-active. Note: a databoard must be set to active so that it can be used in Dashboard or Databoard Export. |
10 | Script: is used for inputting the SQL commands to query the data from the database. Please refer to this article for some of the common tables. |
DATABOARD PARAMETERS
Databoard parameters are defined in the databoard settings tab > parameters sub-tab.
Every parameter has a UTF-8 encoded string name that will be displayed to the databoard user, but is internally referenced by its unique integer index. A parameters type can take on one of the following shapes and optional default value:
In the setup grid you will be able to see 5 columns; Index, Name, Type, Default value and Item source.
NUMBER | FUNCTIONALITY |
|---|---|
11 | Index: is the unique integer index that is used as the reference key within the databoard. This index will be pointing to/from the script to apply the relevant filters to the output. |
12 | Parent index: This parent index field refers to the index of a “Parent” parameter where the parameter type is AutoComplete or MultiSelect AutoComplete. If it is set, the items source script (16) will be passed a String @ParentId parameter containing the currently selected Id value of the parent AutoComplete or MultiSelect AutoComplete. |
13 | Name: This is the name of the parameter that is displayed in the filter when viewing the Databoard. |
14 | Type: select the type of parameter to apply in the filter. There are 5 types:
|
15 | Default value: a default value to be defined in the parameter for this databoard. Leave blank if no default value is required. |
16 | Item source: is used for looking up items from the database. This is written by SQL. E.g. SELECT CompId, Compname FROM Comp |
Related articles
© Tangram 2022. All rights reserved.