devdocs/tools.txt

@@ -780,3 +780,14 @@ https://www.hanselman.com/blog/dotnettrace-for-net-core-tracing-in-perfview-spee
 
 how to read a flame graph:
 https://www.brendangregg.com/FlameGraphs/cpuflamegraphs.html
+
+
+
+//////////////////////////////////////////
+DIAGRAM MAKER
+This web app absolutely rocks:
+https://app.diagrams.net/
+
+I used it to make the work order structure diagrams with boxes and arrows and lines for the documentation.
+It's free and even has a windows desktop version available but the web one worked perfectly in ff.
+You can export SVG, PNG or XML source files

docs/8.0/ayanova/docs/svc-workorders.md

@@ -26,7 +26,7 @@ The user interface mirrors the logical structure of a work order with a single h
 
 ### Walk-through: creating a work order
 
-Let's walk through creating a work order:
+Let's walk through creating a simple work order:
 
 #### Create new work order
 
@@ -60,6 +60,8 @@ We're using a desktop computer with a keyboard here and don't want to take our h
 
 The Customer is now selected as required by the form validation rules and it no longer displays a red validation error message.
 
+#### Saving the work order
+
 This is a good time to save the Work order to the server.
 
 Currently, you can see it hasn't been saved yet as it does not have a work order serial number displayed and the URL bar shows it's internal record id is zero meaning it has no server provided ID number yet and only exists here in the browser.
@@ -72,15 +74,15 @@ Let's click on save now:
 
 ![Work order walkthrough 6](img/svc-work-order-walk6.png)
 
-This action submits the form to the AyaNova server where it will validate the work order to check for any errors or broken business rules.  If errors are found it will not save the record but instead return a list of one or more validation errors to the User to correct the problems.  If no errors are found it will update the object in the database.
+This action submits the form to the AyaNova server where it will validate the work order to check for any errors or broken business rules. If errors are found it will not save the record but instead return a list of one or more validation errors to the User to correct the problems. If no errors are found it will update the object in the database.
 
-In this case there are no errors and so a new work order record is created in the database and the server returns a copy of the work order back to the browser.  The reason it returns a copy of the work order is because it has itself made some changes to the work order.
+In this case there are no errors and so a new work order record is created in the database and the server returns a copy of the work order back to the browser. The reason it returns a copy of the work order is because it has itself made some changes to the work order.
 
 AyaNova has assigned this new work order and internal ID number of 104 which you can see in the URL bar which has changed from record 0 to record 104:
 
 ![Work order walkthrough 7](img/svc-work-order-walk7.png)
 
-Also you can see in the image that this browser tab now shows the work order serial number assigned which is also 104.  This is the page title in the browser and makes it easier to see what record is open in a operating system task bar.
+Also you can see in the image that this browser tab now shows the work order serial number assigned which is also 104. This is the page title in the browser and makes it easier to see what record is open in a operating system task bar.
 
 This URL in the web browser is a complete link to this exact work order record in AyaNova so, like any page in AyaNova you can bookmark in your browser this record if desired or send the url link to another User to open this same record (provided they have the rights to do so).
 
@@ -88,17 +90,59 @@ In addition to the record id in the URL, the work order serial number 104 is now
 
 ![Work order walkthrough 8](img/svc-work-order-walk8.png)
 
-The work order serial number and it's record id are actually two completely seperate things.  The record Id will not necessarily be the same as the work order serial number, it's just worked out that way as the work order serial number [automatic starting seed number](adm-global-seeds.md) has not been changed so record 1 was also serial number 1 etc.
+The work order serial number and it's record id are actually two completely seperate things. The record Id will not necessarily be the same as the work order serial number, it's just worked out that way as the work order serial number [automatic starting seed number](adm-global-seeds.md) has not been changed so record 1 was also serial number 1 etc.
 
-When we selected this Customer it had a [Contract](svc-contracts.md) and the Server automatically applied the Customer's Contract to this work order:
+Aside from the work order number the Server has also made some other changes to this work order for us.
 
+#### Automatic work order changes
 
+Because this work order is new and the Customer has been set, AyaNova was able to fill in some fields automatically based on the selected Customer.
 
+##### Address
 
+The server has automatically populated the Work order Address field from the Customer record. A work order keeps it's own copy of the Address to preserve the historical record if a Customer's address should later change and also a Work order may have it's own address distinct from the Customer for several reasons such as billing going to a [Head office](head-offices.md) or servicing a [Unit](svc-units.md) that has it's own address or no address at all, just GPS co-ordinates.
 
+![Work order walkthrough 9](img/svc-work-order-walk9.png)
 
+You can edit this address or change it at any time.
 
+#### Summary
 
+This optional field is a summary of the work to be performed overall. This field is intended to be viewed by the service technician and is displayed at the top of the stock "Service dispatch" report. Some shops work from the user interface directly on mobile devices, some print out dispatch reports to hand to technicians.
+
+Here we'll describe the overall problem:
+
+![Work order walkthrough 13](img/svc-work-order-walk13.png)
+
+This is a simple work order so we'll leave the other fields in the header empty as we won't be needing them for this job.
+
+Next up is to create a new Work order item to specify the equipment to be serviced and to schedule a service technician:
+
+#### Work order item
+
+Currently our work order only has a Header, there are no work order items so let's add one now. Work order items are added from the Items context menu:
+
+![Work order walkthrough 14](img/svc-work-order-walk14.png)
+
+Because there are no existing items there is only one option:
+
+![Work order walkthrough 15](img/svc-work-order-walk15.png)
+
+Click on it to create the new work order item:
+
+![Work order walkthrough 16](img/svc-work-order-walk16.png)
+
+In the image above, the form has changed to display the work order items table and the current (only) work order item's edit fields are displayed under the table.
+
+If there was more than one work order item they would also display in the table and clicking on the row would change the edit form fields to _that_ work order item record.
+
+Here we can see that the Summary field is required and needs to be filled in. Unlike the header summary field this one applies to this work order item only and it _does_ display on stock reports intended for Customers such as the Customer Invoice and Customer Work order reports.
+
+If this was a larger work order with multiple work order items then each separate aspect of service would be documented on each work order item independently. For such a simple work order there isn't much need to enter more than the same duplicate information from the header summary.
+
+Next up is to select the exact Customer [Unit](svc-units.md) that requires service as this particular work is to repair an item of equipment that we track in AyaNova:
+
+####
 
 ## How to use collections
 
@@ -318,3 +362,28 @@ Some objects contain a "Price override" field to allow for manually adjusting th
   Workorder status related notification uses:
   Completed - Use workorder status change type notification and any status that is of type completed relevant to user to get relevant completed state notification
   Completed follow up - follow up with customer after service with a workorder status age type notification on a completed type status and set age value to desired wait time to follow up.
+
+  0000000000000000000000000000000
+  typed this then realized too complex for simple example so leaving it here for maybe later inclusion.
+
+##### Contract
+
+When we selected this Customer it happened to have a [Contract](svc-contracts.md) so the Server automatically applied the Customer's Contract to this work order which affected a few different things.
+
+First the Contract field was set to the default Customer contract, in this case the "Gold" contract:
+![Work order walkthrough 10](img/svc-work-order-walk10.png)
+
+This was set automatically but could be changed or removed by the User.
+
+Because the Gold contract selected had some other settings they also triggered changes in the work order. First and most obviously an alert message is displayed at the top of the work order because the Gold [Contract](svc-contracts.md) has an optionaly alert message set:
+
+![Work order walkthrough 11](img/svc-work-order-walk11.png)
+
+The Contract also has a default [Response time](svc-contracts.md#response-time) of one day set which has caused the work order's [Date to be completed](#date-to-be-completed) field to automatically be set to one day after the default [Service date](#service-date) which was set to the moment in time the work order was created since we didn't set any other date when we first saved it.
+
+![Work order walkthrough 12](img/svc-work-order-walk12.png)
+
+The [Date to be completed](#date-to-be-completed) field optionally ties into the AyaNova [notification system](home-notify-subscriptions.md) to ensure service is completed when promised.
+
+The rest of the work order is a blank slate ready to be filled in.
+000000000000000000000000000000000000000000000000000000000