Skip to main content
Version: 4.3

Dashboard

CMDBuild allows configuring dashboard pages made up of different kinds of components: charts (Bar, Pareto, Gauge, Pie, Line), tables, lists, tile groups, calendars and text blocks. Dashboards are then viewed in the Management Module.

Each dashboard can focus on a specific area, such as asset classification, service desk performance (SLA), economic indicators or other monitoring metrics, and supports a fully customizable layout: the Administrator defines rows, columns and column widths, and places components via drag and drop.

Dashboard

Properties tab​

General properties​

In this section you can configure:

  • Name and Description (both required).
  • Icon: used in the Management Module in the side menu and next to the page title.
  • Active: if unchecked, the dashboard is hidden in the Management Module.

Dashboard

Parameters​

In this section you can configure global parameters that can be used in the charts described in the next section.

Each chart includes a Use global parameter checkbox. When enabled, you can select a parameter compatible with the chart's data type.

When a global parameter is used, an additional fieldset is displayed at the top of the dashboard, allowing users to update the parameter value once and apply it to all charts that use it.

Parameter Types​

The following parameter types are available:

  • Integer
  • String
  • Boolean
  • Date

Dashboard

Integer Field Types​

For Integer parameters, the following field types are available:

  • Free value
  • Select from lookup
  • Card

String Field Types​

For String parameters, the following field types are available:

  • Free value
  • Select from all CMDBuild classes
  • Current user
  • Current group

Boolean and Date Parameters​

Boolean and Date parameters do not require a field type configuration.

Additional Configuration​

For each parameter, you can configure:

  • Label
  • Empty text

Layout​

The Layout section is where the dashboard is built. It is divided into two columns, called pools:

  • Dashboard pool (left): contains the components that will be shown in the dashboard. It becomes visible after clicking Add row.
  • Components pool (right): contains the components that can be dragged into the dashboard pool. It is visible only in create or edit mode.

Dashboard

Dragging a component from the components pool to the dashboard pool adds it to the dashboard; it will then be shown in the Management Module.

Row and column operations​

In the dashboard pool you can:

  • Add a row: Click the Add row button.
  • Move a row up or down: Use the Arrow buttons.
  • Add or remove columns: Use the Plus and minus buttons.
  • Change column proportions: Click the Table button.
  • Delete a row: Click the X button.

Configuring a dashboard​

To build a dashboard, drag components from the components pool to the dashboard pool, using the operations above to adjust the layout as needed. When a component is dropped, a window opens to configure it.

Components fall into three families:

  1. Data-driven: Includes Table, List, Calendar, and all chart types. Requires a data source.
  2. Self-contained: Includes Text. Requires no data source; content is configured directly in the component.
  3. Hybrid: Includes Tile group. The group itself has no data source, but each tile has its own function.

Data sources​

Every data-driven component reads its data from a data source, selected in the Administration Module through a combo box. In the Management Module the component then shows the data returned by the selected source.

The available sources depend on the component:

  • Charts (Bar, Pareto, Gauge, Pie, Line) and Tile (inside a Tile group): Supports Function only.
  • Table, List, Calendar: Supports Function, class or process, view.

When a class is selected as the source of a Table, List or Calendar, you can also attach a filter to restrict the records used.

If the selected function has input parameters, the component automatically generates an input form so that values can be entered. The form is generated for charts, Tables and Calendars; Lists never expose a parameters form, even if the function has parameters.

SQL function requirements​

Any component backed by a function must use a function that follows the CMDBuild conventions:

  • The header must include the comment TYPE: function.
  • All input parameters and output fields must be explicitly typed.
  • It must return a record set via RETURNS SETOF record.
  • Only a limited set of PostgreSQL types is supported (bigint, character varying, date, integer, numeric, text, timestamp). Complex or composite types must be avoided.
-- TYPE: function
CREATE OR REPLACE FUNCTION my_dashboard_function(start_date date, end_date date)
RETURNS SETOF record AS $$
BEGIN
RETURN QUERY
SELECT
category::text,
value::numeric
FROM my_table
WHERE date_field BETWEEN start_date AND end_date;
END;
$$ LANGUAGE plpgsql;
note

After creating or modifying a function, clear the CMDBuild cache or restart Tomcat so that the new structure is recognized.

Charts​

All chart types share the same data source setup (a function, whose parameters generate an input form) and a "chart properties" panel. The fields available in the panel depend on the chart type:

  • Bar: Category axis and value axis (titles and selectable fields), legend toggle, and orientation (horizontal or vertical).
  • Line: Category axis and value axis (titles and selectable fields), and legend toggle. Orientation is not available.
  • Pareto: Same axes as Bar, with fixed orientation and a single value field.
  • Gauge: No axes; features a min/max/steps scale with foreground and background colors, and a single value field.
  • Pie: Legend, label field, and value field.

Table, List and Calendar​

These components share the data source options described above. In addition:

  • Table: no further configuration is needed once the data source is set.
  • List:
    • the attributes used as title, description, tag and "meta" (catch-all) attribute;
    • an optional "show all" link, with its own filter;
    • whether clicking an item opens its card;
    • a record limit;
    • the message to show when there is nothing to display.
  • Calendar:
    • the date attributes that mark the start and end of an event;
    • the attribute used as event title;
    • the default view (month or agenda);
    • the color of the events.

Text​

The Text component does not use a data source. It shares the same properties panel as charts, but only exposes the HTML content field.

Tile group​

The settings of a tile group are the general properties, a layout style shared by all tiles, and a "tiles per row" limit.

Everything else is configured in the individual tiles, which are added one by one. Each tile has:

  • a label and an icon;
  • the function and the value field that provide the tile's number;
  • a unit of measurement;
  • a color (fixed or driven by an attribute);
  • an optional click-through destination: a class or process, restricted to all, filtered or selected items. The matching filter or specific card picker is shown only when relevant.

Permissions tab​

This section allows configuring permissions on the current dashboard for specific user groups. Permissions determine which groups can access the dashboard.

For details on permission management, refer to the relative section.