Editing Dashboards

Some of the pages in iTop are dashboards. Dashboards are used to display information about different iTop objects on the same page. Most of the overview pages, as well as the welcome page are dashboards. In iTop 2.0, each user can configure their own dashboards by editing the existing dashboard pages. It is not possible to create new dashboard pages.

When a page is an editable dashboard, the small 3 dots menu at the top-right of the page, show a dropdown menu item to create a custom version.

Dashboard popup menu

After a few seconds a popup dialog appears containing the dashboard editor dialog:

Dashboard editor dialog

A dashboard is made of building blocks named after dashlets.

A dashboard itself arranges the display of the dashlets it contains. A dashboard has only three properties:

  • A layout (one, two or three columns)
  • An optional title
  • The automatic refresh setting (disabled, or refresh interval given in seconds)

The layout determines how the dashlets are arranged on the page: it determines a grid, with each dashlet being assigned to one cell of the grid. When the layout is changed, the cells (as well as the dashlets inside the cells) are re-organized to produce the desired display.

Dashboard Layouts

To edit the properties of a dashlet, click on it in the left part of the dialog. An orange border appears around the selected dashlet, and the properties of the dashlets are displayed on the right part of the dialog. To modify the appearence of the dashlet, simply modify the properties on the right. The dashlet will change to reflect your modifications. To remove the selected dashlet from the dashboard, click on the red cross at the top-right of the selected dashlet.

To add a new dashlet to the dashboard, drag one of the dashlet icons into the desired area of the dashboard, then adjust the properties on the right to finalize your dashboard.

You can also create a new dashlet from any list of iTop objects. See Managing Lists for more information about how to achieve this.

When you are done with editing, click on Save to save your modifications and go back to the iTop page.

To undo all modifications performed since clicking on Edit this page, click on Cancel.

The modifications of the dashboard apply the current user. All other users keep their own copy of the dashboard (or the default dashboard if they did not customize it)

Dashlet types

The following types of dashlets are available to compose your dashboard:

Icon Name Description
Text Text A free text area. Use this dashlet to add a title or a comment to a page
List Object List A list of iTop objects, displayed as a table, like any search result
Pie Chart Pie Chart A list of itop objects, grouped on the given field and displayed as a pie chart. New in 2.5: Instead of the count, various functions can be used (sum, average, min and max) on specified fields. The ordering direction can also be specified and the max number of results.
Bar Chart Bar Chart A list of itop objects, grouped on the given field and displayed as a barchart. New in 2.5: Instead of the count, various functions can be used (sum, average, min and max) on specified fields. The ordering direction can also be specified and the max number of results.
Group By (Table) Group By A list of itop objects, grouped on the given field and displayed as a table. New in 2.5: Instead of the count, various functions can be used (sum, average, min and max) on specified fields. The ordering direction can also be specified and the max number of results.
Header Header A grey banner with an icon on the left and a title.
Header with counts Header with counts A grey banner with an icon on the left, title and a table showing the count of objects grouped by a given field.
badge Badge A icon with a text showing the total number of objects of the given class and two links: 'create a new…' and 'search for…'

Dynamic Dashlet

Most Dashlets have an OQL within their properties. Those OQL can be twisted to be dynamic based on current user, current time and current object when there is one.

If the Dashboard is a Menu dashboard then you can use the 2 first methods

Based on Current user

:current_contact->id: This is the id of the contact linked to the connected user, it's 0 if no contact is associated to the user. It allows to display the Tickets for which the current user is the agent for eg.

SELECT Ticket WHERE agent_id = :current_contact->id

Based on Time

In the below OQL example, we display Tickets created in the past 30 days and not yet closed

SELECT Ticket 
WHERE creation_date > DATE_FORMAT(DATE_SUB(NOW(), INTERVAL 30 DAY),'%Y-%m-%d 00:00:00') 
AND STATUS != 'closed'  

Based on Current object

Only available for Dashboard Attribute defined on an Object, you can filter your OQL using any field of the current Object.

For example on Organization, you can use placeholders like :this->att_code where att_code can be any field of the Organization, including the id.

SELECT UserRequest WHERE org_id=:this->id

Edit the custom version

Once you have created a custom version of a particular dashboard, then you can only edit the custom version Editing the custom version of a dashboard

Switching between versions

At any time while browsing a dashboard you can switch the dashboard display from your custom version to the standard one and vice versa.

  • The icon with the building in orange is used to tell you that you are on the standard version: Standard dashboard icon
  • The icon with the person in orange is used to say that you are looking at the custom version: Custom dashboard icon

Exporting a dashboard

  • A dashboard definition can be exported as an XML file, for archiving or sharing it with other users.
  • To export a dashboard, click on the menu item Export to file….
  • When prompted, enter the download location (Where the exported dashboard will be saved to on your computer).

Exporting a dashboard

Importing a dashboard

Importing a dashboard

To import a dashboard definition from an XML file, click on Import from file… and select the XML file to upload from your computer.

If you import a dashboard on a dashboard menu that you have not yet customized, it will create a custom version automatically.

When you import a dashboard while you have already an existing custom version, that custom version will be lost.
Export it before, if you want to keep it.

Printing a dashboard

You can select the paper orientation, then use the print menu of your browser:

Printed version of a dashboard

Discarding the customizations

At any time, the customization of a dashboard can be discarded. Simply click on Delete Custom Version… and acknowledge the confirmation popup dialog.

Advanced customizations

Spliting cells

Sometimes it's a bit difficult to reorganize a dashboard manually, especially if you have a lot of dashlets within a cell and want to split them in multiple cells.

  1. On your dashboard, select the action Export to a file… and save the file on your PC
  2. Edit it with a XML editor and enter a piece of code below, where you want to split the cell
    • Each time you paste that code, replace X with a unique number to identify the new cell and its order in the dashboard
  3. Save the file
  4. On your iTop dashboard select the action Import from a file… and upload the saved XML file
Cell separator
    <cell id="X">

Example of XML file describing a dashboard

dashboard export
<?xml version="1.0"?>
<dashboard xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <cell id="0">
        <dashlet id="1" xsi:type="DashletHeaderStatic">
        <dashlet id="2" xsi:type="DashletBadge">
        <dashlet id="3" xsi:type="DashletBadge">
        <dashlet id="4" xsi:type="DashletBadge">
        <dashlet id="5" xsi:type="DashletBadge">
        <dashlet id="7" xsi:type="DashletBadge">
        <dashlet id="8" xsi:type="DashletBadge">
<!-- You want to split here -->
        <dashlet id="11" xsi:type="DashletHeaderDynamic">
          <query>SELECT UserRequest WHERE status != "closed"</query>
        <dashlet id="12" xsi:type="DashletObjectList">
          <query>SELECT UserRequest AS i WHERE i.agent_id = :current_contact_id AND status NOT IN ("closed", "resolved")</query>

Ordering status

  • The values order when editing in the UI the dashlet, may not be the one you want and the UI does not let you re-organize them.
  • There is a workaround, through XML edition using the same process as above.
  • This work is lost each time you edit this dashlet in the UI again :-( as it reorder using alphabetic order

        <dashlet id="11" xsi:type="DashletHeaderDynamic">
          <query>SELECT UserRequest WHERE status != "closed"</query>

latest/user/dashboards.txt · Last modified: 2024/06/20 17:28 (external edit)
Back to top
Contact us