Back to Knowledge Base
How to Build, Export and Import a Dashboard
Applies to CoCoCo platform v1.0.0-rc.31. Every step below was run on that version.
A dashboard is a board of cards that you put together yourself — notes, a table of records, metric charts or a custom app. Dashboards are separate from Home: Home shows custom apps as tabs (see Home and Dashboard Tabs), dashboards are built card by card here.
Before you start: you need the permissions to list, open and create dashboards (dashboard:list, dashboard:read and dashboard:write); deleting needs dashboard:delete.
Create a dashboard
Section titled “Create a dashboard”- At the top of the sidebar, click Dashboards.
- Click New Dashboard. The dialog Create Dashboard opens.
- Enter a Name. Description is optional.
- Under Visibility, choose Personal (only you see it) or Shared (everyone on your instance sees it).
- Click Create. The new, empty dashboard opens: No cards yet.
Add cards
Section titled “Add cards”- Click Add Card and choose the type of card (see Card types below).
- Enter a Card Title and the settings of the card type — for Markdown the text, for Resource Table the Resource and the Number of records.
- Click Add Card. The card appears on the dashboard. Repeat for every card.
The cards are stored with the dashboard: when you open it again, they are there.
Card types
Section titled “Card types”| Card | Shows |
|---|---|
| Custom App | one of your custom apps, inside the card |
| Resource Table | the most recent records of one kind, for example work centers |
| Markdown | your own text, formatted with Markdown |
| Metric, Metric Chart, Histogram, Gauge, Comparison | values of metrics |
Export and import
Section titled “Export and import”- On the dashboard, click the download icon at the top right. The dialog Export Dashboard opens.
- Choose JSON or YAML, then Download .json (or .yaml) — or Copy to copy the text.
- To load the file again, click Import in Dashboards, choose the file (or paste its content), optionally enter a new name under Dashboard Name (optional override), and click Import Dashboard. The imported dashboard opens with the same cards.
Delete a dashboard
Section titled “Delete a dashboard”In Dashboards, click Delete on the dashboard’s card and confirm Delete Dashboard with Delete.