Copyright © 2019 EarthSoft, Inc • Modified: 12 Nov 2019
This article describes how to use the Dashboard Editor to set the properties and layout of the dashboard and to add widgets to the dashboard. Select the More Options icon on the right-side of the dashboard header to open a drop-down menu. Select Edit from the drop-down menu to view the Dashboard Editor and view/modify properties of the current dashboard. The Edit menu is only visible if the user has owner permission for the current dashboard.
The Dashboard Editor will open.
The top part of the Dashboard Editor shows the dashboard header. Within the header, the following properties can be set:
•Title – Current title is displayed by default. Edit the title of the dashboard by typing directly into the title text box in the header. The dashboard title is restricted to 250 characters.
•Description – Current description is displayed (if one has been added). Edit the description of the dashboard by typing directly into the description text box (to the right of the title text box).
•Color – The default dashboard color is white. Change the background color of the dashboard header by selecting the Dashboard Themeicon and then choosing one of the colors from the drop-down menu. Available colors are red, green, blue, purple, and black.
•Toggle Favorite – The Toggle Favorite icon indicates whether or not the current dashboard is one of the user's favorites. Clicking the star will toggle a favorite. A gold star indicates the dashboard is a favorite dashboard and will be displayed in the Favorites section in the dashboard chooser.
•Session Facility Chooser – The Session Facility Chooser is indicated with the facility icon. If a facility is selected, the facility name will be displayed next to this icon. Selecting the facility name or the facility icon will open the Facility Chooser, where the user can choose a different facility or facility group for the session.
•Dashboard Facility – The dashboard can be set to have a default facility or facility group. To set the dashboard facility, first select the facility and then check the Dashboard Facility check box on the dashboard header. When the facility is set for the dashboard, the session facility chooser and facility name will no longer be displayed and permissions for this dashboard will be checked against permissions for the selected facility. To make a dashboard permanently facility agnostic (i.e., no facility), clear the session facility and then select the Dashboard Facility check box.
•Cancel – Select the Cancel button to exit the Dashboard Editor without saving changes.
•Save – Changes will be applied to the dashboard by clicking on the Save button. The Dashboard Editor will close after the save operation is complete.
Below the dashboard header, the layout of the current dashboard is displayed. Each section (or row) of the dashboard is denoted by its title (may be blank) and contains columns (at least one) and widgets. Each dashboard can contain numerous sections, but may become difficult to navigate if too many sections or widgets are added.
Edit the dashboard layout as described below. Remember to Save the Dashboard to keep any changes to the layout.
Edit the section title by typing directly into the title text box. The section title is restricted to 250 characters. If no title is entered, the section header will not be displayed on the dashboard.
Add a new section at the bottom of the dashboard or between existing sections by clicking the Add Section button that appears at the bottom of each section in the layout. After clicking the Add Section button, a new section with a single column is created. More columns can be added to the new section. The height of the section is controlled by the maximum height of the widgets within the section.
Delete a section from the dashboard by clicking the Delete Section button that appears within the Section Title block. Deleting a section will delete all widgets and columns contained within that section. The user will be prompted with a confirmatory message prior to deletion.
You may add a new column within a section by clicking the Add New Column button at the bottom-right side of an existing column. The new column will be added to the right of the existing column. The width of the existing column (and widgets contained within) will be automatically be adjusted.
To adjust the width of an existing column (and widgets contained within), hover the mouse over the vertical bars () on the right-side of the column. When the mouse pointer changes to left and right arrows, move the mouse to increase or decrease the column width as desired.
Remove a column within a section by clicking the Remove Column button that appears at the bottom-right corner of each column within the section. Once a column is removed, the width of the remaining columns adjusts automatically. Deleting a column will delete all widgets contained within that column.
Warning: Selecting the Remove Column button removes the column without a confirmatory warning prompt. If a column is accidentally removed during the editing process, select the cancel button to not keep the changes.
Select the plus icon to add a widget in the desired location on the dashboard. Clicking the button will open the Widget Chooser. Once the Widget Chooser opens, select the desired widget. The widget will be displayed on the dashboard in the desired location. The horizontal extent of the widget is dictated by the column width. The height of the widget can be adjusted by dragging the horizontal bars () beneath the widget. Hover the mouse over the horizontal bars and when the mouse pointer changes to up and down arrows (), move the mouse to increase or decrease the height of the widget. Widgets can be moved by clicking on the widget header and dragging the widget to a new section of the dashboard.
To clone (i.e., copy) or remove a widget from the dashboard, select the More Options icon from the widget header to open a drop-down menu with the following options:
Clone – Selecting the Clone menu option copies the widget and adds the copy to the dashboard directly above the existing widget. This option is extremely helpful to duplicate already configured widgets.
Remove – Selecting the Remove menu option deletes the widget. The user will be prompted with a confirmatory message prior to deletion. Selecting the Cancel button will not delete the widget. Selecting the Yes button will remove the widget from the dashboard.
Help – Selecting the Help menu option opens the Enterprise documentation in a new tab.
The display of dashboard sections can be either in a stacked vertical alignment or as horizontal tabs. To change the dashboard appearance from stacked vertical sections (default view) to horizontally tabbed sections, select the Advanced Dashboard Editor icon to open the JSON editing window. Click on the Add Property button to add a string property called "layout". Set the "layout" property to "tabs". While in edit mode, the sections will appear in the standard vertical layout so that widgets can be dragged from one section to another. The tabbed layout will be visible once the dashboard edits are saved. To return to the stacked vertical sections view, set the "layout" property to "".