Create a Dashboard

How to create a Dashboard

Click the Edit Dashboard button to access the Action menu at the bottom of the Dashboard. The Dashboard is now in edit mode. Select the Add Dashboard menu item. You are prompted to enter a Dashboard Name. Click OK to confirm. The Dashboard has now been created. Select the Dashboard to edit it. Click End Edit or Refresh after Edit when completed.

Widgets

A Dashboard consists of a number of Widgets which are placed on a grid. The grid is 12 columns wide and each row is 100 pixels. The columns are automatically stretched as the browser windows is resized.

The Widgets are available in different types (see below) but all Widget types have a set of common attributes:

Widget Title

The title of the Widget which is displayed as a caption in the Widget box.

Back colour

The background colour of the widget as hex web colour (e.g. #FFFFFF for white). The default colour is "transparent" (as in no colour). Colours harmonizing with the Aligned Elements Web client look and feel are:

  • Blue - #587B94

  • Rust Red - #C9847A

  • Lighter Blue - #9AAFBE

  • Even lighter Blue - #BCCAD4

  • Even lighter Blue than that - #DDE4E9

  • White - #FFFFFF

  • Dark Grey - #444C4C

  • Green - #5fba7d

  • Red - #ea5443

Order

Display Order of the Widget, where 1 is the first widget in the upper left corner.

Column Span

The number of columns across which the Widget stretches. A number between 1-12.

Row Span

The number of rows across the which the Widget stretches. Any number larger than 0.

How to Add a Widget

Click the Edit Dashboard button to access the Action menu at the bottom of the Dashboard. The Dashboard is now in edit mode. Select the Add Widget menu item. You are prompted to select a Widget Type. Click OK to confirm. The Widget Editing dialog is now displayed. Enter data and click OK to confirm. Note that the dashboard change has been saved but the displayed Dashboard has not yet been updated. Click Refresh after edit to complete the edit session and refresh the Dashboard.

Some widgets rely on underlying data such as Queries and Charts. Prepare the underlying data before creating the widget.

How to Remove a Widget

Click the Edit Dashboard button to access the Action menu at the bottom of the Dashboard. The Dashboard is now in edit mode. Click the Minus button over the upper left corner of the Widget you want to delete to remove the Widget. Click End Edit to refresh the Dashboard.

How to Edit a Widget

Click the Edit Dashboard button to access the Action menu at the bottom of the Dashboard. The Dashboard is now in edit mode. Click the Edit button (cogwheel) over the upper left corner of the Widget you want to edit. This will display the Widget Edit dialog. Modify the widget data and click OK to confirm. Click End Edit to refresh the Dashboard.

Available Widget Types

Chart

Displays an existing Chart. In the Widget Edit dialog, first select the Document Object Type Name to access the available Charts of that type. Then select a Chart from the Chart drop down.

Query

Displays the output of an existing Query as a list of Document Objects. In the Widget Edit dialog, first select the Document Object Type Name to access the available Queries of that type. Then select a Query from the Query drop down.

Query Aggregate

A Query Aggregate is the result of a Query (the query output) displayed as a single number in a (optionally) coloured tile.

The available parameters for a Query Aggregate are:

Aggregate Type

The two main Aggregate Types are:

  • Count - the total number of Document Objects in the Query Output

  • Percent - the Count divided by the number of Document Objects in the input set, multiplied by 100 (displayed with 2 decimals)

If the Document Object type contains an attribute that is either an integer or a double, the aggregation can be performed no that attribute value.

The following aggregation types are then available:

  • Sum - The Sum of the values of the attribute for all Document Objects in the Query Output

  • Avg - Sum divided by number of Document Objects in the Query Output

  • Max - The largest attribute value found among the Document Objects in the Query Output

  • Min - The smallest attribute value found among the Document Objects in the Query Output

Attribute

The name of the attribute on which to perform the aggregate. Not applicable for the Count and Percent aggregate types.

The Attribute must be numeric attribute.

Unit Text

A text displayed below the number.

Colour Ranges

Defines colour range for particular values of the Query Aggregate number on the form "value<hexadecimal web colour code" e.g. if the output number is < 5, the background colour is set to be green, but if output number is > 4 then the background colour (using a hexadecimal web colour code) is set to red. The Ranges are divided by the pipe character (|). The example above would be defined as: 5<#00ff00|4>#ff0000

Project History

Displays a selected part of the Project History. In the Widget Edit dialog, the Project History filter parameters for selecting an adequate part of the Project History are available.

Project Information

Displays the information in the Project Information item. This Widget has no additional parameters.

This Widget does not display the Widget Title as caption. Instead the Project Information item title is displayed as caption.

Search Filter

Displays a list of items that corresponds to a search string. Refine the search using the following options:

  • Type Name - Restrict the search to objects of a particular type. Once selected you get access to select further refinement on the attributes in the type.

  • Title - search for words in the title of the Document Objects

  • Status - if the Document Object type has a Status attribute, search for attribute values such as Open or Closed. Use the special string openstatus to get any open status without knowing the exact value.

  • User - if the Document Object type has User Attribute, search for user names as values of the attribute. Use the special string currentuser to denote the currently logged in user.

  • Disabled - restrict the search to disabled Document Objects

  • Free text - search for IDs and any word in the attribute values in the Document Object.

  • Table Attributes - specify the column of the Table Attribute with the construct columnName:value. For empty values, use the special string notassigned. For nonempty values, use the special string assigned.

Consistency Coverage

Displays the Consistency Coverage for a selected number of Document Objects. Refine the selection of items with the following parameters:

  • Type Name - only Document Objects of a particular type

  • Chapter Name / ID - only Document Objects belonging to a particular Chapter

  • Include Subchapters - applies to the option above

Optionally display the Consistency Coverage of each Document Objects in the set by ticking the Show Grid checkbox.

User Favourites

Displays the Users Favourites as a list of Document Objects. This Widget has no additional parameters.

Test Run

Displays data from a selected Test Run. In the Widget Edit dialog, select the ID number of the Test Run to display. Optionally, select the Show Progress checkbox to display the statistics of Test Results of the selected Test Run. Optionally, select the Show Chart checkbox to display the burndown chart of the Test Run.

A burndown chart can only be displayed if the Test type is configured to display burndowns.

Text

Displays the entered HTML. This Widget has no additional parameters.

Export and Import a Dashboard

After a dashboard has been defined for one project, it can be exported to an xml-file. This file can be imported from a different project to speed up the dashboard configuration.

To export a Dashboard, click on Edit Dashboard and select Export Dashboard from the Actions drop down. After you have selected a Dashboard to export, your export file is ready for download. Click on End Edit to finish.

To import a Dashboard, click on Edit Dashboard and select Import Dashboard from the Actions drop down. Browse to your local Dashboard xml-file and click OK to import. Click on End Edit to finish.

Note that some data in a dashboard is project specific, e.g. Chapter or Test Run id:s. After importing a Dashboard, the user has to adapt these entries by manually editing the widgets. The user also need to ensure that any underlying configuration that is referenced by name such as charts or queries, exists.