This commit is contained in:
2022-02-23 22:28:41 +00:00
parent 58240ad03e
commit b18d5ad0b4

View File

@@ -1,3 +1,71 @@
# HOME-DASHBOARD
# Dashboard
![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg)
The Dashboard [form](ay-start-form-overview.md) is used to select and display dashboard 'widgets' which are components that display specific information of interest to the User from other areas of AyaNova.
Each role and user type have different dashboard widgets available to them.
Widgets will display in many formats including lists or graphs or calendars depending upon the purpose and type of data being displayed.
## Authorization Roles required
This form is available to all User's who have the Home -> Dashboard form available (not Subcontractor or Customer type users).
Dashboard widgets are available to specific roles so the widgets available vary depending upon the [roles](ay-biz-admin-roles.md) assigned.
## How to access the Dashboard
- From the `Home` navigation pane `Dashboard` item
## How the Dashboard works
Widgets are selected and added to the dashboard for display on any device the same User logs in to.
### Auto-refresh
Most widgets depend upon data retrieved from the server. Widgets will refresh themselves automatically every 5 minutes plus an additional random value of up to 30 seconds which is added to ensure all widgets are not updating at the exact same moment.
When the view is changed to another form, the widgets are destroyed and no longer refresh. When the view moves back to the dashboard the widgets are re-instantiated and refreshed immediately and then on a cycle afterwards.
### Adding widgets
When a User first opens the Dashboard it will be an empty form with an _Add_ button. Click on the Add button (or the Add menu item option) and a list of Dashboard widgets available to _that_ user will be presented. Clicking on a widget in the list will add it to the display.
Widgets are automaticaly added to the final position rightmost / bottom most but can be re-ordered.
### Dashboard menu
The Dashboard menu contains the Help and About AyaNova standard options as well as a duplicate of the Add button link.
If the User is a scheduleable type there will also be two additional menu items providing a shortcut for them to view their Work order item scheduled user and Labor lists filtered to show their own items.
### Widget context menu
Each widget has a context menu at the top right with a several options available.
#### New
If the widget represents an item that can be created in AyaNova the New option is presented to create a new record of that type. Not all widgets will have a New options.
#### Refresh
This option, if present, forces the widget to update itself from the server immediately.
#### First
The First option moves the widget to be displayed in the first position which is topmost and leftmost depending upon the display size and orientation.
#### Backward
This option swaps places with the widget one place to the left (or one level upwards if displaying in a single column).
#### Forward
This option swaps places with the widget one place to the right (or one level downwards if displaying in a single column).
#### Last
The Last option moves the widget to be displayed to the last position which is bottommost and rightmost depending upon the display size and orientation.
#### Remove
The remove option removes the widget from display.