---
title: "Dashboards"
slug: "dashboards-user-guide"
updated: 2026-07-16T22:13:57Z
published: 2026-07-16T22:13:57Z
canonical: "docs.imat.io/dashboards-user-guide"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.imat.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Dashboards

Dashboards provide a real-time visual representation of your data. Visual representations can be displayed as charts or data.

---

  

## Prerequisites

Before a dashboard can be created, the following steps must be completed:

1. Create a single query or compound report in **Clinical Reports**. Note that compound reports must be written to a CSV file named `result.csv`.
2. Verify, or have your admin verify, that the [Available in dashboards](https://docs.imat.io/docs/sharing#share-with-dashboards) toggle is on in **Sharing**.
3. A user must be assigned to the [*searchappliance_search_by_id*](https://docs.imat.io/docs/groups#search-appliance-roles) role to access Dashboards.

---

## Create Dashboard

event_note Note:

Reports and queries must be shared *before* you open the **Dashboards** screen. If you open the page before sharing a report or query, it won’t appear until after the **Dashboards** page is reopened.

Visualizations are customizable representations of data and are mostly charts and graphs. However, text visualizations are available. These are useful if you want to display the number of records that match the criteria.

![](https://cdn.document360.io/5bf5f14a-9e3f-48aa-a2b9-2be6d9100091/Images/Documentation/image-1783543251845.png)Click on the image to zoom.

To create a dashboard and add a visualization, follow these steps:

1. Go to **Dashboards**.
2. Click add if **New Dashboard** is not already displayed. By default, navigating to **Dashboards** lands on a new dashboard screen.
3. Give it a name.
4. Give it a description if needed.
5. Click add**Visualization** to add a report.
6. Choose your report or query from the available options.

![](https://cdn.document360.io/5bf5f14a-9e3f-48aa-a2b9-2be6d9100091/Images/Documentation/image-1783543208856.png)Click on the image to zoom.

[Video](https://cdn.document360.io/5bf5f14a-9e3f-48aa-a2b9-2be6d9100091/Images/Documentation/Dashoards%20create.mp4)

1. Configure the chart. Click ![](https://cdn.document360.io/5bf5f14a-9e3f-48aa-a2b9-2be6d9100091/Images/Documentation/dashboards-data-view.png) to toggle between chart and data view.
  1. Data tab (the options change depending on the chart type chosen). Click add to open a drop-down of the fields or drag and drop them from the column on the left.
    1. Choose the chart type
    2. Choose the label
    3. Choose the values
    4. Choose a category (optional)
    5. Add fixed lines (optional)
    6. Add a data filter (optional)
  2. Settings tab:
    1. Adjust colors (optional)
    2. Adjust axis settings (optional)
  3. Visualization:
    1. Change the name* (optional)
    2. Add a visualization description (optional)
    3. Add a visualization filter (optional)
2. Click check to save the visualization.

![](https://cdn.document360.io/5bf5f14a-9e3f-48aa-a2b9-2be6d9100091/Images/Documentation/image-1783543231337.png)Click on the image to zoom.

1. Click add**Visualization** to add a new visualization.
2. Click check to save and close the dashboard or close to cancel without saving.

### Select Fields

The selected single query or compound report predetermines the available fields. Drag and drop the fields or click add in the input field.

[Video](https://cdn.document360.io/5bf5f14a-9e3f-48aa-a2b9-2be6d9100091/Images/Documentation/dashboards%20fields%20adjust.mp4)

### Format Fields

Format the visualization’s fields by clicking on the added field in the right column.

### Arrange Visualizations

While still in dashboard-editing mode, you can arrange the visualizations by dragging and dropping them in the order you want.

Resize a chart by clicking the chart and dragging one of the sizing handles that appear around the visualization outline.

---

![](https://cdn.document360.io/5bf5f14a-9e3f-48aa-a2b9-2be6d9100091/Images/Documentation/dashboards-edit.png)Click on the image to zoom.

## Edit Dashboard

To edit a dashboard after it has been saved, follow these steps:

1. Go to **Dashboards**.
2. Click folder and select the dashboard you want to edit.
3. Switch to edit mode, edit, when the dashboard loads.
4. You may do the following:
  1. edit the name
  2. edit the description
  3. edit individual visualizations
  4. add a visualization by clicking add**Visualization**
5. Click check to save and close the dashboard or close to cancel without saving.

Click visibility to go back to view mode without saving. Know, though, that all changes will be lost.

---

![](https://cdn.document360.io/5bf5f14a-9e3f-48aa-a2b9-2be6d9100091/Images/Documentation/dashboards-edit-visualization.png)Click on the image to zoom.

## Edit Visualization

Visualizations can be edited after they’ve been saved. To do so, follow the steps below:

1. Go to **Dashboards**.
2. Enter edit mode on the dashboard.
3. Choose edit (arrow shown) or more_vert on the visualization.
4. Edit the visualization by clicking on and changing the same options as in Step 7 in the [Create Dashboard](/v1/docs/dashboards-user-guide#create-dashboard) section.
5. Resize the box by using the sizing handles on the left and bottom of the selected visualization.
6. Click check to save and close the dashboard or close to cancel without saving.

Click visibility to go back to view mode without saving. Know, though, that all changes will be lost.

---

## Share Dashboard

Admins can share any created dashboard through the **Sharing** page. They will have to share all reports associated with the dashboard and the dashboard with the correct users.

---

[Video](https://cdn.document360.io/5bf5f14a-9e3f-48aa-a2b9-2be6d9100091/Images/Documentation/dashboards%20delete.mp4)

## Delete Dashboard

Deleting a dashboard removes all visualizations and the dashboard.

1. Select the dashboard you want to delete.
2. Click more_vert found next to the name or in the visualization itself.
3. Choose delete **Delete**.
4. Click Delete to confirm.

---

[Video](https://cdn.document360.io/5bf5f14a-9e3f-48aa-a2b9-2be6d9100091/Images/Documentation/Delete%20visualization.mp4)

## Delete Visualization

Deleting a visualization does not delete the dashboard. Any other visualizations on the dashboard will remain.

1. Select the dashboard you want to delete.
2. Select the visualization.
3. Click more_vert.
4. Choose delete **Delete**. Visualizations are removed immediately without asking for confirmation. However, no changes are final until the dashboard is saved.
5. Click check to save the dashboard.

---

  

## Verification Failure

"Status 400. Message: The report did not write a results.csv artifact file."

When selecting a report for a visualization, you may encounter this. It appears when the compound report has not been written to include the `results.csv` file. To fix this error, return to the report and include similar code as found below:

```python
with artifacts.open('result.csv', 'w') as file_handle:
    file_handle.write(your_csv_data)
```

---

* By default, it displays the query or report name. This is the only place where the name of the corresponding report is shown. If you change the visualization name, you will no longer be able to see which report was used for the visualization. This is true for every report or query used on the dashboard.

---

IMAT uses Reveal software for visualizations; you may find their [documentation](https://help.revealbi.io/user/) helpful.