diff --git a/devdocs/todo.txt b/devdocs/todo.txt index a96de9c4..d2fc5952 100644 --- a/devdocs/todo.txt +++ b/devdocs/todo.txt @@ -7,6 +7,7 @@ Docs completion less than 30 so that's good! :) + start in on QBI minimum viable product, just something that works How to make it work in desktop / winlan / linuxlan / online all together?? diff --git a/docs/8.0/ayanova/docs/acc-service-rates.md b/docs/8.0/ayanova/docs/acc-service-rates.md index 243cf317..68d707d7 100644 --- a/docs/8.0/ayanova/docs/acc-service-rates.md +++ b/docs/8.0/ayanova/docs/acc-service-rates.md @@ -19,6 +19,10 @@ Read only access - Service technician - Sales +## Import / Export + +Service rates can be [imported](adm-import-service-rate.md) into AyaNova and [exported](ay-ex-export.md) out of AyaNova. + ## How to access Service rates Service rates are accessed in the following ways: diff --git a/docs/8.0/ayanova/docs/acc-travel-rates.md b/docs/8.0/ayanova/docs/acc-travel-rates.md index cbf6dbeb..f8b12c11 100644 --- a/docs/8.0/ayanova/docs/acc-travel-rates.md +++ b/docs/8.0/ayanova/docs/acc-travel-rates.md @@ -21,6 +21,10 @@ Read only access - Travel technician - Sales +## Import / Export + +Travel rates can be [imported](adm-import-travel-rate.md) into AyaNova and [exported](ay-ex-export.md) out of AyaNova. + ## How to access travel rates Travel rates are accessed in the following ways: diff --git a/docs/8.0/ayanova/docs/ay-ex-export.md b/docs/8.0/ayanova/docs/ay-ex-export.md index 285bf4fe..bfb51834 100644 --- a/docs/8.0/ayanova/docs/ay-ex-export.md +++ b/docs/8.0/ayanova/docs/ay-ex-export.md @@ -1,6 +1,6 @@ # Export extension -The Export extension can be used to export selected records from AyaNova. +The Export [extension](ay-extensions.md) can be used to export selected records from AyaNova. ## Authorization Roles required @@ -14,6 +14,8 @@ The Export extension is accessed from the [extensions](ay-extensions.md) menu it Data is exported exactly as it's stored at the sever in JSON format, there are no locale conversions made. +You can [select individual records](ay-start-form-data-tables.md#selecting-records) for export or make no selections to export all records. + ### Time zone is in UTC Dates and times are exported exactly as they are stored in the database as UTC / GMT time zone values. diff --git a/docs/8.0/ayanova/docs/customers.md b/docs/8.0/ayanova/docs/customers.md index 64926713..818c9fe4 100644 --- a/docs/8.0/ayanova/docs/customers.md +++ b/docs/8.0/ayanova/docs/customers.md @@ -20,6 +20,10 @@ Read only access - Service technician - Sales - restricted +## Import / Export + +Customers can be [imported](adm-import-customer.md) into AyaNova and [exported](ay-ex-export.md) out of AyaNova. + ## How to access customers Customers are accessed in the following ways: @@ -99,7 +103,8 @@ See the [Contract documentation](svc-contracts.md) for further details. #### Active -Customers that are set to Active can be selected on new Work orders and other objects that use customers. +Customers that are set to Active can be selected on new Work orders and other objects that use customers. + Customers not set to Active will still show in older records but can not be selected for new records; this is how you retire a customer from use. #### General notes @@ -127,7 +132,7 @@ If the form has been [customized](ay-customize.md) and [custom fields](ay-custom #### Tags -Optional [tags control](ay-start-form-tags.md) for categorizing and notification [filtering](home-notify-subscriptions.md#tags). +Optional [tags control](ay-start-form-tags.md) for categorizing, searching, selecting and notification [filtering](home-notify-subscriptions.md#tags). #### Wiki @@ -153,7 +158,7 @@ In addition to the [common edit form menu options](ay-start-edit-forms.md#common #### Customer notes -Opens up the [customer notes](customer-notes.md) form for recording notes about the customer in a dated log format when the general Notes field is not enough. +Opens up the [customer notes](customer-notes.md) form for recording notes about the customer in a dated log format when the general Notes field is not enough. This can be used for any purpose but is often used for recording notes about interactions with the Customer for future reference purposes. diff --git a/docs/8.0/ayanova/docs/head-offices.md b/docs/8.0/ayanova/docs/head-offices.md index 0eb104c6..f30ec7bb 100644 --- a/docs/8.0/ayanova/docs/head-offices.md +++ b/docs/8.0/ayanova/docs/head-offices.md @@ -26,6 +26,10 @@ Read only access - Service technician - Sales - restricted +## Import / Export + +Head offices can be [imported](adm-import-headoffice.md) into AyaNova and [exported](ay-ex-export.md) out of AyaNova. + ## How to access head offices Head offices are accessed in the following ways: diff --git a/docs/8.0/ayanova/docs/inv-part-assemblies.md b/docs/8.0/ayanova/docs/inv-part-assemblies.md index e112d486..7a3b7cf0 100644 --- a/docs/8.0/ayanova/docs/inv-part-assemblies.md +++ b/docs/8.0/ayanova/docs/inv-part-assemblies.md @@ -19,6 +19,10 @@ Read only access - Service manager - Service manager - restricted +## Import / Export + +Part assemblies can be [imported](adm-import-part-assembly.md) into AyaNova and [exported](ay-ex-export.md) out of AyaNova. + ## How to access Part assemblies Part assemblies are accessed in the following ways: diff --git a/docs/8.0/ayanova/docs/inv-part-inventory-transactions.md b/docs/8.0/ayanova/docs/inv-part-inventory-transactions.md index 328683cc..5c785f55 100644 --- a/docs/8.0/ayanova/docs/inv-part-inventory-transactions.md +++ b/docs/8.0/ayanova/docs/inv-part-inventory-transactions.md @@ -19,6 +19,10 @@ Read only access - Service manager - Service manager - restricted +## Import / Export + +Inventory can be [imported](adm-import-inventory.md) into AyaNova and [exported](ay-ex-export.md) out of AyaNova. + ## How to access inventory transactions Inventory transactions are accessed in the following ways: diff --git a/docs/8.0/ayanova/docs/inv-part-inventory.md b/docs/8.0/ayanova/docs/inv-part-inventory.md index d6cb45f0..deba2d2e 100644 --- a/docs/8.0/ayanova/docs/inv-part-inventory.md +++ b/docs/8.0/ayanova/docs/inv-part-inventory.md @@ -21,6 +21,10 @@ Read only access - Service manager - Service manager - restricted +## Import / Export + +Inventory can be [imported](adm-import-inventory.md) into AyaNova and [exported](ay-ex-export.md) out of AyaNova. + ## How to access inventory Inventory transactions are accessed in the following ways: @@ -91,27 +95,27 @@ Clicking on this field will show the history of the transaction represented by t #### Part description -The value entered into the [Part's](inv-parts.md) `Description` field. +The value entered into the Part's [Description](inv-parts.md#part-description) field. #### Cost -The value entered into the [Part's](inv-parts.md) `Cost` field. +The value entered into the Part's [Cost](inv-parts.md#cost) field. #### Retail -The value entered into the [Part's](inv-parts.md) `Retail` field. +The value entered into the Part's [Retail](inv-parts.md#retail) field. #### Wholesaler -The [Vendor](vendors.md) selected on the [Part's](inv-parts.md) `Wholesaler` field. +The [Vendor](vendors.md) selected on the Part's [Wholesaler](inv-parts.md#wholesaler) field. #### Alternative Wholesaler -The [Vendor](vendors.md) selected on the [Part's](inv-parts.md) `Alternative wholesaler` field. +The [Vendor](vendors.md) selected on the Part's [Alternative wholesaler](inv-parts.md#alternative-wholesaler) field. #### Tags -The Tags selected for this [Part](inv-parts.md). +The Tags selected on this Part's [Tags](inv-parts.md#tags). ## Part inventory adjustment edit form diff --git a/docs/8.0/ayanova/docs/inv-part-requests.md b/docs/8.0/ayanova/docs/inv-part-requests.md index d58f025e..6fca409b 100644 --- a/docs/8.0/ayanova/docs/inv-part-requests.md +++ b/docs/8.0/ayanova/docs/inv-part-requests.md @@ -79,7 +79,7 @@ The Purchase order's [received date](inv-purchase-orders.md#received-date) when #### Part description -The value entered into the [Part's](inv-parts.md) `Description` field. +The value entered into the Part's [Description](inv-parts.md#part-description) field. #### Warehouse @@ -87,23 +87,23 @@ The [Part warehouse](inv-part-warehouses.md) selected on the [Work order item pa #### UPC -The value entered into the [Part's](inv-parts.md) `UPC` field. +The value entered into the Part's [UPC](inv-parts.md#upc) field. #### Ordered from -The value entered into the [Purchase order's](inv-purchase-orders.md#vendor) `Vendor` field. +The value entered into the Purchase order's [Vendor](inv-purchase-orders.md#vendor) field. #### Wholesaler -The [Vendor](vendors.md) selected on the [Part's](inv-parts.md) `Wholesaler` field. +The [Vendor](vendors.md) selected on the Part's [Wholesaler](inv-parts.md#wholesaler) field. #### Alternative Wholesaler -The [Vendor](vendors.md) selected on the [Part's](inv-parts.md) `Alternative wholesaler` field. +The [Vendor](vendors.md) selected on the Part's [Alternative wholesaler](inv-parts.md#alternative-wholesaler) field. #### Manufacturer -The [Vendor](vendors.md) selected on the [Part's](inv-parts.md) `Manufacturer` field. +The [Vendor](vendors.md) selected on the Part's [Manufacturer](inv-parts.md#manufacturer) field. #### Work order status diff --git a/docs/8.0/ayanova/docs/inv-part-warehouses.md b/docs/8.0/ayanova/docs/inv-part-warehouses.md index a1f58722..d9059bd8 100644 --- a/docs/8.0/ayanova/docs/inv-part-warehouses.md +++ b/docs/8.0/ayanova/docs/inv-part-warehouses.md @@ -1,3 +1,9 @@ # INV-PART-WAREHOUSES + + +## Import / Export + +Warehouses can be [imported](adm-import-warehouse.md) into AyaNova and [exported](ay-ex-export.md) out of AyaNova. + ![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 80a2a178..c000c5c3 100644 --- a/docs/8.0/ayanova/docs/inv-parts.md +++ b/docs/8.0/ayanova/docs/inv-parts.md @@ -1,7 +1,165 @@ -# INV-PARTS +# Parts -![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) +Parts in AyaNova are items worth tracking that are used while providing service. They may be replacement parts used to fix a unit or consumable items required to make the repair (such as a lubricant or special cleaning solution). +Generally anything that needs to be tracked, billed back to the Customer or noted for the historical record of service. + +Parts are selected on [Work orders](svc-workorders.md), [Quotes](svc-quotes.md), [Preventive maintenance order](svc-pms.md) and the Inventory system primarily on [Purchase orders](inv-purchase-orders.md) and other [Inventory](inv-part-inventory.md) related tasks. + +In AyaNova you can fully track inventory and have all your parts available for quick selection from lists or turn off inventory completely and enter parts as text on work orders as required without any inventory tracking by adjusting the ["Use inventory"](adm-global-settings.md#use-inventory) global business setting. + +## Authorization Roles required + +This form is available to User's with the following [roles](ay-biz-admin-roles.md): + +Full access + +- Accounting +- Business administration +- Inventory + +Read only access + +- Business administration - restricted +- Inventory - restricted +- Service manager +- Service manager - restricted + +## Import / Export + +Parts can be [imported](adm-import-part.md) into AyaNova, [exported](ay-ex-export.md) out of AyaNova and part inventory can also be updated via [imported inventory transactions](adm-import-inventory.md). + +## How to access Parts + +Parts are accessed in the following ways: + +- From the `Inventory` navigation pane `Parts` item to open the Inventory [data table](ay-start-form-data-tables.md) +- By clicking on the [open record icon](ay-start-form-autocomplete.md#opening-selected-record) in any Parts autocomplete list on any other form where parts can be selected such as the Work order, Quote and Preventive Maintenance forms +- From any [data table](ay-start-form-data-tables.md) column showing parts such as the [Inventory transactions table](inv-part-inventory-transactions.md) + +## Parts data table + +The Parts [data table](ay-start-form-data-tables.md) lists all the Parts available, provides the '+' link to create a new Part and provides access to common [data table menu options](ay-start-form-data-tables.md#common-menu-options). + +## Part edit form + +The Part edit form provides all the [standard edit form](ay-start-edit-forms.md) functionality and the following fields: + +The Name field is the only required field on this form, all other fields are optional. + +#### Name + +This is the name of the part as it's displayed in forms and reports. This is also the primary identifier when searching for a part to select in [autocomplete](ay-start-form-autocomplete.md) lists. A part name must be unique from all other parts entered. + +Keep in mind that this is also the Name that Customers will see on reports if provided to them. + +This is the only **required** field on the Part form. All other fields are optional and can be [hidden](ay-customize.md) if not required. + +#### Part description + +This is an optional additional field provided to enter more descriptive information about the Part if desired. It is available to be included in the [autocomplete](ay-start-form-autocomplete.md) template for searching and selection. + +We recommend not using this field unless necessary for a specific reason. + +#### Cost + +Cost is used in several areas of AyaNova including management reporting / metrics, [purchase orders](inv-purchase-orders.md) and [Contract override price adjustments](svc-contracts.md#default-price-adjustments). + +#### Retail + +This is the price charged for this Part. This value will be displayed on work orders and on work order reports seen by Customers and is the default charge amount for this Part unless a [Contract price override](svc-contracts.md#default-price-adjustments) is in effect. + +Prices of parts are ["snapshotted"](svc-workorders.md#parts) on work orders meaning you can change the price here without affecting existing work orders. + +Price is used in several areas of AyaNova including [work orders](svc-workorders.md#parts), Quotes and PM's, management reporting / metrics, [purchase orders](inv-purchase-orders.md) and [Contract override price adjustments](svc-contracts.md#default-price-adjustments). + +#### Unit of measure + +This is the Unit that this Part is consumed in, for example "Each", "Gram", "Box", "Barrel", "Inch" etc. This helps staff understand how a Part's quantity should be entered on work orders when consumed and also is displayed to Customers on work order reports. + +You can select from an existing unit of measure here or enter a completely new one. When you enter a new one it goes into the list for future selections so you don't need to type it out again in future. + +#### UPC + +The Universal product code for this item. Helpful when working with scanning devices and bar codes in conjunction with [autocomplete list selection templates](ay-start-form-autocomplete.md). + +#### Manufacturer + +Select from any existing Vendor to be the manufacturer of this part. Used in selection lists, reporting, purchase orders, warranty information etc. + +#### Manufacturer Number + +This Part's unique identification code / part number as provided by the Manufacturer. + +#### Wholesaler + +Select from any existing Vendor to be this Part's primary Wholesaler. Used for Purchase orders, reporting and warranty purposes. + +#### Wholesaler Number + +This Part's unique identification code / part number as provided by the primary Wholesaler. + +#### Alternative Wholesaler + +Select from any existing Vendor to be this Part's alternative Wholesaler. Used for Purchase orders, reporting and warranty purposes. + +#### Alternative Wholesaler Number + +This Part's unique identification code / part number as provided by the alternative Wholesaler. + +#### Active + +Parts that are set to Active can be selected on new Work orders and other objects that use parts. + +Parts not set to Active will still show in older records but can not be selected for new records; this is how you retire a Part from use. + +#### Notes + +Notes about this record for internal staff use. Notes can also be reported on if desired. + +These notes are only visible in this form. + +#### Tags + +Optional [tags control](ay-start-form-tags.md) for categorizing, searching, selecting and notification [filtering](home-notify-subscriptions.md#tags). + +#### Wiki + +Optional [wiki control](ay-start-form-wiki.md). + +#### Attached files + +Optional [attachments control](ay-start-form-attachments.md). + +### Menu options + +In addition to the [common edit form menu options](ay-start-edit-forms.md#common-edit-form-menu-options) the Customer edit form also has these options: + +#### Part inventory + +Used to view the inventory for this part by opening the [Part inventory](inv-part-inventory.md) data table filtered to show only _this_ Part's records. + +#### Inventory transactions + +View all inventory transactions involving this part by opening the [Part inventory transactions](inv-part-inventory-transactions.md) data table filtered to show only _this_ Part's records. + +#### Part stocking levels + +Opens the [Part stocking levels](inv-part-stock-levels.md) form for _this_ part to set minimum on-hand quantities to be used in conjunction with the [Purchase order](inv-purchase-orders.md) feature to ensure important Parts are always in stock. + +#### Available serial numbers + +Opens the [Serial numbers](inv-part-serials.md) form for _this_ part to edit the available serial numbers for selection on [work orders](svc-workorders.md#parts) and [purchase orders](inv-purchase-orders.md). + +#### Work orders + +Used to view work orders where this part has been used by opening the work order item parts data table filtered to _this_ part only. + +#### Quotes + +Used to view [Quotes](svc-quotes.md) where this part has been used by opening the Quote item parts data table filtered to _this_ part only. + +#### Work orders + +Used to view [Preventive maintenance orders](svc-pms.md) where this part has been used by opening the Preventive maintenance item parts data table filtered to _this_ part only. -000000000000000000000000000000000000000000000000000 -NOTE: once this page is filled in go back to inv-part-inventory and make direct links to the fields, also inv-part-requests I think has a few \ No newline at end of file diff --git a/docs/8.0/ayanova/docs/inv-purchase-orders.md b/docs/8.0/ayanova/docs/inv-purchase-orders.md index f93324cb..b96e8d80 100644 --- a/docs/8.0/ayanova/docs/inv-purchase-orders.md +++ b/docs/8.0/ayanova/docs/inv-purchase-orders.md @@ -97,7 +97,7 @@ Optional notes area for any purpose that makes sense to your business. Often thi #### Tags -Optional [tags control](ay-start-form-tags.md) for categorizing and notification [filtering](home-notify-subscriptions.md#tags). +Optional [tags control](ay-start-form-tags.md) for categorizing, searching, selecting and notification [filtering](home-notify-subscriptions.md#tags). #### Wiki diff --git a/docs/8.0/ayanova/docs/svc-contracts.md b/docs/8.0/ayanova/docs/svc-contracts.md index 5df27a80..98cac475 100644 --- a/docs/8.0/ayanova/docs/svc-contracts.md +++ b/docs/8.0/ayanova/docs/svc-contracts.md @@ -229,7 +229,7 @@ If the form has been [customized](ay-customize.md) and [custom fields](ay-custom #### Tags -Optional [tags control](ay-start-form-tags.md) for categorizing and notification [filtering](home-notify-subscriptions.md#tags). +Optional [tags control](ay-start-form-tags.md) for categorizing, searching, selecting and notification [filtering](home-notify-subscriptions.md#tags). #### Wiki diff --git a/docs/8.0/ayanova/docs/svc-projects.md b/docs/8.0/ayanova/docs/svc-projects.md index 32746de6..7d9e86e9 100644 --- a/docs/8.0/ayanova/docs/svc-projects.md +++ b/docs/8.0/ayanova/docs/svc-projects.md @@ -1,3 +1,7 @@ # SVC-PROJECTS +## Import / Export + +Projects can be [imported](adm-import-project.md) into AyaNova and [exported](ay-ex-export.md) out of AyaNova. + ![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 28d98e62..cc95659c 100644 --- a/docs/8.0/ayanova/docs/svc-unit-models.md +++ b/docs/8.0/ayanova/docs/svc-unit-models.md @@ -1,3 +1,7 @@ # SVC-UNIT-MODELS +## Import / Export + +Unit models can be [imported](adm-import-unit-model.md) into AyaNova and [exported](ay-ex-export.md) out of AyaNova. + ![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 4f483b5c..21a61786 100644 --- a/docs/8.0/ayanova/docs/svc-units.md +++ b/docs/8.0/ayanova/docs/svc-units.md @@ -1,5 +1,10 @@ # SVC-UNITS + +## Import / Export + +Units can be [imported](adm-import-unit.md) into AyaNova and [exported](ay-ex-export.md) out of AyaNova. + ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) diff --git a/docs/8.0/ayanova/docs/svc-workorders.md b/docs/8.0/ayanova/docs/svc-workorders.md index 0e05d656..638b4053 100644 --- a/docs/8.0/ayanova/docs/svc-workorders.md +++ b/docs/8.0/ayanova/docs/svc-workorders.md @@ -311,7 +311,7 @@ If the form has been [customized](ay-customize.md) and [custom fields](ay-custom #### Tags -Optional [tags control](ay-start-form-tags.md) for categorizing and notification [filtering](home-notify-subscriptions.md#tags). +Optional [tags control](ay-start-form-tags.md) for categorizing, searching, selecting and notification [filtering](home-notify-subscriptions.md#tags). #### Wiki @@ -731,6 +731,8 @@ A work order item can have zero to many separate Work order item part records as All Work order item part edit form fields here are **optional** unless specified as required. +Unlike items like taxes and service / travel rates which cannot be changed once they have been used on a work order, Parts are an exception as the pricing is considered more volatile so part prices are "snapshotted" on being added to a work order and stored with the work order itself. + #### Part This field is **required** to be selected. Here you select the Part that is consumed during service. diff --git a/docs/8.0/ayanova/docs/vendors.md b/docs/8.0/ayanova/docs/vendors.md index 79c95468..b0aff640 100644 --- a/docs/8.0/ayanova/docs/vendors.md +++ b/docs/8.0/ayanova/docs/vendors.md @@ -1,3 +1,7 @@ # VENDORS +## Import / Export + +Vendors can be [imported](adm-import-vendor.md) into AyaNova and [exported](ay-ex-export.md) out of AyaNova. + ![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg)