Configuring Dashboards

Configuring Dashboards

When configuring dashboards there are several concepts to understand:

1. Dashboards are linked to the forms on the project

2. These forms are used as the basis for configuring widgets

3. Dashboards consist of different types of widgets

4. These widgets are then added to the dashboard layout

5. We can also configure a quick search mechanism called breadcrumb browsing that will appear on the dashboard

You can access the dashboard configuration by clicking on the config button as shown below

Configuring Form Types for Your Dashboard

In the general tab select the form types you wish to link to the dashboard in the document type section.

You can also name your dashboard in the dashboard name input box.

The Widget and Layout Screen

The widgets and layout screens is on a single page so that you can visually build your dashboard from a single page. 

The available widgets are:

Widgets are separated in to 2 tabs.

• New - where you can create new widgets

• Unused - widgets you have created but have not been added to the layout.

The layout area is a drag-and-drop canvas where widgets can be added via drag-and-drop and removed with ease. 

Dashboards can show more information about your project.

Create New Widgets

To create new widgets, click the New tab.

This tab will display all the widget types that can be created.

To create a new widget, simply click and drag it onto the layout, give it a name and click save.

Resize, Reposition Widgets with Drag and Drop

The layout screen allows you to drag and move widgets around. If the drop area has enough space to add the new widget it will add it there and reposition the other widgets to fit the screen.

You can also resize widgets by dragging the border to the size you require. The other widgets will adjust their position accordingly.

Removing a Widget 

To remove a widget from the layout click on the X icon in the widget hear 

When a widget is removed, it will be automatically replaced with a placeholder widget so your layout remains intact.

The widget that is removed will be available in the Unused Tab

Deleting a Widget

To delete a widget click on the X icon next to widget in the unused tab.

Editing a Widget

To edit a widget click on the edit (pencil) icon in the widget header or in the unused tab

What Widgets are Available?

Go to the widgets/layout tab to see a list of available widgets.

There are 8 widget types that are available

1. Placeholder

A placeholder widget is used to take up space to push other widgets to their desired location.  

2. Count

Provides the user with a number of documents that match a configured criteria which, when clicked, will take the user to a list of those documents.  

3. Graph

Allows the user to view, choose and add graphical reports on the Dashboard. The reports are based on the dashboard module and different reports can be selected via a drop down menu on the widget.

4. Action

Allows user to perform a configured action from the Dashboard such as create a specified document type or open an URL, and has the appearance of a button.

5. List

Provides the user with a grouped list of documents that match configured criteria which when clicked will open the documents in frame directly within the Dashboard. Useful for KPIs, contractual requirements or trigger points.

6. KPI

Allows you create a widget with the KPI information.

7. Summary

The summary widget gives the user all of the information they want to see regarding the current module. Technically it combines count widgets and introduces performance indicators into one widget.

8. HTML

Include custom HTML content on the dashboard

9. Label

Displays custom text

10. 2-Dimensional

Displays statistics based on 2 aspects of your metadata in a tabular format

Standard User Field Query Builder Options

Placeholder Widgets 

Placeholder widgets enable you to customise your dashboard layout to suit your needs. 

In the example below you may wish the graph widget to appear in the next row. To do so, we can add a placeholder widget to take up the space to push the graph widget to the 2nd row.

You can also drag the placeholder widget to the position you require to create the exact layout that you require. 

You can add as many placeholder widgets to the layout as you need.

Count Widgets

All Projects Option for Count Widgets

For count widgets, there is an "All projects" tick box. When this is ticked, it will automatically include all projects you have access to when reporting widget results. Any new projects added to your account will be automatically included.

If you tick all projects, and untick one or more from the list, all projects will be automatically unticked.

When saving it will save only the selected list of projects.

Select the form types to include in the widget, provide the display text for your widget and select a font size.

The count widget can also be customised in terms of colour. Make the selections required from the style drop down

Include Icon options (you can select an icon using the … button)

Select the project and the criteria to apply to this count widget (this criterion will be used to display the count on the dashboard)

Customize the colour style of your dashboard widget.

Conditional Formatting for Count Widgets

Customise your dashboards to match your KPI’s and visually identify and surface issues. Allowing you to drill through into the detail.

We've added a new configuration to count widgets that allow you to define conditional formatting for the widget.

You can set up the widget to change its colour based on the number of results for the widget.

To do so turn on the conditional formatting option. 

Then define your criteria and the colour of the widget when that criteria has been met.

Option for Count Widget - Calculation - Average of User Field 

An option for the count widget enables you to report on the average of a calculation user field across multiple forms.

In the Display As option pick average of user field.

Then pick from the available calculation user fields.

In this example, we have 3 forms with the Checked Percentage user field populated.

As the configuration is to show the average of these 3 forms for the Checked Y User Field, the calculation will be (80 + 80 + 40) / 3 = 66.67 %

Option for Count Widget - Calculation - Sum of Currency / Number

Select sum of user field to display a user field value as sum.

When the sum option is picked you can choose the following type of user fields: 

• Calculation user fields.

• Currency / number user fields.

When configured - it will add up the numbers based on the field picked and show it in the widget.

This can also be used for Contract Admin forms such as Budgets.

Start by creating a count widget.

Then under the Conditions area pick from the options available as to which calculation you'd like to perform.

Then pick from the available options for each Contract Admin form type. The table below details all the available options and the calculations that you can perform.

You can use Contract Admin fields in your widget criteria. 

Available options

Option for Count Widget - Calculation - % of Total Forms

With this percentage of total forms option for a count widget, you can calculate as a percentage the number of forms out of your total number of forms,  based on your widget criteria.

In the Display as pick - % of total forms

Then provide your criteria in the query builder.

In the example below, we are looking for the total number of closed forms as a percentage of the total number of forms.

As there is only 1 closed-form out of 3 total forms our calculation is (1/3) x 100% = 33.33 %

Option for Count Widget - Calculation Widget - Decimal places

Added option in the count widget when displaying % or an average of forms to display the configured number of decimals in the widget.

Option for Count Widget - Cascading User Field

You can configure a widget to search by a parent selection of a cascading user field. When this is done, the search results show forms that contain the parent and / or parent + sub-selection.

For example:

• Zone 1

• Zone 1/ Building 1

• Zone 1/ Building 2

If you create widget criteria with just the selection of Zone 1, it will find all forms with any of the sub-selections.

Option for Count Widget - Polygons

Refer here for more information.

Option for Count Widget - Date Based 

In Count widget, you have 3 date based options available : 1. Average Days Open, 2. Average Days Closed, 3. Average Days Late

1. Display Average Days Open 

You can configure a count widget to display the average of this for a form type :

Select Count Widget 

Drop down menus under 'Criteria' and select 'Status' 'equals' 'outstanding'

Under 'Conditions' select 'Average days open' (Days open calculation = Current date - Issued date of the form)

Give it a name under 'Display Text', for example 'Avg days open'

Click save, and see it appear in your dashboard

You can also add this column to the register view or a saved search

2. Display Average Days To Close

Select Count Widget 

Drop down menus under 'Criteria' and select 'Status' 'equals' 'outstanding'

Under 'Conditions' select 'Average days to close' (Days to close calculation =  last closed date - Issued date)

Give it a name under 'Display Text', for example 'Avg days closed'

Click save, and see it appear in your dashboard

You can also add this column to the register view or a saved search

3. Display Average Days Late

Select Count Widget 

Drop down menus under 'Criteria' and select 'Status' 'equals' 'outstanding'

Under 'Conditions' select 'Average days late' (Days late = current date - due date)

Give it a name under 'Display Text', for example 'Avg days late'

Click save, and see it appear in your dashboard

Count widgets - display as a Form Register.

In Dashboards - we’ve added a new display option so that when clicking on the count widget it displays the register view for those forms

As a user...

You can click on to that count widget and open it as a register view

Graph Widgets

Graph widgets allow you to display information in a graphical format.

Drag and drop the graph widget in the dashboard layout and click the pen icon to edit it

Then select the form type and the default graph you wish to display when the dashboard is loaded.

Pick a custom name for your graph if you want by clicking 'Display Text' 

Then click save

The user can change the widget from a list when viewing the dashboard as needed.

Sorting Graph Charts

For graph widgets related to user fields, you can sort the chart using these options:

• Ascending (by result count)

• Descending (by result count)

• A-Z (with this option the chart will be sorted using the value name)

• Z-A (with this option the chart will be sorted using the value name)

When you pick a sorting option (ascending, descending) you can pick whether you wish to sort the chart by:

• total number of records

• open records

• closed records

Cumulative Graphs

Graphs that are represented over a time period can now be shown as a cumulative chart.

These charts can also be shown as a line or bar chart

Display Data by Code, Descriptions or Both

You can configure how the data in the charts are displayed. You can choose to display the data with:

• Code

• Description

• Both

Display More than 10 Items on a Graph

Graph widgets can now be configured as a full-width widget

And they display more than 10 options in the chart.

To view more options you can use your mouse scroll wheel to zoom in and out of the data.

You can also use your mouse to click and drag the chart left or right to see more data.

Chart Types

You can also display various charts as either a bar chart, line chart, doughnut chart or pie chart

Bar Charts

Bar charts can also be configured as

• Bar Chart stacked

• Bar Chart next to each other

In a stacked bar chart the open and closed forms will display in a single bar which is stacked

In a bar chart where the data is next to each other the open and closed forms will be displayed as 2 bars.

Line Charts 

Pie Charts 

A pie chart is used to illustrate the distribution of data as slices of a circular graph proportional to the percentage each category

Horizontal Bar Chart

A horizontal bar chart is used to compare data with horizontal bars, where the length of each bar corresponds to the quantity or value

Donut Charts

A donut chart is used to illustrate the distribution of data as slices of a circular graph proportional to the percentage, but with a hole in the center

Show Status Categories

Leveraging the Status Categories feature we rolled out in the April release you can now display your graph widgets using status categories

For Bar charts - change the display format from default to Category Colour

Action Widgets

Action widgets are slightly different from the widgets mentioned above. An action widget allows you create a shortcut to another action within the system.

There are 4 different types of actions that can be configured:

1. Creating a form type (this allows you to add a button that acts as a shortcut to creating a particular form type)

2. Link to a web page (create a link to a web page)

3. A start wizard (start wizard allows you to link to several of the wizards within RIB CX).

    There are 5 types of wizards available

    i.  Creating a Tender Database (starts a wizard to create a tender DB)

    ii. Creating a Tender Package (starts a wizard to create a tender package)

    iii. Setting up a Tender Project (starts wizard to setup Tenders on a project)

    iv. Bulk Action Tools (starts wizard to launch the bulk action tools)

    v. Bulk create packages (starts wizard to bulk create packages) 

4. A link to a report (you can link to 2 system reports via this action)

    i.  The workflow report

    ii. The Design Issue Report

5. Configure the display text and style as required and click Save

List Widgets

Select the form types to be used on the list widget

Provide a name for the list widget. This is required

Place a tick in the Grouped checkbox if you want to group the results.

Choose what you want your list to be grouped by:

• Due Date

• Created Date

• Status

Choose how you want your list to sort:

• Ascending 

• Descending

Select the project or projects you would like to use as part of this widget.

Configure the Criteria for the list you wish to display using the query builder and click on Save

Furthermore, you can see register view. Do this by 1. configuring criteria for which forms you wish to display 2. columns you wish to display within the table.

KPI Widgets

Click + to add the KPI widget

Then configure the widget by picking the type and comparison time

Summary Widgets

A summary widget combines count widgets and KPI's

Click + to add the widget

And on the summary widget config select the count widgets order and the performance indicators you wish to display

Then click save

HTML Widgets

An HTML widget allows you to add custom HTML content inside the widget.

To add one click +

Then paste the HTML data you wish to display in the content area

Click Save

Label Widget

Label allows you to drag and drop it on the dashboard, position it where you like in the layout, then add the text for your label and click save.

2-Dimensional Widget

The 2-dimensional widget allows you to report on 2 aspects of your metadata in a tabular format. First set the criteria for what you want see in the table. For example, the Status can be any of these criteria, and Issue can contain the selections. Then select Status on X-Axis and Issue on Y-Axis :

As a result of the above, you will see the widget below reporting on form status and Issue type

In 2-dimensional table you can choose from : 

Standard fields

• Author

• Action user (where multiple users are in action, they will be shown in separate rows)

• Status

• Status Category

User fields : You can also use either of the following

• Select

• Radio

• Checkbox

Drill into information

You can drill into the information in the table by clicking the counts within the table or the total columns or rowsThis will automatically run a search to show you those results

Configuring Breadcrumbs

Breadcrumbs allows you to perform quick searching on the dashboard screen. The options available for breadcrumb searching can be customised to suit how you wish to search for forms on your projects.

To configure breadcrumbs, click on the breadcrumb tab on the dashboard config page.

Select the form types you wish to include in the breadcrumb. This can be one or more.

Then select the criteria that you wish to include in the breadcrumb search. The order you add them will be the order that will be shown in breadcrumb when searching.