docs/8.0/ayanova/docs/home-dashboard.md

@@ -6,6 +6,8 @@ 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.
 
+Some widgets have multiple versions of the same widget which display different types of charts such as a line chart or bar chart.
+
 ## Authorization Roles required
 
 This form is available to all User's who have the Home -> Dashboard form available (not Subcontractor or Customer type users).
@@ -22,7 +24,7 @@ Widgets are selected and added to the dashboard for display on any device the sa
 
 ### 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 60 seconds which is added to ensure all widgets are not updating at the exact same moment.
+Most widgets depend upon data retrieved from the server. Widgets will refresh themselves automatically every few minutes (varies for each widget) plus an additional random value of up to 60 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.
 
@@ -32,6 +34,8 @@ When a User first opens the Dashboard it will be an empty form with an _Add_ but
 
 Widgets are automaticaly added to the final position rightmost / bottom most but can be re-ordered.
 
+Widgets are listed with an icon to indicate the display type as there may be multiple versions of the same widget but with varying types of charts displayed.
+
 ### Dashboard menu
 
 The Dashboard menu contains the Help and About AyaNova standard options as well as a duplicate of the Add button link.
@@ -42,6 +46,38 @@ If the User is a scheduleable type there will also be two additional menu items
 
 Each widget has a context menu at the top right with a several options available.
 
+#### Settings
+
+Each widget has a settings form unique to each widget. Options that may be displayed are:
+
+##### Name
+
+Used to customize the widget's title to replace the generic widget title.
+
+##### Color
+
+For charting widgets that display a single data set this sets the color of the line or bars or other charting element used. When there are multiple data sets AyaNova will automatically assign contrasting colors.
+
+##### Tags filter
+
+Many widgets offer filtering by one or more tags. Tags selected here are inclusive of any other existing tags on the records queried. So if you select "yellow" as a tag the record queried has to have a "yellow" tag to match but is allowed to have any number of other tags.
+
+For most work order related widgets you can select the main work order header tags and also the work order item tags independently.
+
+##### Work order status filter
+
+Select a work order status to filter the data queried to only work orders with that particular status. Note that not all status will be listed for all widgets as in some cases the widget only displayes data from work orders that are not yet set to a Completed status so only non Completed status will appear in the selection list.
+
+##### Time span
+
+Controls the date range queried for the data displayed. The exact field queried varies by widget but is related to the primary information being displayed in the widget. For example with a labor hours related widget this would be the work order item labor start and end dates.
+
+Many pre-set time spans are offered, for example "This year", "This month" etc.
+
+##### Interval
+
+Interval is the unit of time to summarize values for display. If the unit is Months then each month is summarized, if days then a summary is calculated for each day.
+
 #### 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.
@@ -69,3 +105,66 @@ The Last option moves the widget to be displayed to the last position which is b
 #### Remove
 
 The remove option removes the widget from display.
+
+### Widgets available
+
+#### Not Scheduled
+
+![not scheduled](img/widget-not-scheduled.png)
+
+This list format widget displays all [work orders](svc-workorders.md) that have no Scheduled Users and do not have a completed work order status set. Each list item can be clicked on to open that work order. This widget automatically updates every 5 minutes approximately.
+
+Columns displayed are work order number, service date, customer name and a second line with the Work order summary.
+
+Available to the following roles:
+
+- Accounting
+- Business administration
+- Business administration - restricted
+- Service manager
+- Service manager - restricted
+- Service technician
+- Service technician - restricted
+
+Available filter criteria:
+
+- Work order tags
+- Work order item tags
+- Work order Status
+
+#### Reminders
+
+![reminders](img/widget-reminders.png)
+
+This day schedule format widget is available to all users with a dashboard and displays all personal [Reminders](home-reminders.md) for the current day. It will automatically scroll to the current hour and updates every 5 minutes approximately. There are no criteria for this widget. Clicking on an Reminder displayed will open it for editing.
+
+#### Reviews
+
+![reviews](img/widget-reviews.png)
+
+This day schedule format widget is available to all users with a dashboard and displays all personal [Reviews](home-reviews.md) for the current day. It will automatically scroll to the current hour and updates every 5 minutes approximately. There are no criteria for this widget. Clicking on an Review displayed will open it for editing.
+
+#### Scheduled
+
+![scheduled](img/widget-scheduled.png)
+
+This day schedule format widget is available to scheduleable users with a dashboard and displays all personal scheduled work orders for the current day. It will automatically scroll to the current hour and updates every 5 minutes approximately. There are no criteria for this widget. Clicking on an Work order displayed will open it for editing.
+
+#### Service rate quantity
+
+Personal chart showing labor hours for current User, available as a Line or Bar chart:
+
+![labor hours personal line chart](img/widget-labor-hours-personal-line.png)
+
+![labor hours personal bar chart](img/widget-labor-hours-personal-bar.png)
+
+These chart format widgets are available to scheduleable users with a dashboard and display all personal labor hours summarized by selected time span and selected interval. 
+
+They will automatically update every 15 minutes approximately. 
+
+Available filter criteria:
+
+- Time span
+- Interval
+- Work order tags
+- Work order item tags