diff --git a/docs/8.0/ayanova/docs/img/svc-wo-loans-context-menu.png b/docs/8.0/ayanova/docs/img/svc-wo-loans-context-menu.png new file mode 100644 index 00000000..ce196552 Binary files /dev/null and b/docs/8.0/ayanova/docs/img/svc-wo-loans-context-menu.png differ diff --git a/docs/8.0/ayanova/docs/img/svc-wo-loans.png b/docs/8.0/ayanova/docs/img/svc-wo-loans.png new file mode 100644 index 00000000..9bcc3035 Binary files /dev/null and b/docs/8.0/ayanova/docs/img/svc-wo-loans.png differ diff --git a/docs/8.0/ayanova/docs/svc-workorders.md b/docs/8.0/ayanova/docs/svc-workorders.md index ae17d382..922f23a4 100644 --- a/docs/8.0/ayanova/docs/svc-workorders.md +++ b/docs/8.0/ayanova/docs/svc-workorders.md @@ -391,7 +391,7 @@ Note that this is a _copy_ operation, not a move. To move, copy first, save and #### Mark for deletion -Flag this work order item and **all** it's grand child collection to be permanently deleted. +Flag this work order item and **all** it's grand child collection to be permanently deleted. When clicked the work order item selected will display in the table with a line through it indicating it will deleted on the next save of the work order and an _Undelete_ button for reversing the delete flag will appear at the top of this work order items edit form. @@ -401,7 +401,7 @@ Until the work order is saved it's not actually deleted. #### Mark ALL for deletion -Flag all work order items on this work order and **all** their grand children to be permanently deleted when the work order is saved. +Flag all work order items on this work order and **all** their grand children to be permanently deleted when the work order is saved. When clicked all the work order items on this work order will display in the table with a lines through them indicating they will be deleted on the next save of the work order and an _Undelete_ button for reversing the delete flag will appear at the top of each work order item's edit forms. @@ -419,7 +419,7 @@ This menu option will appear if this work order item was migrated from an older The Work order item Unit is where you select a Customer owned Unit to be serviced. It's not necessary to choose a Unit here but it's a good idea if there is equipment being serviced because it will then be tracked in AyaNova and enable many additional features. -The Units section of a work order is **optional** and won't be displayed until a Unit is added from the [Work order Items context menu](#work-order-item-context-menu). +The Units section of a work order is **optional** and won't be displayed until a Unit is added from the [Work order Items context menu](#work-order-item-context-menu). It can also be completely removed as an option if it won't be required by [customizing](ay-customize.md) the work order form and un-checking the _Visible_ checkbox in the `Work order Item.Units` customization box. @@ -507,7 +507,7 @@ If this is not a concern or you do specifically want the **total** parts and lab #### Mark for deletion -Flag the selected row work order item Unit to be permanently deleted. +Flag the selected row work order item Unit to be permanently deleted. When clicked the work order item Unit selected will display in the table with a line through it indicating it will deleted on the next save of the work order and an _Undelete_ button for reversing the delete flag will appear at the top of this work order item Unit's edit form. @@ -517,7 +517,7 @@ Until the work order is saved it's not actually deleted. #### Mark ALL for deletion -Flag all work order item Units in this work order item only to be permanently deleted when the work order is saved. +Flag all work order item Units in this work order item only to be permanently deleted when the work order is saved. When clicked all the work order item Units on this work order item will display in the table with lines through them indicating they will be deleted on the next save of the work order and an _Undelete_ button for reversing the delete flag will appear at the top of each work order item Unit's edit forms. @@ -533,7 +533,7 @@ The Work order item Scheduled User record is where you schedule a service techni In addition [notifications](home-notify-subscriptions.md) may be triggered for Users that are subscribed to them so they are aware that they have been scheduled for service. -The Scheduled Users section of a work order is **optional** and won't be displayed until a Schedule User record is added from the [Work order Items context menu](#work-order-item-context-menu). +The Scheduled Users section of a work order is **optional** and won't be displayed until a Schedule User record is added from the [Work order Items context menu](#work-order-item-context-menu). It can also be completely removed as an option if it won't be required by [customizing](ay-customize.md) the work order form and un-checking the _Visible_ checkbox in the `Work order Item.Scheduled Users` customization box. @@ -591,7 +591,7 @@ This option doesn't require any scheduled user record rows to be selected as it #### Mark for deletion -Flag the selected row work order item scheduled user record to be permanently deleted. +Flag the selected row work order item scheduled user record to be permanently deleted. When clicked the work order item scheduled user record selected will display in the table with a line through it indicating it will deleted on the next save of the work order and an _Undelete_ button for reversing the delete flag will appear at the top of this work order item scheduled user's edit form. @@ -601,7 +601,7 @@ Until the work order is saved it's not actually deleted. #### Mark ALL for deletion -Flag all work order item scheduled users in this work order item only to be permanently deleted when the work order is saved. +Flag all work order item scheduled users in this work order item only to be permanently deleted when the work order is saved. When clicked all the work order item scheduled users on this work order item will display in the table with lines through them indicating they will be deleted on the next save of the work order and an _Undelete_ button for reversing the delete flag will appear at the top of each work order item scheduled user's edit forms. @@ -615,7 +615,7 @@ Until the work order is saved the items are not actually deleted. The Work order item Tasks feature is used to provide a check list of tasks to be performed and is useful for providing standardized service that ensures technician's follow each step. Tasks can be created uniquely per work order or selected from a pre-made list of tasks entered previously in a [Task Group](svc-task-groups.md). -The Tasks section of a work order is **optional** and won't be displayed until a Task record is added from the [Work order Items context menu](#work-order-item-context-menu). +The Tasks section of a work order is **optional** and won't be displayed until a Task record is added from the [Work order Items context menu](#work-order-item-context-menu). It can also be completely removed as an option if it won't be required by [customizing](ay-customize.md) the work order form and un-checking the _Visible_ checkbox in the `Work order Item.Tasks` customization box. @@ -667,7 +667,7 @@ Select the desired task group and click _Add_ to append them all to the current #### Mark for deletion -Flag the selected row work order item task record to be permanently deleted. +Flag the selected row work order item task record to be permanently deleted. When clicked the work order item task record selected will display in the table with a line through it indicating it will deleted on the next save of the work order and an _Undelete_ button for reversing the delete flag will appear at the top of this work order item task's edit form. @@ -677,7 +677,7 @@ Until the work order is saved it's not actually deleted. #### Mark ALL for deletion -Flag all work order item tasks, in this work order item only, to be permanently deleted when the work order is saved. +Flag all work order item tasks, in this work order item only, to be permanently deleted when the work order is saved. When clicked, all the work order item tasks on this work order item will display in the table with lines through them indicating they will be deleted on the next save of the work order and an _Undelete_ button for reversing the delete flag will appear at the top of each work order item task's edit forms. @@ -691,7 +691,7 @@ Until the work order is saved the items are not actually deleted. The Work order item Parts record is where you enter parts consumed during service. If inventory is [turned on](adm-global-settings.md#use-inventory) parts entered here will be **removed from inventory** the moment the work order is saved. -The Parts section of a work order is **optional** and won't be displayed until a work order item part record is added from the [Work order Items context menu](#work-order-item-context-menu). +The Parts section of a work order is **optional** and won't be displayed until a work order item part record is added from the [Work order Items context menu](#work-order-item-context-menu). It can also be completely removed as an option if it won't be required by [customizing](ay-customize.md) the work order form and un-checking the _Visible_ checkbox in the `Work order Item.Parts` customization box. @@ -817,7 +817,7 @@ Select the desired part assembly and part warehouse and click _Add_ to append th #### Mark for deletion -Flag the selected row work order item part record to be permanently deleted. +Flag the selected row work order item part record to be permanently deleted. When clicked the work order item part record selected will display in the table with a line through it indicating it will deleted on the next save of the work order and an _Undelete_ button for reversing the delete flag will appear at the top of this work order item part's edit form. @@ -827,7 +827,7 @@ Until the work order is saved it's not actually deleted. #### Mark ALL for deletion -Flag all work order item parts, in this work order item only, to be permanently deleted when the work order is saved. +Flag all work order item parts, in this work order item only, to be permanently deleted when the work order is saved. When clicked, all the work order item parts on this work order item will display in the table with lines through them indicating they will be deleted on the next save of the work order and an _Undelete_ button for reversing the delete flag will appear at the top of each work order item part's edit forms. @@ -841,7 +841,7 @@ Until the work order is saved the items are not actually deleted. The Work order item Labors record is where you enter labor provided during service. -The Labors section of a work order is **optional** and won't be displayed until a work order item labor record is added from the [Work order Items context menu](#work-order-item-context-menu). +The Labors section of a work order is **optional** and won't be displayed until a work order item labor record is added from the [Work order Items context menu](#work-order-item-context-menu). It can also be completely removed as an option if it won't be required by [customizing](ay-customize.md) the work order form and un-checking the _Visible_ checkbox in the `Work order Item.Labors` customization box. @@ -881,7 +881,7 @@ Here you select the service technician User that provided service. #### No charge quantity -Enter no charge hours here (Labor that was provided but will not be billed) so that they appear on the stock Customer invoice / work order and other reports and are tracked in the system. +Enter no charge hours here (Labor that was provided but will not be billed) so that they appear on the stock Customer invoice / work order and other reports and are tracked in the system. This value is **not deducted** from the _Service rate quantity_ it is simply tracked here so the Customer can see they received some free labor and so that time can be tracked in AyaNova for reporting and business metric purposes. @@ -957,7 +957,7 @@ Often the list of Tasks from the [Task section ](#tasks) is also the description #### Mark for deletion -Flag the selected row work order item labor record to be permanently deleted. +Flag the selected row work order item labor record to be permanently deleted. When clicked the work order item labor record selected will display in the table with a line through it indicating it will deleted on the next save of the work order and an _Undelete_ button for reversing the delete flag will appear at the top of this work order item labor's edit form. @@ -967,7 +967,7 @@ Until the work order is saved it's not actually deleted. #### Mark ALL for deletion -Flag all work order item labors, in this work order item only, to be permanently deleted when the work order is saved. +Flag all work order item labors, in this work order item only, to be permanently deleted when the work order is saved. When clicked, all the work order item labors on this work order item will display in the table with lines through them indicating they will be deleted on the next save of the work order and an _Undelete_ button for reversing the delete flag will appear at the top of each work order item labor's edit forms. @@ -975,20 +975,13 @@ You can also refresh the page to abandon this and any other changes made locally Until the work order is saved the items are not actually deleted. - - - - - - - ### Travels ![Work order item travels](img/svc-wo-travels.png) The Work order item Travel record is where you enter travel required to provide service. -The Travels section of a work order is **optional** and won't be displayed until a work order item travel record is added from the [Work order Items context menu](#work-order-item-context-menu). +The Travels section of a work order is **optional** and won't be displayed until a work order item travel record is added from the [Work order Items context menu](#work-order-item-context-menu). It can also be completely removed as an option if it won't be required by [customizing](ay-customize.md) the work order form and un-checking the _Visible_ checkbox in the `Work order Item.Travels` customization box. @@ -1032,7 +1025,7 @@ Here you select the service technician User that had to travel to provide servic #### No charge quantity -Enter no charge hours here (Travel that was required but will not be billed) so that they appear on the stock Customer invoice / work order and other reports and are tracked in the system. +Enter no charge hours here (Travel that was required but will not be billed) so that they appear on the stock Customer invoice / work order and other reports and are tracked in the system. This value is **not deducted** from the _Quantity_ it is simply tracked here so the Customer can see they received some free travel and so that time can be tracked in AyaNova for reporting and business metric purposes. @@ -1100,7 +1093,7 @@ Add a new work order item Travel record to the collection and open it's record i #### Mark for deletion -Flag the selected row work order item travel record to be permanently deleted. +Flag the selected row work order item travel record to be permanently deleted. When clicked the work order item travel record selected will display in the table with a line through it indicating it will deleted on the next save of the work order and an _Undelete_ button for reversing the delete flag will appear at the top of this work order item travel's edit form. @@ -1110,7 +1103,7 @@ Until the work order is saved it's not actually deleted. #### Mark ALL for deletion -Flag all work order item travels, in this work order item only, to be permanently deleted when the work order is saved. +Flag all work order item travels, in this work order item only, to be permanently deleted when the work order is saved. When clicked, all the work order item travels on this work order item will display in the table with lines through them indicating they will be deleted on the next save of the work order and an _Undelete_ button for reversing the delete flag will appear at the top of each work order item travel's edit forms. @@ -1121,6 +1114,180 @@ Until the work order is saved the items are not actually deleted. + + + + + + +### Loans + +![Work order item loans](img/svc-wo-loans.png) + +The Work order item Loans record is where you enter and track [Loaner items](svc-loaners.md) which is equipment loaned / rented to a Customer. + +The Loans section of a work order is **optional** and won't be displayed until a work order item loan record is added from the [Work order Items context menu](#work-order-item-context-menu). + +It can also be completely removed as an option if it won't be required by [customizing](ay-customize.md) the work order form and un-checking the _Visible_ checkbox in the `Work order Item.Loans` customization box. + +If more than one loan record is added to the work order item they will be displayed in a table with an edit form below. Selecting a row in the table will switch the edit form below to the row selected. + +A work order item can have zero to many separate Work order item loan records as required. + +All Work order item loan edit form fields here are **optional** unless marked otherwise. + + +#### Loan item + +This **required** field is where you select the [Loaner items](svc-loaners.md) for this record. + +#### Rate + +This field specifies the time period of the loan / rental of the loan item. The fixed values avaiable correspond to time periods on the [Loaner items](svc-loaners.md) form where you can enter the prices and costs for each time period provided. + + + + + +#### Service Start date time + +This field is a [date time field](ay-start-common-controls.md#date-and-time) control and is used to enter the point in time when loan began. + +If the [Global settings Scheduled / loan default minutes](adm-global-settings.md#scheduled--loan-default-minutes) value is set, AyaNova will automatically set the _Service Stop date time_ and _Quantity_ on new records. + +If a stop time is already set, adjusting the start time will cause AyaNova to calculate the _Quantity_ field automatically. + +#### Service Stop date time + +This field is a [date time field](ay-start-common-controls.md#date-and-time) control and is used to enter the point in time when loan ended. + +If the [Global settings Scheduled / loan default minutes](adm-global-settings.md#scheduled--loan-default-minutes) value is set, and the _Service Start date time_ field is empty, AyaNova will automatically set the _Service Start date time_ and _Quantity_ on new records. + +If a start time is already set, adjusting the stop time will cause AyaNova to calculate the _Quantity_ field automatically. + +#### Service rate quantity + +This is hours of service to be recorded / billed. It doesn't have to match the selected time period between the start and stop fields but it's a good idea to do so to avoid confusion. + +#### Service rate + +This is the [service rate](acc-service-rates.md) that is billable rate for this loan item. + +#### User + +Here you select the service technician User that provided service. + +#### No charge quantity + +Enter no charge hours here (Loan that was provided but will not be billed) so that they appear on the stock Customer invoice / work order and other reports and are tracked in the system. + +This value is **not deducted** from the _Service rate quantity_ it is simply tracked here so the Customer can see they received some free loan and so that time can be tracked in AyaNova for reporting and business metric purposes. + +#### Sales Tax + +[Tax](acc-tax-codes.md) to be charged for this Loan. + +#### Price override + +Manually force the price to a certain value. This override supersedes any other source for the price including Contracts and / or the source object's price itself. + +Contract adjusted pricing is not part of the Manual Price Override feature; only values entered by a user manually in this field will be present. + +#### Service details + +This optional field is used to record the details of the loan provided. Text entered here appears on stock work order and invoice reports as the explanation of loan provided and is (along with all other text entered on a work order) indexed for searching so it can be useful as a reference for future technicians searching for past resolutions to similar problems. + +Typically the more technical or complex the loan provided the more details are entered here. + +You can also automatically append all Tasks here from the loan context menu. + +### Loan table info fields + +The loan table contains some read-only fields that are calculated or brought in from other records for reference purposes. Some of these fields are only visible to [higher rights users](#cost-restrictions). + +#### Unit of measure + +This is mirrored from the [Service rate's](acc-service-rates.md) _Unit charge description_ field and can be removed if not required through [Customizing](ay-customize.md) the work order form. + +#### Cost + +This is mirrored from the [Service rate's](acc-service-rates.md) _Cost_ field and can be removed if not required through [Customizing](ay-customize.md) the work order form. + +#### List price + +This is mirrored from the [Service rate's](acc-service-rates.md) _Retail charge_ field and can be removed if not required through [Customizing](ay-customize.md) the work order form. + +#### Price + +This is the calculated effective price of this record. If Price override is set, _that_ is the effective price no matter any other setting, otherwise it's the Loans List price as is, or adjusted if there is a Contract with a Service rate price adjustment in effect. + +#### Net price + +This calculated value is the effective Price field multiplied by the Service Rate Quantity field. + +#### Tax A amount + +Net price multiplied by the selected Tax's A percentage. + +#### Tax B amount + +If the selected Tax does not have a Tax B set this field will be zero. + +If the selected Tax has Tax on Tax checked then this value is (Net price + Tax A amount) multiplied by Tax's B percentage. + +If Tax on Tax is not set then this is Net price multiplied by the selected Tax's B percentage. + +#### Line total + +Net price + Tax A amount + Tax B amount. + +### Loan context menu + +![Work order item loan context menu](img/svc-wo-loans-context-menu.png) + +#### New + +Add a new work order item Loan record to the collection and open it's record in the edit form. + +#### Append Tasks + +Often the list of Tasks from the [Task section ](#tasks) is also the description of the loan performed so this option will append the "task" text of all the Tasks in the current work order item to the [Service details](#service-details) field beneath any other text already entered there. + +#### Mark for deletion + +Flag the selected row work order item loan record to be permanently deleted. + +When clicked the work order item loan record selected will display in the table with a line through it indicating it will deleted on the next save of the work order and an _Undelete_ button for reversing the delete flag will appear at the top of this work order item loan's edit form. + +You can also refresh the page to abandon this and any other changes made locally to the work order that have not yet been saved at the server. + +Until the work order is saved it's not actually deleted. + +#### Mark ALL for deletion + +Flag all work order item loans, in this work order item only, to be permanently deleted when the work order is saved. + +When clicked, all the work order item loans on this work order item will display in the table with lines through them indicating they will be deleted on the next save of the work order and an _Undelete_ button for reversing the delete flag will appear at the top of each work order item loan's edit forms. + +You can also refresh the page to abandon this and any other changes made locally to the work order that have not yet been saved at the server. + +Until the work order is saved the items are not actually deleted. + + + + + + + + + + + + + + + + ## OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO ## Extras info that may or may not be added later