2022-02-01 15:55:16 +00:00
parent bb171d7a36
commit 77c1da49c6
37 changed files with 58 additions and 73 deletions
--- a/docs/8.0/ayanova/docs/adm-getting-started.md
+++ b/docs/8.0/ayanova/docs/adm-getting-started.md
@@ -1,6 +1,6 @@
 # Administration - getting started
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
 - Licensing
 - erase evaluation data 
--- a/docs/8.0/ayanova/docs/adm-import.md
+++ b/docs/8.0/ayanova/docs/adm-import.md
@@ -1,6 +1,6 @@
 # Import
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
 DOC NOTES:
--- a/docs/8.0/ayanova/docs/ay-biz-admin-intro.md
+++ b/docs/8.0/ayanova/docs/ay-biz-admin-intro.md
@@ -1,5 +1,5 @@
 # Customization and business administration introduction
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
 #b4beta
 Overview of customization features (translation, templates (picklist, datalist etc)) and admin (Global) setttings with links to each section
--- a/docs/8.0/ayanova/docs/ay-evaluate.md
+++ b/docs/8.0/ayanova/docs/ay-evaluate.md
@@ -1,6 +1,6 @@
 # Evaluate AyaNova
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
 The evaluation form is currently provided to generate sample data in order to be able to quickly try out features.
 The sample data is randomly generated and will differ each time it is generated.
--- a/docs/8.0/ayanova/docs/customer-csr.md
+++ b/docs/8.0/ayanova/docs/customer-csr.md
@@ -1,3 +1,3 @@
 # CUSTOMER-CSR Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
--- a/docs/8.0/ayanova/docs/customer-notes.md
+++ b/docs/8.0/ayanova/docs/customer-notes.md
@@ -1,3 +1,3 @@
 # CUST-CUSTOMER-NOTES Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
--- a/docs/8.0/ayanova/docs/customer-workorders.md
+++ b/docs/8.0/ayanova/docs/customer-workorders.md
@@ -1,3 +1,3 @@
 # CUSTOMER-WORKORDERS Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
--- a/docs/8.0/ayanova/docs/home-dashboard.md
+++ b/docs/8.0/ayanova/docs/home-dashboard.md
@@ -1,3 +1,3 @@
 # HOME-DASHBOARD Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
--- a/docs/8.0/ayanova/docs/home-memos.md
+++ b/docs/8.0/ayanova/docs/home-memos.md
@@ -1,3 +1,3 @@
 # HOME-MEMOS Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
--- a/docs/8.0/ayanova/docs/home-translation.md
+++ b/docs/8.0/ayanova/docs/home-translation.md
@@ -1,3 +1,3 @@
 # HOME-TRANSLATION Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
--- a/docs/8.0/ayanova/docs/inv-part-assemblies.md
+++ b/docs/8.0/ayanova/docs/inv-part-assemblies.md
@@ -1,3 +1,3 @@
 # INV-PART-ASSEMBLIES Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
--- a/docs/8.0/ayanova/docs/inv-part-inventory.md
+++ b/docs/8.0/ayanova/docs/inv-part-inventory.md
@@ -1,3 +1,3 @@
 # INV-PART-INVENTORY Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
--- a/docs/8.0/ayanova/docs/inv-part-requests.md
+++ b/docs/8.0/ayanova/docs/inv-part-requests.md
@@ -1,3 +1,3 @@
 # INV-PART-REQUESTS Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
--- a/docs/8.0/ayanova/docs/inv-part-serials.md
+++ b/docs/8.0/ayanova/docs/inv-part-serials.md
@@ -1,3 +1,3 @@
 # INV-PART-SERIALS Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
--- a/docs/8.0/ayanova/docs/inv-part-stock-levels.md
+++ b/docs/8.0/ayanova/docs/inv-part-stock-levels.md
@@ -1,3 +1,3 @@
 # INV-PART-STOCK-LEVELS Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
--- a/docs/8.0/ayanova/docs/inv-part-warehouses.md
+++ b/docs/8.0/ayanova/docs/inv-part-warehouses.md
@@ -1,3 +1,3 @@
 # INV-PART-WAREHOUSES Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
--- a/docs/8.0/ayanova/docs/inv-parts.md
+++ b/docs/8.0/ayanova/docs/inv-parts.md
@@ -1,3 +1,3 @@
 # INV-PARTS Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
--- a/docs/8.0/ayanova/docs/ops-error-codes.md
+++ b/docs/8.0/ayanova/docs/ops-error-codes.md
@@ -1,28 +1,24 @@
 # Server error codes
-#b4beta (clean up, remove unused error codes check if any others missing)
+
-AyaNova will provide a server error code when an error arises.
+AyaNova will provide a numeric server error code when an error arises.
 All AyaNova server error codes start with the letter E followed by a number in the range 1000-1999.
 Server error codes are different from [API error codes](api-error-codes.md) which are intended for software and developers using the AyaNova developers API.
-The purpose of these server error codes is to make it easier to look them up in this manual and easily communicate errors to technical support if necessary.
+The purpose of numeric error codes is to make it easier to search for and communicate errors to technical support if necessary.
 In most cases where an error occurs there will be more detailed information about the error in the [log file](ops-log.md).
 Here are all the error codes that can be returned by the AyaNova server:
-| CODE | MEANING |
+| CODE  | MEANING                                                                                                                                                                                                                                                                 |
-| ----- | ------------------------------ |
+| ----- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| E1000 | Could not connect to the database specified in the [connection string](ops-config-db.md). |
+| E1000 | Could not connect to the database specified in the [connection string](ops-config-db.md).                                                                                                                                                                               |
-| E1010 | Could not find wwwRoot folder. AyaNova must be started from the folder immediately above wwwRoot.  Generally the start folder should be the same folder as AyaNova.dll file. |
+| E1010 | Could not find wwwRoot folder. AyaNova must be started from the folder immediately above wwwRoot. Generally the start folder should be the same folder as AyaNova.dll file.                                                                                             |
-| E1012 | Missing resource folder. AyaNova was started from the wrong location or was not installed properly. |
+| E1012 | Missing resource folder. AyaNova was started from the wrong location or was not installed properly.                                                                                                                                                                     |
-| E1013 | Missing translation resource file was deleted, renamed or not installed correctly. Resource translation files are required to load into a new AyaNova database to display text in several translations for the user interface |
+| E1013 | Missing translation resource file was deleted, renamed or not installed correctly. Resource translation files are required to load into a new AyaNova database to display text in several translations for the user interface                                           |
-| E1015 | Missing translation. One or more of the stock translations were not found in the database or a custom translation specified in the config setting [AYANOVA_DEFAULT_TRANSLATION](ops-config-default-translation.md) is missing from the database.  Log will have details. |
+| E1015 | Missing translation. One or more of the stock translations were not found in the database or a custom translation specified in the config setting [AYANOVA_DEFAULT_TRANSLATION](ops-config-default-translation.md) is missing from the database. Log will have details. |
-| E1020 | Licensing related error. The message will contain the explanation |
+| E1020 | Licensing related error. The message will contain the explanation                                                                                                                                                                                                       |
-| E1030 | AyaNova database failed an integrity check. Contact support immediately. |
+| E1030 | AyaNova database failed an integrity check. Contact support immediately.                                                                                                                                                                                                |
-| E1040 | File location [environment variables](ops-config-environment-variables.md) for backup files and user files were found to be the same location and must not be |
+| E1040 | File location [environment variables](ops-config-environment-variables.md) for backup files and user files were found to be the same location and must not be                                                                                                           |
-| E1050 | XXXXXXXX |
+| E1090 | AyaNova failed to start due to an unexpected error during boot.                                                                                                                                                                                                         |
 | E1060 | XXXXXXXX |
 | E1070 | XXXXXXXX |
 | E1080 | XXXXXXXX |
 | E1090 | AyaNova failed to start due to an unexpected error during boot. |
--- a/docs/8.0/ayanova/docs/ops-jobs.md
+++ b/docs/8.0/ayanova/docs/ops-jobs.md
@@ -1,3 +1,3 @@
 # OPS-JOBS Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
--- a/docs/8.0/ayanova/docs/ops-metrics.md
+++ b/docs/8.0/ayanova/docs/ops-metrics.md
@@ -1,29 +1,18 @@
-# Metrics 
+# Metrics
-[under construction]
+[THIS PAGE UNDER CONSTRUCTION]
 AyaNova 8+ automatically tracks server metrics for ongoing server maintenance, monitoring and troubleshooting.
 ## OVERVIEW
 Metrics are statistical and other information gathered automatically during server operation that can be used to assess the health of an AyaNova server.
 This information is typically useful to the Operations staff who are responsible for maintaining the AyaNova server in good working condition.
 When the AyaNova server is booted it starts gathering snapshots of statistical data during regular intervals that can be viewed to observe the current state of the server and some historical data from the point it was last rebooted.
-
+0000000000000000000000000000000000
-todo: how to view metrics, what they mean what to use them for
+###### to document
-todo: more details
+- link to chart control in common controls doc
-    how to use chart 
+- What each stat means and how it's to be interpreted
-		i.e. can hover, can hide line by clicking on legend etc
+- Frequency of stat gathering
-	  //NOTE: CPU percentage is *our* process cpu percentage over timeframe of last captured avg
+- Auto deleted after 365 days
-                //So it does *not* show the entire server cpu load, only for AyaNova.
+- Used to provide trend monitoring over time so can know if need to upgrade the server it's hosted on or to anticipate running out of disk space, overwhelmed cpu pegging at 100% etc etc
                //Overall server stats need to be captured / viewed independently (digital ocean control panel for example or windows task manager)
    What each stat means and how it's to be interpreted
    Frequency of stat gathering
    Auto deleted after 365 days
    Used to provide trend monitoring over time so can know if need to upgrade the server it's hosted on or to anticipate running out of disk space, overwhelmed cpu pegging at 100% etc etc
--- a/docs/8.0/ayanova/docs/ops-notify-queue.md
+++ b/docs/8.0/ayanova/docs/ops-notify-queue.md
@@ -1,3 +1,3 @@
 # OPS-NOTIFY-QUEUE Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
--- a/docs/8.0/ayanova/docs/ops-profile.md
+++ b/docs/8.0/ayanova/docs/ops-profile.md
@@ -1,5 +1,5 @@
 # OPS-PROFILE Placeholder
-[under construction]
+[THIS PAGE UNDER CONSTRUCTION]
 primarily for tech support diagnosis in case of slowness
 only keeps last half hour of stats
 how to use: trigger slow operation, then go to this page right away and walk through looking for slow ness
--- a/docs/8.0/ayanova/docs/ops-server-state.md
+++ b/docs/8.0/ayanova/docs/ops-server-state.md
@@ -1,4 +1,4 @@
 # OPS SERVER STATE
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
 #b4beta
--- a/docs/8.0/ayanova/docs/svc-csr.md
+++ b/docs/8.0/ayanova/docs/svc-csr.md
@@ -1,3 +1,3 @@
 # SVC-CSR Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
--- a/docs/8.0/ayanova/docs/svc-loaners.md
+++ b/docs/8.0/ayanova/docs/svc-loaners.md
@@ -1,6 +1,6 @@
 # SVC-LOANERS Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
 ## Shadow units
--- a/docs/8.0/ayanova/docs/svc-meter-readings.md
+++ b/docs/8.0/ayanova/docs/svc-meter-readings.md
@@ -1,3 +1,3 @@
 # SVC-METER-READINGS Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
--- a/docs/8.0/ayanova/docs/svc-pms.md
+++ b/docs/8.0/ayanova/docs/svc-pms.md
@@ -1,6 +1,6 @@
 # SVC-PMs Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
 #b4beta (docs can refer to work order here for bulk of text)
 ### Automatic date calculations
--- a/docs/8.0/ayanova/docs/svc-projects.md
+++ b/docs/8.0/ayanova/docs/svc-projects.md
@@ -1,3 +1,3 @@
 # SVC-PROJECTS Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
--- a/docs/8.0/ayanova/docs/svc-quotes.md
+++ b/docs/8.0/ayanova/docs/svc-quotes.md
@@ -1,5 +1,5 @@
 # SVC-QUOTES Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
 #b4beta (docs can refer to work order here for bulk of text)
--- a/docs/8.0/ayanova/docs/svc-task-groups.md
+++ b/docs/8.0/ayanova/docs/svc-task-groups.md
@@ -1,3 +1,3 @@
 # SVC-TASK-GROUPS Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
--- a/docs/8.0/ayanova/docs/svc-unit-models.md
+++ b/docs/8.0/ayanova/docs/svc-unit-models.md
@@ -1,3 +1,3 @@
 # SVC-UNIT-MODELS Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
--- a/docs/8.0/ayanova/docs/svc-units.md
+++ b/docs/8.0/ayanova/docs/svc-units.md
@@ -1,3 +1,3 @@
 # SVC-UNITS Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
--- a/docs/8.0/ayanova/docs/svc-work-order-item-priority.md
+++ b/docs/8.0/ayanova/docs/svc-work-order-item-priority.md
@@ -1,4 +1,4 @@
 # svc-work-order-item-priority Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
--- a/docs/8.0/ayanova/docs/svc-work-order-item-status.md
+++ b/docs/8.0/ayanova/docs/svc-work-order-item-status.md
@@ -1,4 +1,4 @@
 # svc-work-order-item-status Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
--- a/docs/8.0/ayanova/docs/svc-work-order-status.md
+++ b/docs/8.0/ayanova/docs/svc-work-order-status.md
@@ -1,6 +1,6 @@
 # svc-work-order-status Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
 #b4beta
 todo: locking - locks workorder from edit (other than status for roles that are in status can remove)
 todo: completed - used for notification processing 
--- a/docs/8.0/ayanova/docs/svc-workorders.md
+++ b/docs/8.0/ayanova/docs/svc-workorders.md
@@ -1,6 +1,6 @@
 # SVC-WORKORDERS Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
 #b4beta
 docs / sections required
--- a/docs/8.0/ayanova/docs/vendors.md
+++ b/docs/8.0/ayanova/docs/vendors.md
@@ -1,3 +1,3 @@
 # VENDORS Placeholder
-[UNDER CONSTRUCTION]
+[THIS PAGE UNDER CONSTRUCTION]
`@@ -1,3 +1,3 @@`
	`# CUSTOMER-CSR Placeholder`	`# CUSTOMER-CSR Placeholder`

	`[UNDER CONSTRUCTION]`	`[THIS PAGE UNDER CONSTRUCTION]`
`@@ -1,3 +1,3 @@`
	`# CUST-CUSTOMER-NOTES Placeholder`	`# CUST-CUSTOMER-NOTES Placeholder`

	`[UNDER CONSTRUCTION]`	`[THIS PAGE UNDER CONSTRUCTION]`
`@@ -1,3 +1,3 @@`
	`# CUSTOMER-WORKORDERS Placeholder`	`# CUSTOMER-WORKORDERS Placeholder`

	`[UNDER CONSTRUCTION]`	`[THIS PAGE UNDER CONSTRUCTION]`
`@@ -1,3 +1,3 @@`
	`# HOME-DASHBOARD Placeholder`	`# HOME-DASHBOARD Placeholder`

	`[UNDER CONSTRUCTION]`	`[THIS PAGE UNDER CONSTRUCTION]`
`@@ -1,3 +1,3 @@`
	`# HOME-MEMOS Placeholder`	`# HOME-MEMOS Placeholder`

	`[UNDER CONSTRUCTION]`	`[THIS PAGE UNDER CONSTRUCTION]`
`@@ -1,3 +1,3 @@`
	`# HOME-TRANSLATION Placeholder`	`# HOME-TRANSLATION Placeholder`

	`[UNDER CONSTRUCTION]`	`[THIS PAGE UNDER CONSTRUCTION]`
`@@ -1,3 +1,3 @@`
	`# INV-PART-ASSEMBLIES Placeholder`	`# INV-PART-ASSEMBLIES Placeholder`

	`[UNDER CONSTRUCTION]`	`[THIS PAGE UNDER CONSTRUCTION]`
`@@ -1,3 +1,3 @@`
	`# INV-PART-INVENTORY Placeholder`	`# INV-PART-INVENTORY Placeholder`

	`[UNDER CONSTRUCTION]`	`[THIS PAGE UNDER CONSTRUCTION]`
`@@ -1,3 +1,3 @@`
	`# INV-PART-REQUESTS Placeholder`	`# INV-PART-REQUESTS Placeholder`

	`[UNDER CONSTRUCTION]`	`[THIS PAGE UNDER CONSTRUCTION]`
`@@ -1,3 +1,3 @@`
	`# INV-PART-SERIALS Placeholder`	`# INV-PART-SERIALS Placeholder`

	`[UNDER CONSTRUCTION]`	`[THIS PAGE UNDER CONSTRUCTION]`