How to use the dashboard designer (v5)
The dashboard designer allows you to configure and edit the layout of the tiles on the page.
The dashboard designer works in the same way whether you are designing a dashboard or a perspective, but before you start you may find it helpful to understand which is best suited to your needs: How to create a dashboard and Working with perspectives.
The dashboard designer has been significantly improved in version 5, and we recommend that everyone upgrades to the latest version of Dashboard Server.
In v5 it is possible to create tile layouts that were only possible by editing the page JSON in older Dashboard Server versions. If you are using Dashboard Server v4 see How to use the dashboard designer (v4).
The dashboard is saved as you go along so there's no need to save your changes. You can find your draft dashboard by clicking on the right-hand menu ☰ > system > unpublished. Your draft dashboard is not visible to anyone other than you until you publish it.
You can toggle between Edit mode and View mode by clicking the edit this dashboard button at the top right.
This article covers:
You might like to watch this 2 minute introduction to the dashboard designer:
When you create a new dashboard or perspective you will be asked to select a template:
This instantly gets you started with preconfigured layout that you can change as you require.
So you might choose the Three tiles template:
You can add a new tile to any column:
You can add a new column to the left or right of any existing column:
Tiles added in a column are aligned by their left hand edge. Adding a row will allow you to align the tops of the topmost tiles in the columns in that row (see below):
Hovering between columns shows the resizing arrow. You can drag the column to any width or snap to the 25%, 33%, 50%, 66% or 75% lines.
Note: Hold down the shift key while resizing to stop the column snapping to the preset widths.
You can add a row before or after any existing row.
Tiles can be dragged and dropped anywhere on the dashboard. Hover over a white area at the top of the tile and you will see the 4-arrow movement cursor:
Hold the left mouse button down and drag the tile around the dashboard. A thumbnail of the tile is shown so you can more easily see a grey area indicating where the tile can be dropped.
You can drag it to the top or bottom of the dashboard to create a new row, but you'll need to create a new column before dragging if you want the tile to be added to a new column.
Individual tiles can be deleted using the Delete tile button at the top right of the tile:
There is no option to delete a whole row or column, instead you should delete or move individual tiles until the row or column is empty and is automatically removed.
When the last tile on a dashboard or perspective it removed the select a template option is shown.
The Split tile button splits one tile into two tiles. This is different to adding a column, and is more like creating nested columns within the existing column.
The benefit of using split tile is that you can add a tile below the split tiles that spans the width of both. To add a tile above the split tiles, first add a full width tile below them, then drag it up to position it above them.
The animation below shows how the split tile option can be used with add column and add tile:
After adding a split tile you can add further columns by using the add column button (rather than splitting again).
Cloning a tile copies the tiles configuration and creates a clone of that tile below the existing tile. You can then edit the tile configuration as required.
The cog or Edit tile button takes you into the configuration settings for the tile.
There are detailed articles for each of the different tiles, that take you through all the configuration options and a walkthrough to get you started.
For more information about how to configure each tile type see the list of tile articles here:
The dashboard is saved as you go along so there's no need to save your changes. You can find your dashboard by clicking on the right-hand menu ☰ > system > unpublished. Your draft dashboard is not visible to anyone other than you until you publish it.
A newly created dashboard will not be visible to others until you publish it. If you made changes to an existing dashboard, the changes will only be visible to others after you published the dashboard again.
You can identify a dashboard that has not been published yet or has unpublished changes by the unpublished button at the top:
When you click on the unpublished button, you'll have two options:
Publish will make the dashboard or changes visible to others.
Note: A newly created dashboard will appear on the menu where you created it. To move the dashboard to a different place on the navigation bar see How to edit the Navigation Bar.
Discard will delete your draft dashboard if it has never been published or, if you made changes to an already published dashboard, discard the changes.
Publishing dashboards to different audiences
Buttons at the top of dashboards
For more information about the other buttons at the top of the dashboard see:
In this walkthrough we're going to create a more complex dashboard using the split functionality and dashboard designer tools new to v5. We recommend you configure the tiles before creating too complicated a layout, because tiles do change size when showing data.
In SquaredUp navigate to where you'd like the dashboard to be created. Hover over the + button and click dashboard.
This image shows creating a dashboard at the top level of the navigation bar:
Or you might prefer to navigate to a subfolder and create the new dashboard there:
Give the dashboard a title, by replacing the text that says New Dashboard.
Click on the Two tiles template:
First we are going to configure the right-hand tile to show servers in a particular health state. Click configure tile on the right-hand tile:
Click on the Status tile button:
Click on the Icons tile button:
In the scope section click on advanced:
In the class box type
groupand select group from the drop down list.
In the criteria box type
HealthState = 3or whichever health state (see How to use criteria when scoping objects) you wish to display (1 = Healthy, 2 = Warning, 3 = Critical 0 = Uninitialized) to show a fairly long list for the purposes of this walkthrough. The case of the letters in the word
Click done. You should now have a dashboard with one long column on the right:
Hover between the columns and drag the column resizing line to the right allowing it to snap into place towards the right of the screen making the right hand column narrower:
We are now going to add a split to the left hand column. Click on the Split tile button on the left hand tile:
The left hand column will now show two tiles nested within it. Try resizing the whole of the left hand column to see how the two 50% cells within retain their dimensions and resize with the wider column.
Click add new tile beneath each of the split tiles to create 4 tiles:
To look like this:
Now click add new tile below the wider left-hand column to add a tile that spans the width of the two split tiles:
You should now have a dashboard that looks like this:
You can stop here, or you can add to your dashboard if you wish.
We recommend you configure some tiles now, to see how they fill out the space available. The 4 tiles at the top left of the dashboard would work well as Status donut tiles or Alert donut tiles.
You may find you need to create a new split and move tiles into that if you want the tiles to align by their top edge:
You may wish to add a large title for a wall monitor display, using the Web Content tile, and drag this to the top of the page or top of the split column:
Delete or move the individual tiles until the column or row is empty and then the empty column or row will automatically be removed. There is no option to delete a whole column or row.
Tile sizes will change slightly depending on the tiles you configure, and some tiles, such as Status and Matrix tiles, can dynamically show more or less objects. For example, the list of unhealthy servers may be longer one day than another. If you're aware that one tile may expand or contract you might not want to put another tile beneath this one, instead you could add tiles to other columns.
Some tiles have options that allow you to control the tile size:
You can use toggle zoom button at the top right of the tile to change between the different ways Status icons can be displayed.
|One long list|
Other tiles such as the Performance tile line graph, heatmap and Web Content tiles have a height slider:
Alert lists and Performance bar charts have an option to limit the number of results shown.
Add a new tile below, and then drag and drop (see Move tiles) the tile into the position you require above the existing tile.
- It is now possible to add a row before, as well as after, existing rows.
- It is possible to add columns to the left, as well as the right, of columns.
- A tile can be split to create nested columns so many more layout are possible without having to edit the JSON.
- Moving tiles is easier now because a four-way arrowhead is shown when hovering in the tile title area, and a thumbnail of the tile is shown so you can more easily see a grey area indicating where the tile can be dropped.
- There is no delete column button, instead delete or move the individual tiles until the column (or row) is empty and automatically removed.
- Columns can be made narrower than was previously possible.
Add a new tile to the empty column, then delete the newly added tile and the column will be removed.