From 11f09703924abf6eb588805b632c524d676e2f8a Mon Sep 17 00:00:00 2001 From: John Cardinal Date: Fri, 3 Sep 2021 20:39:46 +0000 Subject: [PATCH] --- .../ayanova/docs/ay-start-common-controls.md | 66 +++---- docs/8.0/ayanova/docs/svc-workorders.md | 179 +++++++++--------- 2 files changed, 123 insertions(+), 122 deletions(-) diff --git a/docs/8.0/ayanova/docs/ay-start-common-controls.md b/docs/8.0/ayanova/docs/ay-start-common-controls.md index e46a703c..221fa6f5 100644 --- a/docs/8.0/ayanova/docs/ay-start-common-controls.md +++ b/docs/8.0/ayanova/docs/ay-start-common-controls.md @@ -14,47 +14,47 @@ todo: document that emojis can be used in any text field and key combo on window todo: WIKI controls todo: DATA TABLES - (NOTE: stick to "Data table" terminology, previously was mixed use as "grid", not a grid anywhere, "Data table") - Need help page specific to DataTable usage, link to it from the top of all manual pages that are for DataList UI pages (e.g. Customers page) - Note: arbitrary 1024 max char text field length, truncates after that. - Note: Special note to indicate that filtering by a column then hiding that column is supported as a feature - User won't see the filtered column if they hid it but the filter still applies - User can tell it's still filtered by the prescence of the filter reset button (circle with X inside) to the right of the filter selection list - note: filtering system, column view system, saving filter, case sensitivity, tokens etc - hidden query-affecting columns: Data Table column selector button will change to larger and accented when this is the case and the column selector form will highlight these hidden columns that affect the view with raised elevation, accent color and filter+sort icon (both show, there is no distinction which type of way it's affecting) - Data table filtering on Duration / interval type columns: - Filters are limited to greater than or less than due to nature of this type of data which is very hard to match precisely due to millisecond differences - making equals or not equals useless for exact comparison. In addition these types of fields always have a value even if it's zero so they don't work with Has value / no Value either - Greater than and less than can be used to match any value desired by using two filters one greater one less and use of the OR or AND option as appropriate +Need help page specific to DataTable usage, link to it from the top of all manual pages that are for DataList UI pages (e.g. Customers page) +Note: arbitrary 1024 max char text field length, truncates after that. +Note: Special note to indicate that filtering by a column then hiding that column is supported as a feature + User won't see the filtered column if they hid it but the filter still applies + User can tell it's still filtered by the prescence of the filter reset button (circle with X inside) to the right of the filter selection list +note: filtering system, column view system, saving filter, case sensitivity, tokens etc +hidden query-affecting columns: Data Table column selector button will change to larger and accented when this is the case and the column selector form will highlight these hidden columns that affect the view with raised elevation, accent color and filter+sort icon (both show, there is no distinction which type of way it's affecting) + +Data table filtering on Duration / interval type columns: +Filters are limited to greater than or less than due to nature of this type of data which is very hard to match precisely due to millisecond differences +making equals or not equals useless for exact comparison. In addition these types of fields always have a value even if it's zero so they don't work with Has value / no Value either +Greater than and less than can be used to match any value desired by using two filters one greater one less and use of the OR or AND option as appropriate - ## Data Table TAG filters - - All tags are lower case always, case is not relevant in Tag filters. +## Data Table TAG filters - Order is not relevant in Tag filters, so {green, red} is no different than {red, green} when filtering is applied +All tags are lower case always, case is not relevant in Tag filters. - ### Filter types supported +Order is not relevant in Tag filters, so {green, red} is no different than {red, green} when filtering is applied - #### Equality - Exactly equal compare entire search term array to tag array in db - all terms in search exactly present and no others in db record - e.g. {red,green,blue} will return records with tags {green,red,blue} but *not* match {red,green,blue,orange} +### Filter types supported - #### Not equal - The opposite of Equality; specifically exclude rows that exactly match all the search terms - e.g. {red,green,blue} will return records with tags {red,green,blue,orange} but *not* match {green,red,blue} +#### Equality +Exactly equal compare entire search term array to tag array in db - all terms in search exactly present and no others in db record +e.g. {red,green,blue} will return records with tags {green,red,blue} but *not* match {red,green,blue,orange} - #### NO value - Will return records with no tags set at all +#### Not equal +The opposite of Equality; specifically exclude rows that exactly match all the search terms +e.g. {red,green,blue} will return records with tags {red,green,blue,orange} but *not* match {green,red,blue} - #### Has value - Will return records with any tag set +#### NO value +Will return records with no tags set at all - #### Contains - Returns records that contain the specified search tags. Records may have other additional tags but that's ok as long as it has the search term ones - e.g. {red,green,blue} will return records with tags {green,red,blue} and also {red,green,blue,orange} +#### Has value +Will return records with any tag set - #### Not contains - All terms in search query *NOT* present in db record, don't care what else is in db record as long as it's not the search terms (order insensitive) - e.g. {red,green,blue} will not return records with tags {green,red,blue} and also not return {red,green,blue,orange} but would return {red,green,black} +#### Contains +Returns records that contain the specified search tags. Records may have other additional tags but that's ok as long as it has the search term ones +e.g. {red,green,blue} will return records with tags {green,red,blue} and also {red,green,blue,orange} + +#### Not contains +All terms in search query *NOT* present in db record, don't care what else is in db record as long as it's not the search terms (order insensitive) +e.g. {red,green,blue} will not return records with tags {green,red,blue} and also not return {red,green,blue,orange} but would return {red,green,black} diff --git a/docs/8.0/ayanova/docs/svc-workorders.md b/docs/8.0/ayanova/docs/svc-workorders.md index 37cb728e..2b28ebac 100644 --- a/docs/8.0/ayanova/docs/svc-workorders.md +++ b/docs/8.0/ayanova/docs/svc-workorders.md @@ -21,118 +21,119 @@ docs / sections required ## Multiple Units note - * Work order item Unit - Enter a single Unit only in the work order item units collection if intend to run reports tying other work order item sections to that unit (e.g. labor hours spent on *that* unit, parts used with *that* unit, etc). Entering more than one unit per work order item will make it difficult to match other work order item record types to a particular unit when reporting. +* Work order item Unit - Enter a single Unit only in the work order item units collection if intend to run reports tying other work order item sections to that unit (e.g. labor hours spent on *that* unit, parts used with *that* unit, etc). Entering more than one unit per work order item will make it difficult to match other work order item record types to a particular unit when reporting. ## Add multiple units feature - * In Work order item Units menu there is an "Add multiple units" option which allows the ability to search for Units by tag and / or restrict to a specific Customer only. This is a quick way to select and add many Units at once to a work order for those situations where that kind of service is common and it would be time consuming to have to manually add each Unit one by one. +* In Work order item Units menu there is an "Add multiple units" option which allows the ability to search for Units by tag and / or restrict to a specific Customer only. This is a quick way to select and add many Units at once to a work order for those situations where that kind of service is common and it would be time consuming to have to manually add each Unit one by one. - * Contracts are not automatically offered for selection when bulk adding multiple Units unlike a single Unit selection using the Unit pick list. If a Contract is desired when adding multiple Units it can be manually selected from the Contract pick list in the Work order header section. - - * Add multiple units not restricted to current work order Customer: unlike the normal single Unit selection feature which is restricted to the currently selected Customer's own Units only, the add multiple Units feature intentionally allows a User to select Units that do not belong to the currently selected Customer on the work order. This is to support some unusual requirements for certain companies who bulk service Units that are moved around between Customers regularly but are not treated as loaner or rental Units. For most companies leaving the Customer selection in the Add Multiple selection box which is automatically set to the current work order Customer will ensure only Units owned by that Customer are presented for selection. +* Contracts are not automatically offered for selection when bulk adding multiple Units unlike a single Unit selection using the Unit pick list. If a Contract is desired when adding multiple Units it can be manually selected from the Contract pick list in the Work order header section. + +* Add multiple units not restricted to current work order Customer: unlike the normal single Unit selection feature which is restricted to the currently selected Customer's own Units only, the add multiple Units feature intentionally allows a User to select Units that do not belong to the currently selected Customer on the work order. This is to support some unusual requirements for certain companies who bulk service Units that are moved around between Customers regularly but are not treated as loaner or rental Units. For most companies leaving the Customer selection in the Add Multiple selection box which is automatically set to the current work order Customer will ensure only Units owned by that Customer are presented for selection. ## Misc features of note to document in own sections - * Add multiple units (how to select, note that can select by range with shift click for checkboxes etc) - * Duplicate workorder - * Erase entire section (goes with duplicate for cleaning unneeded items from source workorder) - * Part assembly - * Part request (how they are made and when) - * Double booking prevention feature in global settings and how it works when scheduling users - * "Age" - age is displayed in the workorders data tables as an optional column and is calculated at the moment it's displayed based on the date and time the work order was first created. - * "Time to completion" is displayed in the work order data tables as an optional column and is set whenever a work order is set to a "Completed" status by subtracting the date and time the work order was initially created from the current date and time when the Completed status is saved. If a work order has a time to completion set but is changed to a status that is not a Completed type then it's time to completion is reset to empty. If a work order has an empty time to completion set and is changed to a status that *is* a Completed type then it's time to completion is set. - * Work order item Expense and TotalCost field calcuations for LineTotalViz - a. ChargeTotal + TaxPaid = LineTotalViz (user fills in ChargeTotal, user fills in TaxPaid, AyaNova figures out LineTotalViz) - OR - b. ChargeTotal + TaxAViz + TaxBViz = LineTotalViz (user fills in ChargeTotal, user selected a TaxCode, AyaNova populates the TaxAViz and TaxBVix and figures out LineTotalViz - OR - c. ChargeTotal + TaxPaid = TotalCost ( ALL three fields manually entered by the user - AyaNova still figures out LineTotalViz correctly because of a. above) - NOTE: LineTotalViz IS NOT DERIVED from the TotalCost field in any way. +* Add multiple units (how to select, note that can select by range with shift click for checkboxes etc) +* Duplicate workorder +* Erase entire section (goes with duplicate for cleaning unneeded items from source workorder) +* Part assembly +* Part request (how they are made and when) +* Double booking prevention feature in global settings and how it works when scheduling users +* "Age" - age is displayed in the workorders data tables as an optional column and is calculated at the moment it's displayed based on the date and time the work order was first created. +* "Time to completion" is displayed in the work order data tables as an optional column and is set whenever a work order is set to a "Completed" status by subtracting the date and time the work order was initially created from the current date and time when the Completed status is saved. If a work order has a time to completion set but is changed to a status that is not a Completed type then it's time to completion is reset to empty. If a work order has an empty time to completion set and is changed to a status that *is* a Completed type then it's time to completion is set. +* Work order item Expense and TotalCost field calcuations for LineTotalViz + a. ChargeTotal + TaxPaid = LineTotalViz (user fills in ChargeTotal, user fills in TaxPaid, AyaNova figures out LineTotalViz) + OR + b. ChargeTotal + TaxAViz + TaxBViz = LineTotalViz (user fills in ChargeTotal, user selected a TaxCode, AyaNova populates the TaxAViz and TaxBVix and figures out LineTotalViz + OR + c. ChargeTotal + TaxPaid = TotalCost ( ALL three fields manually entered by the user - AyaNova still figures out LineTotalViz correctly because of a. above) + NOTE: LineTotalViz IS NOT DERIVED from the TotalCost field in any way. ## Work order Cost field visibility restrictions - *Work orders can show Costs for various items on them but these costs are only displayed for a select few users: - * Non staff user types (customer headoffice or subcontractor) can not see costs at all no matter what roles are set for them - * WorkOrderItemParts costs: to see these costs, the user must have one of the following roles: InventoryRestricted, Inventory, BizAdmin (full), Accounting - * WorkOrderItemLabor / WorkOrderItemTravel / WorkOrderItemLoan costs: user must have one of the following roles: ServiceRestricted, Service, BizAdmin (full), Accounting - * Reporting convenience fields: fields are included on work order header report data to indicate which costs are hidden: HasPartCosts, HasTravelAndLaborRateCosts, HasLoanItemCosts - * Costs to restricted users are not only hidden in work order user interface but are also sent as zeros in the data from the server - * Cost restrictions also apply to reporting so a report with cost fields on it will show those values as zero if the current user is restricted from seeing costs +* Work orders can show Costs for various items on them but these costs are only displayed for a select few users: + * Non staff user types (customer headoffice or subcontractor) can not see costs at all no matter what roles are set for them + * WorkOrderItemParts costs: to see these costs, the user must have one of the following roles: InventoryRestricted, Inventory, BizAdmin (full), Accounting + * WorkOrderItemLabor / WorkOrderItemTravel / WorkOrderItemLoan costs: user must have one of the following roles: ServiceRestricted, Service, BizAdmin (full), Accounting + * Reporting convenience fields: fields are included on work order header report data to indicate which costs are hidden: HasPartCosts, HasTravelAndLaborRateCosts, HasLoanItemCosts + * Costs to restricted users are not only hidden in work order user interface but are also sent as zeros in the data from the server + * Cost restrictions also apply to reporting so a report with cost fields on it will show those values as zero if the current user is restricted from seeing costs ## Sub contractors / Technician - Restricted users and Work Orders - If a User is set to User type of Sub contractor or if they are a Service type user and are assigned the "Technician - Restricted" role then special limitations apply to them: - * Service -> Work order list navigation pane area - * These restricted Users are not shown the option of viewing the full work order list. They will access their work orders via their Home -> Schedule form - * Work order main menu - * limited to Report, Save and Help options only - * Work order / work order items can not be created or deleted +If a User is set to User type of Sub contractor or if they are a Service type user and are assigned the "Technician - Restricted" role then special limitations apply to them: +* Service -> Work order list navigation pane area + * These restricted Users are not shown the option of viewing the full work order list. They will access their work orders via their Home -> Schedule form +* Work order main menu + * limited to Report, Save and Help options only +* Work order / work order items can not be created or deleted - * Work order *Item* restrictions - * These restricted Users will only be able to access the Work order Items for which they are Scheduled in the work order editing form. In other words if you do not want a Sub contractor or tech - restricted user to see parts of a Work order do not add them to the Scheduled users collection on those work order items - * Reporting convenience field: IsCompleteRecord field is included with the report header data to indicate if any items were removed due to restricted user - * No fields available in Work order item section other than to view but not edit the Sequence, Summary and Technotes fields +* Work order *Item* restrictions + * These restricted Users will only be able to access the Work order Items for which they are Scheduled in the work order editing form. In other words if you do not want a Sub contractor or tech - restricted user to see parts of a Work order do not add them to the Scheduled users collection on those work order items + * Reporting convenience field: IsCompleteRecord field is included with the report header data to indicate if any items were removed due to restricted user + * No fields available in Work order item section other than to view but not edit the Sequence, Summary and Technotes fields - * "Tech - Limited" User role specific restrictions - * All restrictions listed above in Work order *Item* restrictions plus: - * All work order header fields visible but not editable other than work order status which has a separately configurable role restriction setting (including attachments, wiki and tags) - * Form main menu items available: none except for Report which has a separately configurable role restriction setting - * Tasks: view and edit existing tasks, set completion type and date only, no add or remove or changing other fields - * Scheduled Users: view only where they are the selected User and convert to labor record - * Labors: add (no user selection defaults to themselves), remove, view and edit only when they are the selected User - * Travels: add (no user selection defaults to themselves), remove, view and edit only when they are the selected User - * Units: view only and limited to fields to identify unit - * Parts: view only and limited to fields to identify part - * Part requests: view only - * Expenses: add (no user selection defaults to themselves), view, partial fields available to edit or delete only where they are the selected user and only edit fields Summary, Cost, Tax paid, Description - * Loans: view only and limited fields to identify unit and dates - * Outside services: Not available +* "Tech - Limited" User role specific restrictions + * All restrictions listed above in Work order *Item* restrictions plus: + * All work order header fields visible but not editable other than work order status which has a separately configurable role restriction setting (including attachments, wiki and tags) + * Form main menu items available: none except for Report which has a separately configurable role restriction setting + * Tasks: view and edit existing tasks, set completion type and date only, no add or remove or changing other fields + * Scheduled Users: view only where they are the selected User and convert to labor record + * Labors: add (no user selection defaults to themselves), remove, view and edit only when they are the selected User + * Travels: add (no user selection defaults to themselves), remove, view and edit only when they are the selected User + * Units: view only and limited to fields to identify unit + * Parts: view only and limited to fields to identify part + * Part requests: view only + * Expenses: add (no user selection defaults to themselves), view, partial fields available to edit or delete only where they are the selected user and only edit fields Summary, Cost, Tax paid, Description + * Loans: view only and limited fields to identify unit and dates + * Outside services: Not available - * "Sub contractor" User type user role specific restrictions - * All restrictions listed above in Work order *Item* restrictions plus: - * No work order header fields visible except for Customer name, Customer contact name and service address - * Form main menu items available: none except for Report which has a separately configurable role restriction setting - * Tasks: view and edit existing tasks, set completion type and date only, no add or remove or changing other fields - * Scheduled Users: view only where they are the selected User and convert to labor record - * Labors: add (no user selection defaults to themselves), remove, view and edit only when they are the selected User - * Travels: add (no user selection defaults to themselves), remove, view and edit only when they are the selected User - * Units: view only and limited to fields to identify unit - * Parts: view only and limited to fields to identify part - * Part requests: view only - * Expenses: Not available - * Loans: view only and limited fields to identify unit and dates - * Outside services: Not available +* "Sub contractor" User type user role specific restrictions + * All restrictions listed above in Work order *Item* restrictions plus: + * No work order header fields visible except for Customer name, Customer contact name and service address + * Form main menu items available: none except for Report which has a separately configurable role restriction setting + * Tasks: view and edit existing tasks, set completion type and date only, no add or remove or changing other fields + * Scheduled Users: view only where they are the selected User and convert to labor record + * Labors: add (no user selection defaults to themselves), remove, view and edit only when they are the selected User + * Travels: add (no user selection defaults to themselves), remove, view and edit only when they are the selected User + * Units: view only and limited to fields to identify unit + * Parts: view only and limited to fields to identify part + * Part requests: view only + * Expenses: Not available + * Loans: view only and limited fields to identify unit and dates + * Outside services: Not available - * "Sub contractor - restricted" User type specific restrictions - * All restrictions listed above in Work order *Item* restrictions plus: - * No work order header fields visible except for Customer name and Customer contact name - * Form main menu items available: none except for Report which has a separately configurable role restriction setting - * Tasks: view and edit existing tasks, set completion type and date only, no add or remove or changing other fields - * Scheduled Users: view only where they are the selected User and convert to labor record - * Labors: add (no user selection defaults to themselves), remove, view and edit only when they are the selected User - * Travels: add (no user selection defaults to themselves), remove, view and edit only when they are the selected User - * Units: Not available - * Parts: Not available - * Part requests: Not available - * Expenses: Not available - * Loans: Not available - * Outside services: Not available - +* "Sub contractor - restricted" User type specific restrictions + * All restrictions listed above in Work order *Item* restrictions plus: + * No work order header fields visible except for Customer name and Customer contact name + * Form main menu items available: none except for Report which has a separately configurable role restriction setting + * Tasks: view and edit existing tasks, set completion type and date only, no add or remove or changing other fields + * Scheduled Users: view only where they are the selected User and convert to labor record + * Labors: add (no user selection defaults to themselves), remove, view and edit only when they are the selected User + * Travels: add (no user selection defaults to themselves), remove, view and edit only when they are the selected User + * Units: Not available + * Parts: Not available + * Part requests: Not available + * Expenses: Not available + * Loans: Not available + * Outside services: Not available + ### Restricted work order User report fields As some Work order data is not shown or available to restricted Users, several flag fields are provided in the work order header which are available to use in Report templates as required: - * IsCompleteRecord - false if some Work order Item records were removed as not available to current restricted user - * UserIsRestrictedType - * UserIsTechRestricted - * UserIsSubContractorFull - * UserIsSubContractorRestricted - * UserCanViewPartCosts - * UserCanViewLaborOrTravelRateCosts - * UserCanViewLoanerCosts - + +* IsCompleteRecord - false if some Work order Item records were removed as not available to current restricted user +* UserIsRestrictedType +* UserIsTechRestricted +* UserIsSubContractorFull +* UserIsSubContractorRestricted +* UserCanViewPartCosts +* UserCanViewLaborOrTravelRateCosts +* UserCanViewLoanerCosts + ### Manual Price Overrides