From 3b405e6a95fe713fd53068e6cda27e9a06beda69 Mon Sep 17 00:00:00 2001 From: John Cardinal Date: Fri, 21 Jan 2022 01:01:58 +0000 Subject: [PATCH] --- .../ayanova/docs/ay-biz-admin-migrate-v7.md | 2 +- docs/8.0/ayanova/docs/ay-biz-admin-roles.md | 6 +- .../ayanova/docs/ay-start-common-controls.md | 18 ++-- docs/8.0/ayanova/docs/ay-start-edit-forms.md | 2 +- .../ayanova/docs/ay-start-form-attachments.md | 2 +- docs/8.0/ayanova/docs/ay-start-form-tags.md | 2 +- docs/8.0/ayanova/docs/ay-start-login.md | 2 +- docs/8.0/ayanova/docs/cust-contacts.md | 84 +++++++++++++++++++ docs/8.0/ayanova/docs/ops-log.md | 11 ++- 9 files changed, 106 insertions(+), 23 deletions(-) diff --git a/docs/8.0/ayanova/docs/ay-biz-admin-migrate-v7.md b/docs/8.0/ayanova/docs/ay-biz-admin-migrate-v7.md index a880cd75..690bb889 100644 --- a/docs/8.0/ayanova/docs/ay-biz-admin-migrate-v7.md +++ b/docs/8.0/ayanova/docs/ay-biz-admin-migrate-v7.md @@ -222,7 +222,7 @@ If you have any customized report templates they will need to be re-created or r The V8Migrate utility is not able to access settings in the optional add-on's RI and WBI and so is not able to automatically migrate their settings to AyaNova 8. Instead it will automatically choose safe defaults for those settings and lock out Customer access. -In v7 you would make those settings within the interface provided by those optional add-on's, in AyaNova 8 all those settings can be found in the Global Settings form in the [Customer Access section](adm-global-settings.md/#customer-access-settings) and will need to be set manually. +In v7 you would make those settings within the interface provided by those optional add-on's, in AyaNova 8 all those settings can be found in the Global Settings form in the [Customer Access section](adm-global-settings.md#customer-access-settings) and will need to be set manually. ### Enable Backup diff --git a/docs/8.0/ayanova/docs/ay-biz-admin-roles.md b/docs/8.0/ayanova/docs/ay-biz-admin-roles.md index cd4d8a62..093ce5b6 100644 --- a/docs/8.0/ayanova/docs/ay-biz-admin-roles.md +++ b/docs/8.0/ayanova/docs/ay-biz-admin-roles.md @@ -46,7 +46,7 @@ This is an appropriate role for a User responsible for setting up critical setti This role is intended to allow access to your customers and the Customer self service support features in AyaNova such as receiving in-app notifications, requesting service etc. If a Customer type user account is not granted the Customer role they will only have access to notification features. -Customers with the Customer role are potentially able to use the Customer features of AyaNova but do not _automatically_ have access to all customer features in AyaNova, those rights are finer grained and controlled in detail via the [Global settings form customer access section](adm-global-settings.md/#customer-access-settings). +Customers with the Customer role are potentially able to use the Customer features of AyaNova but do not _automatically_ have access to all customer features in AyaNova, those rights are finer grained and controlled in detail via the [Global settings form customer access section](adm-global-settings.md#customer-access-settings). `Customer - restricted` role is the read-only version of the full Customer role and intended for viewing Customer centric features but not making changes like creating a new [Customer service request](svc-csr.md) for example. @@ -88,7 +88,7 @@ They are also permitted to view read-only `Vendors` and `Accounting` navigation They can not view any prices or costs or see any other details of a work order where they are not involved. -See the [Low permission users](svc-workorders.md/#low-permission-users) section of the work order documentation for details. +See the [Low permission users](svc-workorders.md#low-permission-users) section of the work order documentation for details. Aside from their `Home` navigation pane items, there are no other areas of AyaNova available to restricted technicians. @@ -100,7 +100,7 @@ This role allows a User to perform service with the lowest possible access to an They can not view any prices or costs or see any other details of a work order where they are not involved. -See the [Low permission users](svc-workorders.md/#low-permission-users) section of the work order documentation for details. +See the [Low permission users](svc-workorders.md#low-permission-users) section of the work order documentation for details. `Subcontractor - restricted` read-only rights to the above Subcontractor role items. 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 87039d0c..6843dbd6 100644 --- a/docs/8.0/ayanova/docs/ay-start-common-controls.md +++ b/docs/8.0/ayanova/docs/ay-start-common-controls.md @@ -60,7 +60,7 @@ Clicking on the "Private bytes" legend hides that plot line and adjusts the scal The currency control displays and accepts currency input. -The display and input format are controlled by both the device and web browser default settings for decimal numbers and the desired currency code set in the [User settings](home-user-settings.md/#currency-code) currency code field. +The display and input format are controlled by both the device and web browser default settings for decimal numbers and the desired currency code set in the [User settings](home-user-settings.md#currency-code) currency code field. ### Custom fields @@ -68,7 +68,7 @@ Custom fields are customizable extra fields that can be enabled on each business These are provided for situations where there are special data items unique to each business that do not "fit" any of the standard AyaNova form fields. -Custom fields are documented on the [form customization](ay-customize.md/#custom-fields) help page. +Custom fields are documented on the [form customization](ay-customize.md#custom-fields) help page. ### Dashboard widgets @@ -80,11 +80,11 @@ Data tables are used throughout AyaNova to display lists of business objects and ### Date -The Date control is used to display and choose dates without time. Dates are displayed in the devices local time zone by default but can be [overriden](ay-start-localization.md/#time-zone-override). +The Date control is used to display and choose dates without time. Dates are displayed in the devices local time zone by default but can be [overriden](ay-start-localization.md#time-zone-override). AyaNova has two versions of the Date control available: the default is a "Material" theme date picker that will display and work the same on any device and the alternative is to use your browsers default system date picker. -Which one is used is controlled in [User settings](home-user-settings.md/#user-browsers-standard-date-time-input-controls) "User browser standard date time input" setting. +Which one is used is controlled in [User settings](home-user-settings.md#user-browsers-standard-date-time-input-controls) "User browser standard date time input" setting. #### Default "Material" date picker: @@ -118,11 +118,11 @@ Picker mode: ### Date and Time -The Date and time control is used to display and choose dates and times as a pair and is the most common date and time related control in AyaNova as most objects require a precise timestamp. Dates and times are displayed in the devices local time zone by default but can be [overriden](ay-start-localization.md/#time-zone-override). +The Date and time control is used to display and choose dates and times as a pair and is the most common date and time related control in AyaNova as most objects require a precise timestamp. Dates and times are displayed in the devices local time zone by default but can be [overriden](ay-start-localization.md#time-zone-override). AyaNova has two versions of the Date and Time control available: the default is a "Material" theme date and time picker that will display and work the same on any device and the alternative is to use your browsers default system date and time pickers. -Which one is used is controlled in [User settings](home-user-settings.md/#user-browsers-standard-date-time-input-controls) "User browser standard date time input" setting. +Which one is used is controlled in [User settings](home-user-settings.md#user-browsers-standard-date-time-input-controls) "User browser standard date time input" setting. #### Default "Material" date and time picker: @@ -279,15 +279,15 @@ Tag control has it's own [Tag documentation page](ay-start-form-tags.md). ### Time -The Time control is used to display and choose a time of day without the date portion. Times are displayed in the devices local time zone by default but can be [overriden](ay-start-localization.md/#time-zone-override). +The Time control is used to display and choose a time of day without the date portion. Times are displayed in the devices local time zone by default but can be [overriden](ay-start-localization.md#time-zone-override). #### AM / PM vs 24 hour clock -AyaNova will accept input and display times in 12 hour clock AM/PM mode or 24 hour clock mode depending upon the local standard set by the operating system and browser. You can override this to force a particular choice in [User settings](home-user-settings.md/#12-hour-clock) "12 hour clock" setting. +AyaNova will accept input and display times in 12 hour clock AM/PM mode or 24 hour clock mode depending upon the local standard set by the operating system and browser. You can override this to force a particular choice in [User settings](home-user-settings.md#12-hour-clock) "12 hour clock" setting. AyaNova has two versions of the Time control available: the default is a "Material" theme time picker that will display and work the same on any device and the alternative is to use your browsers default time picker. -Which one used is controlled in [User settings](home-user-settings.md/#user-browsers-standard-date-time-input-controls) "User browser standard date time input" setting. +Which one used is controlled in [User settings](home-user-settings.md#user-browsers-standard-date-time-input-controls) "User browser standard date time input" setting. #### Default "Material" time picker: diff --git a/docs/8.0/ayanova/docs/ay-start-edit-forms.md b/docs/8.0/ayanova/docs/ay-start-edit-forms.md index e3a0679d..09d458dc 100644 --- a/docs/8.0/ayanova/docs/ay-start-edit-forms.md +++ b/docs/8.0/ayanova/docs/ay-start-edit-forms.md @@ -58,7 +58,7 @@ The above image shows all types of alerts you may see on an edit form. ##### Errors -Validation and server errors will appear as a red alert box with a triangular /!\ exclamation mark icon. A validation error usually indicates there is something on the form that needs to be addressed, in this example the Summary field was left empty but is flagged as a required entry field in the [form customization settings](ay-customize.md/#requiring-fields). +Validation and server errors will appear as a red alert box with a triangular /!\ exclamation mark icon. A validation error usually indicates there is something on the form that needs to be addressed, in this example the Summary field was left empty but is flagged as a required entry field in the [form customization settings](ay-customize.md#requiring-fields). ##### Alert notes diff --git a/docs/8.0/ayanova/docs/ay-start-form-attachments.md b/docs/8.0/ayanova/docs/ay-start-form-attachments.md index aa3afed0..8734175b 100644 --- a/docs/8.0/ayanova/docs/ay-start-form-attachments.md +++ b/docs/8.0/ayanova/docs/ay-start-form-attachments.md @@ -2,7 +2,7 @@ The attachments feature of AyaNova allows users to store and retreive files linked to specific AyaNova business objects from their [edit form](ay-start-edit-forms.md) -This feature can be [turned off](ay-customize.md/#hiding-showing-fields) in each form so if you do not see an attachments control it may be disabled by the AyaNova administrator. +This feature can be [turned off](ay-customize.md#hiding-showing-fields) in each form so if you do not see an attachments control it may be disabled by the AyaNova administrator. ## Authorization Roles required diff --git a/docs/8.0/ayanova/docs/ay-start-form-tags.md b/docs/8.0/ayanova/docs/ay-start-form-tags.md index 3700f9bc..bd08a5a8 100644 --- a/docs/8.0/ayanova/docs/ay-start-form-tags.md +++ b/docs/8.0/ayanova/docs/ay-start-form-tags.md @@ -8,7 +8,7 @@ Business objects can have more than one tag and completely different object type Tags are used for any purpose that makes sense for _your_ business. AyaNova does not limit how tags are used and allows nearly everything to be tagged. -Some features in AyaNova work automatically with selected tags as a way to control automatic processes such as [Notifications](home-notify-subscriptions.md) or refining restrictions to [Customer access features](adm-global-settings.md/#common-settings-for-customer-access-features) to only Customers with certain tags plus many more features that are Tag aware. +Some features in AyaNova work automatically with selected tags as a way to control automatic processes such as [Notifications](home-notify-subscriptions.md) or refining restrictions to [Customer access features](adm-global-settings.md#common-settings-for-customer-access-features) to only Customers with certain tags plus many more features that are Tag aware. By tagging related objects you can more easily select them as a whole for things like searches in [autocomplete list controls](ay-start-form-autocomplete.md), reporting, business metrics, graphs and charts, process control etc. diff --git a/docs/8.0/ayanova/docs/ay-start-login.md b/docs/8.0/ayanova/docs/ay-start-login.md index 21168d4f..012ce730 100644 --- a/docs/8.0/ayanova/docs/ay-start-login.md +++ b/docs/8.0/ayanova/docs/ay-start-login.md @@ -22,7 +22,7 @@ If you append the login url on your browser with `?reset` all local cached data ## Logo -The logo displayed on the login page [can be customized](adm-global-settings.md/#business-logos). +The logo displayed on the login page [can be customized](adm-global-settings.md#business-logos). ## Could not connect to AyaNova server error diff --git a/docs/8.0/ayanova/docs/cust-contacts.md b/docs/8.0/ayanova/docs/cust-contacts.md index 1c3bea3e..913d81de 100644 --- a/docs/8.0/ayanova/docs/cust-contacts.md +++ b/docs/8.0/ayanova/docs/cust-contacts.md @@ -1,3 +1,87 @@ +# Customer contacts + +The Customer contacts [form](ay-start-form-overview.md) is used to create and edit Customer contacts in AyaNova. + +Customer contacts are used for two purposes + +- for reference purposes as a Contact of the Customer each with their own contact information +- as an optional Customer User account that allows the customer contact to login to AyaNova and use the [Customer access](adm-global-settings.md#customer-access-settings) self-service features + +## 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 +- Sales + + +Read only access + +- Business administration - restricted +- Service manager - restricted +- Service technician +- Sales - restricted + +## How to access Customer contacts + +0000000000 CONTINUE HERE 00000000000000000 + +Customer contacts are accessed in the following ways: + +- From the `Accounting` navigation pane `Customer contacts` item +- By clicking on the [open record icon](ay-start-form-autocomplete.md#opening-selected-record) any Tax code selection list on any other form where Customer contacts 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 Customer contacts such as the [Work order list](svc-workorders.md) + +## How Customer contacts work + +### Selecting + +Customer contacts are selected on [Purchase orders](inv-purchase-orders.md), [Work orders](svc-workorders.md), [Quotes](svc-quotes.md) and [Preventive Maintenance](svc-pms.md) orders to indicate and calculate taxes for both purchase and sales events. + +### Locked when used + +Tax code Percentages and Tax on Tax fields are **locked** to prevent editing once they are used on another object in order to protect the historical record. Other fields remain editable as they would not affect past record tax calculations. + +After an edit and save that affects any of the calculation affecting fields the AyaNova server will check if any objects are using this Tax code and if any are found will prevent the change and report back all object types involved. Options are to remove or switch the Tax code from the existing in-use objects to be able to edit those fields or simply make a new Tax code. + +### Retiring + +When a tax rate changes a new tax code must be made to replace the previously used tax code with the now outdated rate in order to preserve historical data. The old rate must be "retired" to prevent it from being used in future. + +When a tax code is retired it should be set to inactive by un-checking it's Active checkbox and a new active tax code created to take it's place. Setting to inactive prevents it from being selected on new records but still shows it on historical records. + +Due to the need to replace customer contacts from time to time and the requirement that Names be unique we recommend customer contacts be named uniquely by appending the year they go into effect or some other system that makes sense for your needs. + +### Automatic default + +Customer contacts can be set to default automatically (you can still change the default when necessary) in [Global Settings](adm-global-settings.md#default-parts-purchase-tax). + +A default tax code can not be deleted unless it is removed as a default first. + +### Not required + +Customer contacts are optional and not required to be used if they are not appropriate for your situation. + +## Customer contacts data table + +The Customer contacts [data table](ay-start-form-data-tables.md) lists all the Customer contacts available and provides all data table [common menu options](ay-start-form-data-tables.md#common-menu-options). + +## Tax code edit form + +The Tax code edit form contains all the [standard edit form](ay-start-edit-forms.md) functionality and contains the following fields: + +#### Name + +This is the name of the rate as it's displayed in forms and reports. A rate name must be unique from all other Customer contacts entered. Remember this is the Name that Customers will see on reports if provided to them. + + + + +0000000000000000000000000000000000000000000000000000000000000000000 # CUSTOMER-CONTACT Placeholder [UNDER CONSTRUCTION] diff --git a/docs/8.0/ayanova/docs/ops-log.md b/docs/8.0/ayanova/docs/ops-log.md index 73e41a31..efd6cc50 100644 --- a/docs/8.0/ayanova/docs/ops-log.md +++ b/docs/8.0/ayanova/docs/ops-log.md @@ -1,8 +1,6 @@ # Server log -AyaNova keeps a log of important events for troubleshooting purposes. - -AyaNova logs to the file log-ayanova.txt. +AyaNova logs important events to the file log-ayanova.txt for troubleshooting purposes. Every Wednesday it archives the current log file to a numbered archive log file, for example log-ayanova-1.txt, log-ayanova-2.txt etc. Any log older than 4 weeks is deleted permanently; 4 total logs are kept, which means a total of one month of logs are kept at any given time. @@ -21,7 +19,7 @@ Example command line log path parameter AyaNova supports 6 levels of logging, the default level is "Info" which is a medium level and will log general operations and any errors or warnings that may arise. **WARNING** -AyaNova server performance will be impacted negatively when setting a log level lower than Info. A very large amount of information is logged at Debug or lower levels and each item logged takes time away from the normal server operations. Unless directed to by technical support or attempting to diagnose a specific problem, you should avoid setting a log level lower than "Info". +AyaNova server performance will be impacted negatively when setting a log level lower than Info. A very large amount of information is logged at Debug or lower levels and each item logged takes time away from the normal server operations. Unless directed to by technical support or attempting to diagnose a specific problem, you should avoid setting a log level lower than "Info" and if you do be sure to set it back the moment you don't need that detail anymore. You can set the log level via environment variable or command line parameter "AYANOVA_LOG_LEVEL". @@ -54,13 +52,14 @@ or set the environment variable Warning: this diagnostic log should be disabled as soon as it's not required. Unlike the normal log, this log file is not automatically trimmed so it will grow in size forever and will slow down the server. -Log items that might appear and what they mean: +## Errors that might appear in the log ### "Thread pool starvation" + e.g. ```log 2021-12-28 15:07:31.1867|WARN|Microsoft.AspNetCore.Server.Kestrel|As of "12/28/2021 23:07:20 +00:00", the heartbeat has been running for "00:00:01.3469381" which is longer than "00:00:01". This could be caused by thread pool starvation. ``` -Typically under heavy reporting load but could occur in other circumstances, this error means the CPU on the server is overworked. Intermittenly this is ok but regularly it is not and indicates a need to increase CPU resources. +Typically under heavy reporting load but could occur in other circumstances, this error means the CPU on the server is overworked. Intermittenly this is ok but regularly it is not and indicates a need to increase CPU resources.