diff --git a/docs/8.0/ayanova/docs/customer-csr.md b/docs/8.0/ayanova/docs/customer-csr.md index a898e0b0..3d0143ab 100644 --- a/docs/8.0/ayanova/docs/customer-csr.md +++ b/docs/8.0/ayanova/docs/customer-csr.md @@ -1,3 +1,3 @@ -# CUSTOMER-CSR Placeholder +# CUSTOMER-CSR ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) diff --git a/docs/8.0/ayanova/docs/customer-notes.md b/docs/8.0/ayanova/docs/customer-notes.md index 13eceb9a..07cc999c 100644 --- a/docs/8.0/ayanova/docs/customer-notes.md +++ b/docs/8.0/ayanova/docs/customer-notes.md @@ -1,3 +1,3 @@ -# CUST-CUSTOMER-NOTES Placeholder +# CUST-CUSTOMER-NOTES ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) diff --git a/docs/8.0/ayanova/docs/customer-workorders.md b/docs/8.0/ayanova/docs/customer-workorders.md index a05dbe4f..896b54be 100644 --- a/docs/8.0/ayanova/docs/customer-workorders.md +++ b/docs/8.0/ayanova/docs/customer-workorders.md @@ -1,3 +1,3 @@ -# CUSTOMER-WORKORDERS Placeholder +# CUSTOMER-WORKORDERS ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) diff --git a/docs/8.0/ayanova/docs/customers.md b/docs/8.0/ayanova/docs/customers.md index c211ef9e..23cd997b 100644 --- a/docs/8.0/ayanova/docs/customers.md +++ b/docs/8.0/ayanova/docs/customers.md @@ -36,7 +36,7 @@ Customers are selected in many places in AyaNova including [Serviceable Customer ### Retiring -When a Customer is no longer required it should be set to inactive by un-checking it's Active checkbox so it is not offered for selection on new records. +When a Customer is no longer required it should be set to inactive by un-checking it's Active checkbox so it is not offered for selection on new records but will still display on old records. ## Customer data table diff --git a/docs/8.0/ayanova/docs/head-offices.md b/docs/8.0/ayanova/docs/head-offices.md index a394f3e8..0219bdd1 100644 --- a/docs/8.0/ayanova/docs/head-offices.md +++ b/docs/8.0/ayanova/docs/head-offices.md @@ -42,7 +42,7 @@ Head offices are selected in the [Customer edit form](customers.md). ### Retiring -When a Head office is no longer required it should be set to inactive by un-checking it's Active checkbox so it is not offered for selection on new records. +When a Head office is no longer required it should be set to inactive by un-checking it's Active checkbox so it is not offered for selection on new records but will still display on old records. Note that if there are active Customers assigned to this Head office then it should remain active. ## Head office data table diff --git a/docs/8.0/ayanova/docs/home-dashboard.md b/docs/8.0/ayanova/docs/home-dashboard.md index f8406d11..1aa533a5 100644 --- a/docs/8.0/ayanova/docs/home-dashboard.md +++ b/docs/8.0/ayanova/docs/home-dashboard.md @@ -1,3 +1,3 @@ -# HOME-DASHBOARD Placeholder +# HOME-DASHBOARD ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) diff --git a/docs/8.0/ayanova/docs/home-memos.md b/docs/8.0/ayanova/docs/home-memos.md index ceebf411..21785f48 100644 --- a/docs/8.0/ayanova/docs/home-memos.md +++ b/docs/8.0/ayanova/docs/home-memos.md @@ -1,3 +1,3 @@ -# HOME-MEMOS Placeholder +# HOME-MEMOS ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) diff --git a/docs/8.0/ayanova/docs/home-translation.md b/docs/8.0/ayanova/docs/home-translation.md index 75488835..431a51c6 100644 --- a/docs/8.0/ayanova/docs/home-translation.md +++ b/docs/8.0/ayanova/docs/home-translation.md @@ -1,3 +1,3 @@ -# HOME-TRANSLATION Placeholder +# HOME-TRANSLATION ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) diff --git a/docs/8.0/ayanova/docs/inv-part-assemblies.md b/docs/8.0/ayanova/docs/inv-part-assemblies.md index a99d21b1..b721e04b 100644 --- a/docs/8.0/ayanova/docs/inv-part-assemblies.md +++ b/docs/8.0/ayanova/docs/inv-part-assemblies.md @@ -1,3 +1,3 @@ -# INV-PART-ASSEMBLIES Placeholder +# INV-PART-ASSEMBLIES ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) diff --git a/docs/8.0/ayanova/docs/inv-part-inventory.md b/docs/8.0/ayanova/docs/inv-part-inventory.md index da3a6c21..9fed69fb 100644 --- a/docs/8.0/ayanova/docs/inv-part-inventory.md +++ b/docs/8.0/ayanova/docs/inv-part-inventory.md @@ -1,3 +1,3 @@ -# INV-PART-INVENTORY Placeholder +# INV-PART-INVENTORY ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) diff --git a/docs/8.0/ayanova/docs/inv-part-requests.md b/docs/8.0/ayanova/docs/inv-part-requests.md index c74d3752..d5d83916 100644 --- a/docs/8.0/ayanova/docs/inv-part-requests.md +++ b/docs/8.0/ayanova/docs/inv-part-requests.md @@ -1,3 +1,3 @@ -# INV-PART-REQUESTS Placeholder +# INV-PART-REQUESTS ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) diff --git a/docs/8.0/ayanova/docs/inv-part-serials.md b/docs/8.0/ayanova/docs/inv-part-serials.md index 8caff837..5331f528 100644 --- a/docs/8.0/ayanova/docs/inv-part-serials.md +++ b/docs/8.0/ayanova/docs/inv-part-serials.md @@ -1,3 +1,3 @@ -# INV-PART-SERIALS Placeholder +# INV-PART-SERIALS ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) diff --git a/docs/8.0/ayanova/docs/inv-part-stock-levels.md b/docs/8.0/ayanova/docs/inv-part-stock-levels.md index 997fadaa..46ce7907 100644 --- a/docs/8.0/ayanova/docs/inv-part-stock-levels.md +++ b/docs/8.0/ayanova/docs/inv-part-stock-levels.md @@ -1,3 +1,3 @@ -# INV-PART-STOCK-LEVELS Placeholder +# INV-PART-STOCK-LEVELS ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) diff --git a/docs/8.0/ayanova/docs/inv-part-warehouses.md b/docs/8.0/ayanova/docs/inv-part-warehouses.md index 86f89a81..a1f58722 100644 --- a/docs/8.0/ayanova/docs/inv-part-warehouses.md +++ b/docs/8.0/ayanova/docs/inv-part-warehouses.md @@ -1,3 +1,3 @@ -# INV-PART-WAREHOUSES Placeholder +# INV-PART-WAREHOUSES ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) diff --git a/docs/8.0/ayanova/docs/inv-parts.md b/docs/8.0/ayanova/docs/inv-parts.md index d9cf56ca..9e1555f0 100644 --- a/docs/8.0/ayanova/docs/inv-parts.md +++ b/docs/8.0/ayanova/docs/inv-parts.md @@ -1,3 +1,3 @@ -# INV-PARTS Placeholder +# INV-PARTS ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) diff --git a/docs/8.0/ayanova/docs/ops-jobs.md b/docs/8.0/ayanova/docs/ops-jobs.md index 46395d32..d1f87a1a 100644 --- a/docs/8.0/ayanova/docs/ops-jobs.md +++ b/docs/8.0/ayanova/docs/ops-jobs.md @@ -1,3 +1,3 @@ -# OPS-JOBS Placeholder +# OPS-JOBS ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) diff --git a/docs/8.0/ayanova/docs/svc-contracts.md b/docs/8.0/ayanova/docs/svc-contracts.md index 0f835a34..5e36b54b 100644 --- a/docs/8.0/ayanova/docs/svc-contracts.md +++ b/docs/8.0/ayanova/docs/svc-contracts.md @@ -86,7 +86,7 @@ Contracts are selected in many places in AyaNova including [Units](svc-units.md) ### Retiring -When a Contract is no longer required it should be set to inactive by un-checking it's Active checkbox so it is not offered for selection on new records. +When a Contract is no longer required it should be set to inactive by un-checking it's Active checkbox so it is not offered for selection on new records but will still display on old records. ## Contract data table diff --git a/docs/8.0/ayanova/docs/svc-csr.md b/docs/8.0/ayanova/docs/svc-csr.md index 766fd7f4..14c9c469 100644 --- a/docs/8.0/ayanova/docs/svc-csr.md +++ b/docs/8.0/ayanova/docs/svc-csr.md @@ -1,3 +1,3 @@ -# SVC-CSR Placeholder +# SVC-CSR ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) diff --git a/docs/8.0/ayanova/docs/svc-loaners.md b/docs/8.0/ayanova/docs/svc-loaners.md index 71aaa455..407f6cae 100644 --- a/docs/8.0/ayanova/docs/svc-loaners.md +++ b/docs/8.0/ayanova/docs/svc-loaners.md @@ -1,4 +1,4 @@ -# SVC-LOANERS Placeholder +# SVC-LOANERS ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) diff --git a/docs/8.0/ayanova/docs/svc-meter-readings.md b/docs/8.0/ayanova/docs/svc-meter-readings.md index 46141393..91ad98dc 100644 --- a/docs/8.0/ayanova/docs/svc-meter-readings.md +++ b/docs/8.0/ayanova/docs/svc-meter-readings.md @@ -1,3 +1,3 @@ -# SVC-METER-READINGS Placeholder +# SVC-METER-READINGS ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) diff --git a/docs/8.0/ayanova/docs/svc-projects.md b/docs/8.0/ayanova/docs/svc-projects.md index cea3b702..32746de6 100644 --- a/docs/8.0/ayanova/docs/svc-projects.md +++ b/docs/8.0/ayanova/docs/svc-projects.md @@ -1,3 +1,3 @@ -# SVC-PROJECTS Placeholder +# SVC-PROJECTS ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) diff --git a/docs/8.0/ayanova/docs/svc-quote-status.md b/docs/8.0/ayanova/docs/svc-quote-status.md index 7617555c..5fa7f217 100644 --- a/docs/8.0/ayanova/docs/svc-quote-status.md +++ b/docs/8.0/ayanova/docs/svc-quote-status.md @@ -1,4 +1,4 @@ -# svc-quote-order-status Placeholder +# svc-quote-order-status ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) #b4beta diff --git a/docs/8.0/ayanova/docs/svc-task-groups.md b/docs/8.0/ayanova/docs/svc-task-groups.md index 0c2b5e09..f0a7f7e4 100644 --- a/docs/8.0/ayanova/docs/svc-task-groups.md +++ b/docs/8.0/ayanova/docs/svc-task-groups.md @@ -1,3 +1,3 @@ -# SVC-TASK-GROUPS Placeholder +# SVC-TASK-GROUPS ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) diff --git a/docs/8.0/ayanova/docs/svc-unit-models.md b/docs/8.0/ayanova/docs/svc-unit-models.md index 28149e6a..28d98e62 100644 --- a/docs/8.0/ayanova/docs/svc-unit-models.md +++ b/docs/8.0/ayanova/docs/svc-unit-models.md @@ -1,3 +1,3 @@ -# SVC-UNIT-MODELS Placeholder +# SVC-UNIT-MODELS ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) diff --git a/docs/8.0/ayanova/docs/svc-units.md b/docs/8.0/ayanova/docs/svc-units.md index 74e17cf4..69fd9e53 100644 --- a/docs/8.0/ayanova/docs/svc-units.md +++ b/docs/8.0/ayanova/docs/svc-units.md @@ -1,4 +1,4 @@ -# SVC-UNITS Placeholder +# SVC-UNITS ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) diff --git a/docs/8.0/ayanova/docs/svc-work-order-item-priority.md b/docs/8.0/ayanova/docs/svc-work-order-item-priority.md index 9d7d9b0e..7dba844a 100644 --- a/docs/8.0/ayanova/docs/svc-work-order-item-priority.md +++ b/docs/8.0/ayanova/docs/svc-work-order-item-priority.md @@ -1,4 +1,4 @@ -# svc-work-order-item-priority Placeholder +# svc-work-order-item-priority ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) diff --git a/docs/8.0/ayanova/docs/svc-work-order-item-status.md b/docs/8.0/ayanova/docs/svc-work-order-item-status.md index 83b4e7b3..33b29896 100644 --- a/docs/8.0/ayanova/docs/svc-work-order-item-status.md +++ b/docs/8.0/ayanova/docs/svc-work-order-item-status.md @@ -1,4 +1,4 @@ -# svc-work-order-item-status Placeholder +# svc-work-order-item-status ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) diff --git a/docs/8.0/ayanova/docs/svc-work-order-status.md b/docs/8.0/ayanova/docs/svc-work-order-status.md index 1b90de83..6c0c80c0 100644 --- a/docs/8.0/ayanova/docs/svc-work-order-status.md +++ b/docs/8.0/ayanova/docs/svc-work-order-status.md @@ -1,17 +1,122 @@ -# svc-work-order-status Placeholder +# Work order status + +The work order status can be used for multiple purposes: + +- as flag to visually indicate the state of the service process +- for a business process control system when work needs to proceed through controlled stages step by step +- notification system to alert interested parties when a work order has reached a certain state +- a way to close and lock down a work order when all work has been completed + +## Authorization Roles required + +This form is available to User's with the following [roles](ay-biz-admin-roles.md): + +Full access + +- Accounting +- Business administration +- Service manager + +Read only access + +- Business administration - restricted +- Service manager - restricted +- Service technician +- Sales +- Sales - restricted + +## How to access work order status + +- From the [work order](svc-workorders.md) menu item `Work order status list` +- By clicking on the [open record icon](ay-start-form-autocomplete.md#opening-selected-record) in any Work order status selection list on any other form where Work order status can be selected +- From any [data table](ay-start-form-data-tables.md) column showing a work order status such as the [Work order list](svc-workorders.md) + +## How work order status works + +### Selecting + +Work order status are selected on [Work orders](svc-workorders.md). + +### Retiring + +When a work order status is no longer required it should be set to inactive by un-checking it's Active checkbox so it is not offered for selection on new records but will still display on old records. + +### Service process control + +Work order status is a powerful feature for service process control. + +Use of the [Who can select](#who-can-set) and [Who can remove](#who-can-remove) roles fields, the [Is a locking status](#is-a-locking-status) and [Is a completed status](#is-a-completed-status) fields in combination with the [notification system](home-notify-subscriptions.md) can help to ensure adherence to business processes of many kinds. + +For example ensuring that a department manager "signs off" on work before it progresses to the next stage by setting a locking status that alerts them and only they can remove or ensuring that an Accounting staff member invoices the customer when service work is completed by setting to a locking status dedicated to that purpose to more complex and specialized service flows where the service process needs to move through specific stages in a particular order so is "handed off" by setting the status for the next department to handle. + +## Work order status data table + +The Work order status [data table](ay-start-form-data-tables.md) lists all the work order status created, provides the '+' link to create a new status and provides access to common [data table menu options](ay-start-form-data-tables.md#common-menu-options). + +## Work order status edit form + +The edit form provides all the [standard edit form](ay-start-edit-forms.md) functionality and the following fields: + +#### Name + +This is the name of the Work order status as it's displayed in forms and reports. This is also the primary identifier when searching for a status to select in [autocomplete](ay-start-form-autocomplete.md) lists. A status name must be unique from all other work order status entered. + +This is the only **required** field on the form. All other fields are optional. + +#### Is a completed status + +When checked indicates that a work order set to this status is completely finished and no other work or editing will take place with this work order. + +We **strongly recommend** that work orders be set to a completed status once work is finished to fully take advantage of all features of AyaNova and have a reliable data set over time. + +Even if you do not need to use the features enabled by this right away, you don't want to be in a situation later where it's required but there are thousands of old work orders that need to be edited because they were never completed. + +This is an important designation because it enables multiple work order related [notifications](home-notify-subscriptions.md) such as: + +- Work order completed status overdue +- Work order total exceeds threshold +- Work order completed (Customer & staff notification) + +All those notifications will be triggered when a work order is set to any status with _Is a completed status_ set to true. For this reason it's important to only set this flag if it truly represents the moment in time that the above notifications should be triggered or prevented from being triggered in the case of the completed status overdue notification. + +In addition this status may be used to trigger other operations in AyaNova such as integration with 3rd party applications, accounting software integration, reporting filtering, business metrics calculations etc. + +We recommend that an _Is a completed status_ is also always set to a _Is a locking status_ locked status unless there is a very unique reason not to do so. + +#### Is a locking status + +When checked indicates that the work order should be locked and not editable until the status is changed to an editable status. Nearly all _completed_ type status should also have this checked / true. + +This can be useful for multiple purposes: + +- Locking a completed work order so no further editing takes place +- Freezing a work order temporarily as part of a progression through a larger service process involving multiple departments +- Temporarily freezing a work order while it is reviewed by a manager due to irregularities + +#### Who can select + +Here you can set which [Authorization Roles](ay-biz-admin-roles.md) a User _must_ have before they are allowed to select this status on a work order. If a User does not have the roles listed here they will not be able to _select_ that status on the work order. + +#### Who can remove + +Here you can set which [Authorization Roles](ay-biz-admin-roles.md) a User _must_ have before they are allowed to change _from_ this status to a different status. If a User does not have the roles listed here they will not be able to _change_ to another status. + +This is ideal for situations where a manager is required to "sign off" on work before it can proceed to the next stage in service or billing. + +Often a status will be restriced from removal but open to who can select so that, for example, when a service technician has completed work they can select a status that triggers a notification to a manager for review, locks down the work order but cannot be removed by anyone other than the manager once they've reviewed the work. + +000000000000000000000000000000000000000000000000000000 -![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) -#b4beta todo: locking - locks workorder from edit (other than status for roles that are in status can remove) -todo: completed - used for notification processing +todo: completed - used for notification processing todo: select roles - who can select this status todo: remove roles - who can remove todo: a section on why select and remove are there, how they can be used in conjunction with notification to enforce process control etc todo: A thorough section on PROCESS CONTROL with suggestions of commonly controlled aspects and hwo status satisifies them, e.g.: - Flow from intake to completion of final paper work - "New to be assessed and booked" - service manager / scheduler asses and assign to tech for repair - "Scheduled" - set to a tech to do the work - "Service completed" or "Awaiting parts" or "Awaiting customer approval" or whatever common scenarios - "Accounting step" - service complete, up to accounting to take, print and invoice customer etc they then set it to "Final / completed / closed" etc. +Flow from intake to completion of final paper work +"New to be assessed and booked" - service manager / scheduler asses and assign to tech for repair +"Scheduled" - set to a tech to do the work +"Service completed" or "Awaiting parts" or "Awaiting customer approval" or whatever common scenarios +"Accounting step" - service complete, up to accounting to take, print and invoice customer etc they then set it to "Final / completed / closed" etc. diff --git a/docs/8.0/ayanova/docs/svc-workorders.md b/docs/8.0/ayanova/docs/svc-workorders.md index b179fd37..1a42f86e 100644 --- a/docs/8.0/ayanova/docs/svc-workorders.md +++ b/docs/8.0/ayanova/docs/svc-workorders.md @@ -1,4 +1,4 @@ -# SVC-WORKORDERS Placeholder +# SVC-WORKORDERS ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) #b4beta diff --git a/docs/8.0/ayanova/docs/vendors.md b/docs/8.0/ayanova/docs/vendors.md index 862fa19a..79c95468 100644 --- a/docs/8.0/ayanova/docs/vendors.md +++ b/docs/8.0/ayanova/docs/vendors.md @@ -1,3 +1,3 @@ -# VENDORS Placeholder +# VENDORS ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg)