From b02417185e3d0afefd46fb58c484f72c60d9dbc8 Mon Sep 17 00:00:00 2001 From: John Cardinal Date: Fri, 7 Jan 2022 20:19:06 +0000 Subject: [PATCH] --- .vscode/launch.json | 2 +- docs/8.0/ayanova/docs/adm-attachments.md | 2 ++ docs/8.0/ayanova/docs/adm-global-seeds.md | 6 +++- .../docs/adm-global-select-templates.md | 2 +- docs/8.0/ayanova/docs/adm-report-templates.md | 2 ++ docs/8.0/ayanova/docs/adm-users.md | 10 +++--- docs/8.0/ayanova/docs/api-intro.md | 6 +++- docs/8.0/ayanova/docs/ay-about.md | 2 ++ .../ayanova/docs/ay-biz-admin-import-v7.md | 2 ++ docs/8.0/ayanova/docs/ay-biz-admin-intro.md | 2 +- docs/8.0/ayanova/docs/ay-biz-admin-roles.md | 2 +- docs/8.0/ayanova/docs/ay-customize.md | 2 +- docs/8.0/ayanova/docs/ay-ex-delete.md | 4 +++ docs/8.0/ayanova/docs/ay-extensions.md | 2 +- docs/8.0/ayanova/docs/ay-history.md | 2 +- docs/8.0/ayanova/docs/ay-log.md | 1 + docs/8.0/ayanova/docs/ay-notification.md | 2 ++ docs/8.0/ayanova/docs/ay-report-edit.md | 2 ++ docs/8.0/ayanova/docs/ay-report.md | 1 + docs/8.0/ayanova/docs/ay-review.md | 2 +- .../ayanova/docs/ay-start-common-controls.md | 2 ++ docs/8.0/ayanova/docs/ay-start-data-types.md | 1 + docs/8.0/ayanova/docs/ay-start-edit-forms.md | 2 +- docs/8.0/ayanova/docs/ay-start-event-log.md | 2 ++ .../ayanova/docs/ay-start-form-attachments.md | 3 ++ .../docs/ay-start-form-custom-fields.md | 5 ++- .../ayanova/docs/ay-start-form-overview.md | 2 ++ docs/8.0/ayanova/docs/ay-start-form-tags.md | 2 +- docs/8.0/ayanova/docs/ay-start-form-wiki.md | 2 +- .../8.0/ayanova/docs/ay-start-localization.md | 2 +- docs/8.0/ayanova/docs/ay-start-login.md | 9 ++++- docs/8.0/ayanova/docs/ay-start-trial-login.md | 4 +++ docs/8.0/ayanova/docs/ay-start-user-intro.md | 2 ++ docs/8.0/ayanova/docs/ay-translation.md | 6 +++- docs/8.0/ayanova/docs/common-log.md | 2 +- docs/8.0/ayanova/docs/customers.md | 2 -- docs/8.0/ayanova/docs/home-notifications.md | 4 ++- docs/8.0/ayanova/docs/home-password.md | 12 ++++--- docs/8.0/ayanova/docs/home-reminders.md | 2 ++ docs/8.0/ayanova/docs/home-reviews.md | 2 +- docs/8.0/ayanova/docs/home-search.md | 6 +++- docs/8.0/ayanova/docs/home-tfa.md | 1 - docs/8.0/ayanova/docs/home-user-settings.md | 36 +++++++++++-------- docs/8.0/ayanova/docs/index.md | 10 +++--- docs/8.0/ayanova/mkdocs.yml | 8 ++--- 45 files changed, 129 insertions(+), 56 deletions(-) diff --git a/.vscode/launch.json b/.vscode/launch.json index c384240e..f525061c 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -48,7 +48,7 @@ "AYANOVA_DATA_PATH": "c:\\temp\\ravendata", "AYANOVA_USE_URLS": "http://*:7575;", //"AYANOVA_PERMANENTLY_ERASE_DATABASE":"true", - "AYANOVA_SERVER_TEST_MODE": "true", + "AYANOVA_SERVER_TEST_MODE": "false", //"AYANOVA_REPORT_RENDERING_TIMEOUT":"60", "AYANOVA_SERVER_TEST_MODE_SEEDLEVEL": "small", "AYANOVA_BACKUP_PG_DUMP_PATH": "C:\\data\\code\\postgres_14\\bin\\" diff --git a/docs/8.0/ayanova/docs/adm-attachments.md b/docs/8.0/ayanova/docs/adm-attachments.md index e06a5e84..b6679d28 100644 --- a/docs/8.0/ayanova/docs/adm-attachments.md +++ b/docs/8.0/ayanova/docs/adm-attachments.md @@ -2,6 +2,8 @@ [UNDER CONSTRUCTION] +#b4beta + todo: insert note in docs (ops?) if upload won't work from a device and error not evident check in the AyaNova client error log under help-About and see if there is an error 413 related to the recent file (camera image) upload, as it's likely not AyaNova restricting but a intermediary front end setting, e.g. NGinX te about nginx somewhere or any front end when receive error 413 when attempt to upload a large attachment. AyaNova allows up to 10gb in the upload but if there is a front end ahead of it like nginx then a setting diff --git a/docs/8.0/ayanova/docs/adm-global-seeds.md b/docs/8.0/ayanova/docs/adm-global-seeds.md index 2494a8ee..e4d393f5 100644 --- a/docs/8.0/ayanova/docs/adm-global-seeds.md +++ b/docs/8.0/ayanova/docs/adm-global-seeds.md @@ -1,4 +1,8 @@ -# ADM-GLOBAL-SEEDS (documentation under construction) +# ADM-GLOBAL-SEEDS + +[under construction] + +#b4beta Set next starting serial number for serialized objects. diff --git a/docs/8.0/ayanova/docs/adm-global-select-templates.md b/docs/8.0/ayanova/docs/adm-global-select-templates.md index 8d67c6ac..74dbb550 100644 --- a/docs/8.0/ayanova/docs/adm-global-select-templates.md +++ b/docs/8.0/ayanova/docs/adm-global-select-templates.md @@ -2,7 +2,7 @@ This form is used to set the fields displayed and searched in select lists on forms. - +#b4beta [UNDER CONSTRUCTION] This setting is *required* and controls which [translation](adm-translations.md) of AyaNova is used to display program text to the current logged in user. diff --git a/docs/8.0/ayanova/docs/adm-report-templates.md b/docs/8.0/ayanova/docs/adm-report-templates.md index d2ba4f26..61afe63f 100644 --- a/docs/8.0/ayanova/docs/adm-report-templates.md +++ b/docs/8.0/ayanova/docs/adm-report-templates.md @@ -1,5 +1,7 @@ # ADM-REPORT-TEMPLATES Placeholder +#b4beta (consolidate this page away, it seems redundent and we can't list every 100 report here pointlessly) + AyaNova report templates are listed here. You can edit report templates in the [Report template editor](ay-report-edit.md) diff --git a/docs/8.0/ayanova/docs/adm-users.md b/docs/8.0/ayanova/docs/adm-users.md index 71519263..2eeccb89 100644 --- a/docs/8.0/ayanova/docs/adm-users.md +++ b/docs/8.0/ayanova/docs/adm-users.md @@ -1,12 +1,13 @@ # ADM-USERS Placeholder [UNDER CONSTRUCTION] +#b4beta This form is used to create and edit Users and control their access to AyaNova. ## Do not share User accounts -Every User of AyaNova **must** have their own account. AyaNova does *not* support multiple simultaneous logins with the same User account; a fresh login automatically revokes prior logins so logging in as a User that is already logged in will kick out the originally logged in User. +Every User of AyaNova **must** have their own account. AyaNova does _not_ support multiple simultaneous logins with the same User account; a fresh login automatically revokes prior logins so logging in as a User that is already logged in will kick out the originally logged in User. For security purposes it is important that each User have their own account so that it's easy to keep track of who did what when and where in case issues arise. Also it makes it easier to revoke access when a User is no longer allowed to access AyaNova. @@ -64,9 +65,10 @@ This type of User consumes an AyaNova license, is scheduleable for service and i Set or reset the User's login name and password here. Note that the User can also change their own login credentials in their User settings so it's often the case that a temporary set of credentials is set here by the administrator and then the User themselves will use this to login and immediately change their login and password. -If this value is changed while a User is actively logged in, it doesn't take effect until the *next* time they login. +If this value is changed while a User is actively logged in, it doesn't take effect until the _next_ time they login. ### Last login + This read only field shows the last time this User logged in for security purposes. ### Active @@ -85,17 +87,17 @@ Scheduleable Users only consume a license when they are set to Active. De-activa Scheduleable Users only appear in the schedule form if they are Active, de-activating a User means their work order scheduled items will not be displayed in the Service -> Schedule form so be sure to re-assign any open scheduled work order items for them to another Active User to ensure it doesn't get lost. You can not see their work order items in the graphical schedule form but you can still see them in the Work order data tables so click through to the Scheduled Users list, filter by the inactive Tech to confirm and re-assign any unfinished work still under their name. ### Notes + This optional field is for the Use of the AyaNova administrator and is not displayed to the User themselves. It can be used for any purpose required. ### Tags Tags for Users are optional but connected to many areas of AyaNova when it comes to filtering data and the notification system in particular. -If the User is a scheduleable type, the tags entered here can be used as a filter in the schedule calendar to filter in or out data by tagged Users. This is useful in a large busy shop when there are just too many items to display in the graphical schedule and so tags are created to group scheduleable Users in some way that is most appropriate for the dispatcher / scheduler staff. +If the User is a scheduleable type, the tags entered here can be used as a filter in the schedule calendar to filter in or out data by tagged Users. This is useful in a large busy shop when there are just too many items to display in the graphical schedule and so tags are created to group scheduleable Users in some way that is most appropriate for the dispatcher / scheduler staff. In addition some notifications can be filtered by tag as required. - ## User settings tab This section is a duplicate of the [User settings](home-user-settings.md) form. This tab can be used to set up Users in advance and is also mirrored for the User themselves to make adjustments including changing their own password and login. diff --git a/docs/8.0/ayanova/docs/api-intro.md b/docs/8.0/ayanova/docs/api-intro.md index 53402385..a16f4779 100644 --- a/docs/8.0/ayanova/docs/api-intro.md +++ b/docs/8.0/ayanova/docs/api-intro.md @@ -1,3 +1,7 @@ # DEVELOPERS API -AyaNova REST API for developers +[under construction] + +AyaNova features a REST API that can be used by developers to integrate with AyaNova. + +todo: consolidate api api-error-codes / request / response / upload route stuff here into this document diff --git a/docs/8.0/ayanova/docs/ay-about.md b/docs/8.0/ayanova/docs/ay-about.md index 5bbc33d1..a360c1a9 100644 --- a/docs/8.0/ayanova/docs/ay-about.md +++ b/docs/8.0/ayanova/docs/ay-about.md @@ -1,3 +1,5 @@ # MISC-ABOUT Placeholder [UNDER CONSTRUCTION] + +#b4beta \ No newline at end of file diff --git a/docs/8.0/ayanova/docs/ay-biz-admin-import-v7.md b/docs/8.0/ayanova/docs/ay-biz-admin-import-v7.md index 7139143d..152901e2 100644 --- a/docs/8.0/ayanova/docs/ay-biz-admin-import-v7.md +++ b/docs/8.0/ayanova/docs/ay-biz-admin-import-v7.md @@ -1,5 +1,7 @@ # BUSINESS ADMINISTRATION MIGRATE TO V8 +#b4beta todo: go over this and clear it + ## OVERVIEW This page outlines the changes and setup tasks that will need to be done after migration from a business administration point of view. diff --git a/docs/8.0/ayanova/docs/ay-biz-admin-intro.md b/docs/8.0/ayanova/docs/ay-biz-admin-intro.md index 03e9c55c..d84541c3 100644 --- a/docs/8.0/ayanova/docs/ay-biz-admin-intro.md +++ b/docs/8.0/ayanova/docs/ay-biz-admin-intro.md @@ -1,3 +1,3 @@ # Customization and business administration introduction - +#b4beta Overview of customization features (translation, templates (picklist, datalist etc)) and admin (Global) setttings with links to each section \ No newline at end of file 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 f5bf31bc..3a596913 100644 --- a/docs/8.0/ayanova/docs/ay-biz-admin-roles.md +++ b/docs/8.0/ayanova/docs/ay-biz-admin-roles.md @@ -1,4 +1,4 @@ # AUTHORIZATION ROLES - +#b4beta todo: overview of roles, list of roles and how they work NOT how to assign roles, that's in the form documentation for User or elsehwere, this is *about* roles \ No newline at end of file diff --git a/docs/8.0/ayanova/docs/ay-customize.md b/docs/8.0/ayanova/docs/ay-customize.md index 141d4f55..d9c204dd 100644 --- a/docs/8.0/ayanova/docs/ay-customize.md +++ b/docs/8.0/ayanova/docs/ay-customize.md @@ -1,5 +1,5 @@ # Customize form - +#b4beta [UNDER CONSTRUCTION] todo: customize form menu option and link to custom fields detailed [form](ay-start-form-custom-fields.md)here diff --git a/docs/8.0/ayanova/docs/ay-ex-delete.md b/docs/8.0/ayanova/docs/ay-ex-delete.md index 103c012a..f5a90e61 100644 --- a/docs/8.0/ayanova/docs/ay-ex-delete.md +++ b/docs/8.0/ayanova/docs/ay-ex-delete.md @@ -1,5 +1,9 @@ # DELETE EXTENSION +[under construction] + +todo: clear this (images?) + The Delete extension can be used to permanently delete multiple items at once. AyaNova will attempt to delete all selected items and will report back if any were not able to be deleted. diff --git a/docs/8.0/ayanova/docs/ay-extensions.md b/docs/8.0/ayanova/docs/ay-extensions.md index 3c7fcc9d..da93ca7b 100644 --- a/docs/8.0/ayanova/docs/ay-extensions.md +++ b/docs/8.0/ayanova/docs/ay-extensions.md @@ -1,3 +1,3 @@ # Extensions - +#b4beta todo: general doc about extensions with links to each one \ No newline at end of file diff --git a/docs/8.0/ayanova/docs/ay-history.md b/docs/8.0/ayanova/docs/ay-history.md index c75c8c74..a62061db 100644 --- a/docs/8.0/ayanova/docs/ay-history.md +++ b/docs/8.0/ayanova/docs/ay-history.md @@ -1,3 +1,3 @@ # MISC-RECORD HISTORY Placeholder - +#b4beta [UNDER CONSTRUCTION] diff --git a/docs/8.0/ayanova/docs/ay-log.md b/docs/8.0/ayanova/docs/ay-log.md index 60a0e917..9e58ec54 100644 --- a/docs/8.0/ayanova/docs/ay-log.md +++ b/docs/8.0/ayanova/docs/ay-log.md @@ -1,3 +1,4 @@ # CLIENT LOG FORM HELP Placeholder [UNDER CONSTRUCTION] +#b4beta (what is this, where does it link from? Do we need it?) \ No newline at end of file diff --git a/docs/8.0/ayanova/docs/ay-notification.md b/docs/8.0/ayanova/docs/ay-notification.md index 6550ea17..a393eb70 100644 --- a/docs/8.0/ayanova/docs/ay-notification.md +++ b/docs/8.0/ayanova/docs/ay-notification.md @@ -1,3 +1,5 @@ # NOTIFICATION Placeholder [UNDER CONSTRUCTION] + +#b4beta (what is this and do we need it and wehre does it link from) \ No newline at end of file diff --git a/docs/8.0/ayanova/docs/ay-report-edit.md b/docs/8.0/ayanova/docs/ay-report-edit.md index 494fad83..dc8a6454 100644 --- a/docs/8.0/ayanova/docs/ay-report-edit.md +++ b/docs/8.0/ayanova/docs/ay-report-edit.md @@ -2,6 +2,8 @@ [UNDER CONSTRUCTION] +#b4beta (clear this for release, remove under construction status) + AyaNova features a built-in report template editor and reports can be created or customized directly within AyaNova. AyaNova report templates are based upon commonly used web technology and are HTML based template documents that are used with the [Handlebars](https://handlebarsjs.com/) templating language to generate HTML documents that are rendered to .PDF [Portable document format](https://en.wikipedia.org/wiki/PDF) files. diff --git a/docs/8.0/ayanova/docs/ay-report.md b/docs/8.0/ayanova/docs/ay-report.md index dd2de761..fdde22c5 100644 --- a/docs/8.0/ayanova/docs/ay-report.md +++ b/docs/8.0/ayanova/docs/ay-report.md @@ -1,5 +1,6 @@ # Report viewer form placeholder +#b4beta (what is this exactly and where is it linked from, does it need to be fleshed out, if it's how to use the report rendering then yes and include screnshots before beta) Report viewer, overview, how to use, link to report designer topics etc diff --git a/docs/8.0/ayanova/docs/ay-review.md b/docs/8.0/ayanova/docs/ay-review.md index e5cb180c..2410467f 100644 --- a/docs/8.0/ayanova/docs/ay-review.md +++ b/docs/8.0/ayanova/docs/ay-review.md @@ -1,3 +1,3 @@ # MISC-REVIEW (was followup) Placeholder - +#b4beta [UNDER CONSTRUCTION] 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 1ead3685..534b177a 100644 --- a/docs/8.0/ayanova/docs/ay-start-common-controls.md +++ b/docs/8.0/ayanova/docs/ay-start-common-controls.md @@ -2,6 +2,8 @@ [under construction] +#b4beta (complete this, very important) + TODO: ### UTC All dates and times are stored at the server in UTC (GMT) values. The server has no knowledge of time zones so this value is used to display the time and date in your local Browser time zone. diff --git a/docs/8.0/ayanova/docs/ay-start-data-types.md b/docs/8.0/ayanova/docs/ay-start-data-types.md index c894fd62..3e59442c 100644 --- a/docs/8.0/ayanova/docs/ay-start-data-types.md +++ b/docs/8.0/ayanova/docs/ay-start-data-types.md @@ -17,6 +17,7 @@ When viewing data in AyaNova that is filtered, the browser's current time and ti ### Currency Currency values are stored with 38 digit precision and 18 digit scale. This means a total of 38 digits can be stored and of those 38 digits, up to 18 can come after the decimal point. This level of precision and scale is more than adequate for most circulating currencies but is necessary to accomodate potential usage of crypto currencies such as Etherium or Bitcoin. + This applies to any item which is a currency amount or a rate used to calculate a currency amount (except taxes see below) AyaNova is a single-currency program, it assumes all currency values entered are for the same currency and values entered are stored at the server as Decimal numbers. Currency as entered is interpreted and displayed with a combination of settings specified in the user's Currency setting and the locale / language setting of the browser (or the override if overriden). 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 23ca749f..41498509 100644 --- a/docs/8.0/ayanova/docs/ay-start-edit-forms.md +++ b/docs/8.0/ayanova/docs/ay-start-edit-forms.md @@ -1,7 +1,7 @@ # Edit forms [Under construction] - +#b4beta todo: all common features of edit forms here todo: all common edit form menu options detailed here todo: all common edit form controls like wiki, attached files, etc in depth here so can link to it from each form diff --git a/docs/8.0/ayanova/docs/ay-start-event-log.md b/docs/8.0/ayanova/docs/ay-start-event-log.md index 3fccc7cd..f1631c00 100644 --- a/docs/8.0/ayanova/docs/ay-start-event-log.md +++ b/docs/8.0/ayanova/docs/ay-start-event-log.md @@ -1,3 +1,5 @@ # EVENT LOG +#b4beta + todo: overview, how to access it, what is tracked and when etc \ No newline at end of file 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 e53b6be7..dadab4b5 100644 --- a/docs/8.0/ayanova/docs/ay-start-form-attachments.md +++ b/docs/8.0/ayanova/docs/ay-start-form-attachments.md @@ -1,4 +1,7 @@ # ATTACHMENTS + +#b4beta (check if this is the user's view or the admin view, if users view it must be completed before beta) + ## OVERVIEW TODO: this, see TAGS for layout \ No newline at end of file diff --git a/docs/8.0/ayanova/docs/ay-start-form-custom-fields.md b/docs/8.0/ayanova/docs/ay-start-form-custom-fields.md index 9c562be7..86c33e6c 100644 --- a/docs/8.0/ayanova/docs/ay-start-form-custom-fields.md +++ b/docs/8.0/ayanova/docs/ay-start-form-custom-fields.md @@ -1,3 +1,6 @@ # Custom fields -todo: how to customize forms to show custom fields and work with custom fields \ No newline at end of file + +#b4beta + +todo: how to customize forms to show custom fields and work with custom fields diff --git a/docs/8.0/ayanova/docs/ay-start-form-overview.md b/docs/8.0/ayanova/docs/ay-start-form-overview.md index 3c0ce9d1..a0521949 100644 --- a/docs/8.0/ayanova/docs/ay-start-form-overview.md +++ b/docs/8.0/ayanova/docs/ay-start-form-overview.md @@ -1,6 +1,8 @@ # FORMS [UNDER CONSTRUCTION] +#b4beta (clear this for release, probably just needs a read over and remove these tags unless there really are missing items or ss would help) + todo: screenshots, missing sections ## Overview 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 5ca7a9fd..c2d507a1 100644 --- a/docs/8.0/ayanova/docs/ay-start-form-tags.md +++ b/docs/8.0/ayanova/docs/ay-start-form-tags.md @@ -1,4 +1,4 @@ -# TAGS +# Tags ## OVERVIEW diff --git a/docs/8.0/ayanova/docs/ay-start-form-wiki.md b/docs/8.0/ayanova/docs/ay-start-form-wiki.md index 6dfe1c9a..49301bb4 100644 --- a/docs/8.0/ayanova/docs/ay-start-form-wiki.md +++ b/docs/8.0/ayanova/docs/ay-start-form-wiki.md @@ -1,4 +1,4 @@ -# WIKI +# Wiki ## OVERVIEW diff --git a/docs/8.0/ayanova/docs/ay-start-localization.md b/docs/8.0/ayanova/docs/ay-start-localization.md index 32aa46f8..9aed553f 100644 --- a/docs/8.0/ayanova/docs/ay-start-localization.md +++ b/docs/8.0/ayanova/docs/ay-start-localization.md @@ -1,4 +1,4 @@ -# LOCALIZATION OVERRIDES +# Locale overrides Localization here means the way in which times, dates and numbers are displayed and interpreted by AyaNova. It is separate and distinct from the [Translation](ay-translation.md) feature of AyaNova which is used to set the text displayed in the user interface. diff --git a/docs/8.0/ayanova/docs/ay-start-login.md b/docs/8.0/ayanova/docs/ay-start-login.md index 21c2d344..e4abe052 100644 --- a/docs/8.0/ayanova/docs/ay-start-login.md +++ b/docs/8.0/ayanova/docs/ay-start-login.md @@ -1,4 +1,4 @@ -# LOGIN +# Login The login form is displayed when you first open AyaNova or log out of AyaNova. @@ -10,5 +10,12 @@ If AyaNova is in trial mode for testing there will be a [trial user select list] At the bottom of the login form is a link to the AyaNova website displayed as the version and copyright information for the AyaNova app. +## Logout +Technically it is unnecessary to logout unless you need to re-login as another user however some cached data is cleared on logout. +Log out from the bottom of the Navigation bar menu. + +## Resetting cached data + +If you append the login url on your browser with `?reset` all local cached data will be reset. This should not be necessary but is provided for use when directed by technical support if we suspect local cached data might be corrupted causing an issue. diff --git a/docs/8.0/ayanova/docs/ay-start-trial-login.md b/docs/8.0/ayanova/docs/ay-start-trial-login.md index f94a7992..d23a2173 100644 --- a/docs/8.0/ayanova/docs/ay-start-trial-login.md +++ b/docs/8.0/ayanova/docs/ay-start-trial-login.md @@ -1,5 +1,9 @@ # Evaluate LOGIN FORM +[under construction] + +#b4beta (is this still needed? Does anythign link to it? Should it be covered by the evaluate page instead?) + first LINK TO MAIN EVALUATE DOCS second SAMPLE USERS AND SELECTION diff --git a/docs/8.0/ayanova/docs/ay-start-user-intro.md b/docs/8.0/ayanova/docs/ay-start-user-intro.md index fbaf817a..d2857674 100644 --- a/docs/8.0/ayanova/docs/ay-start-user-intro.md +++ b/docs/8.0/ayanova/docs/ay-start-user-intro.md @@ -2,6 +2,8 @@ How to use this help manual +#b4beta + ## Searching - one diff --git a/docs/8.0/ayanova/docs/ay-translation.md b/docs/8.0/ayanova/docs/ay-translation.md index 84e92538..04f89b72 100644 --- a/docs/8.0/ayanova/docs/ay-translation.md +++ b/docs/8.0/ayanova/docs/ay-translation.md @@ -1,4 +1,8 @@ -# TRANSLATION +# Translation + +[under construction] + +#b4beta (can this be consolidated? What links to here? Or should all translation go here? What is this, an overview only??) The Translation feature controls the text displayed in the AyaNova user interface. The primary purpose is to provide the AyaNova user interface in various languages however it is also used to customize text displayed to conform to specific terminology used by a business. diff --git a/docs/8.0/ayanova/docs/common-log.md b/docs/8.0/ayanova/docs/common-log.md index f84bb04d..f16b1150 100644 --- a/docs/8.0/ayanova/docs/common-log.md +++ b/docs/8.0/ayanova/docs/common-log.md @@ -52,4 +52,4 @@ or set the environment variable `AYANOVA_LOG_ENABLE_LOGGER_DIAGNOSTIC_LOG = true` -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. +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. diff --git a/docs/8.0/ayanova/docs/customers.md b/docs/8.0/ayanova/docs/customers.md index 52a13ec6..c8234701 100644 --- a/docs/8.0/ayanova/docs/customers.md +++ b/docs/8.0/ayanova/docs/customers.md @@ -2,5 +2,3 @@ [UNDER CONSTRUCTION] -todo: a standard link to general how to use the data-table at the top of every list help doc -todo: a standard link to how to use controls at the top of every form doc diff --git a/docs/8.0/ayanova/docs/home-notifications.md b/docs/8.0/ayanova/docs/home-notifications.md index 97ee0477..3321776b 100644 --- a/docs/8.0/ayanova/docs/home-notifications.md +++ b/docs/8.0/ayanova/docs/home-notifications.md @@ -1,6 +1,8 @@ # NOTIFICATIONS -[DOCUMENTATION UNDER CONSTRUCTION] +[under construction] + +#b4beta (complete this and add ss) This form shows "in app" notifications received in the last 90 days. Notifications are kept for 90 days then automatically deleted. diff --git a/docs/8.0/ayanova/docs/home-password.md b/docs/8.0/ayanova/docs/home-password.md index e4ef39a1..7fd94a61 100644 --- a/docs/8.0/ayanova/docs/home-password.md +++ b/docs/8.0/ayanova/docs/home-password.md @@ -9,19 +9,21 @@ You can click on the eye icon to conceal your entry from onlookers. ## What is a secure password? ### Long, not complicated -Current best practices around passwords are all about length. For the highest security ensure your password is as long as you can comfortably remember without writing it down. We recommend using a lengthy but easily remembered phrase as a password, for example a song lyric or a line from a poem that is 32 characters or more of words is difficult to hack by brute force methods. -There is no longer any security advantage in modern practice to using unusual symbols or numbers in your password and no need to do this with AyaNova. +Current security industry best practices around passwords focus entirely on length and not complexity. + +For the highest security ensure your password is as long as you can comfortably remember without writing it down. We recommend using a lengthy but easily remembered phrase as a password, for example a song lyric or a line from a poem that is 32 characters or more of words is currently very difficult to hack by brute force methods. + +There is no security advantage in modern practice to using mixed case, unusual symbols or numbers in your password. It is far more secure to have a lengthy password of plain text than it is to have a shorter one with a mix of numbers and characters. For example: this password `somewhereovertherainbowskiesareblue` is far more secure than this password `Ab3#@%5` and easier to remember without writing it down. - ### Impersonal + Make sure you have nothing personal in your password such as a relative or pet's name or relative's date of birth etc. ## Password manager + Many people prefer to use a password manager utility and AyaNova supports this by allowing copy and paste in the password field, clearly identifying it as a password field in the HTML markup and including an "eye" icon that you can use to reveal or conceal the password as you enter it. - - diff --git a/docs/8.0/ayanova/docs/home-reminders.md b/docs/8.0/ayanova/docs/home-reminders.md index 2503a3f1..3191aea0 100644 --- a/docs/8.0/ayanova/docs/home-reminders.md +++ b/docs/8.0/ayanova/docs/home-reminders.md @@ -1,3 +1,5 @@ # HOME-REMINDERS Placeholder [UNDER CONSTRUCTION] + +#b4beta \ No newline at end of file diff --git a/docs/8.0/ayanova/docs/home-reviews.md b/docs/8.0/ayanova/docs/home-reviews.md index 78c15843..a2bc0be2 100644 --- a/docs/8.0/ayanova/docs/home-reviews.md +++ b/docs/8.0/ayanova/docs/home-reviews.md @@ -1,7 +1,7 @@ # HOME-REVIEWS Placeholder [UNDER CONSTRUCTION] - +#b4beta notes: All users can see reviews assigned to them in their home menu Supervisory roles can see all reviews assigned to anyone diff --git a/docs/8.0/ayanova/docs/home-search.md b/docs/8.0/ayanova/docs/home-search.md index 0702467b..39807d8b 100644 --- a/docs/8.0/ayanova/docs/home-search.md +++ b/docs/8.0/ayanova/docs/home-search.md @@ -1,5 +1,9 @@ # HOME-SEARCH Placeholder +[under construction] + +#b4beta + ## Overview AyaNova has a search form available by selecting the Search option in the [context menu](ay-start-form-overview.md#form-context-menu) @@ -10,7 +14,7 @@ AyaNova has a search form available by selecting the Search option in the [conte By default AyaNova search is case **in**-sensitive. Case insensitive searching is influenced by the [server locale settings](ops-server-locale.md) - +0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 Explain search phrase entry, stopwords etc diff --git a/docs/8.0/ayanova/docs/home-tfa.md b/docs/8.0/ayanova/docs/home-tfa.md index 17106eee..583730b7 100644 --- a/docs/8.0/ayanova/docs/home-tfa.md +++ b/docs/8.0/ayanova/docs/home-tfa.md @@ -4,7 +4,6 @@ AyaNova supports Two-Factor authentication ("TFA") as an additional security measure for any User account. The first "factor" in TFA is the user name and password as normal, the second "factor" is a 6 digit passcode that changes every 30 seconds and is unique for every AyaNova User. Passcodes are generated in an App running on a device that you "link" to your AyaNova account via the. Enabling TFA means that even if a login name and password were to be accidentally exposed a malicious user would still not be able to login unless they had that User's device with their TFA authentication app available. We strongly recommend all users enable TFA, including and specifically the SuperUser account. - ## Enabling TFA Two-Factor Authentication is enabled from the "Two Factor Authentication" menu option in the form `Home -> User Settings` menu. diff --git a/docs/8.0/ayanova/docs/home-user-settings.md b/docs/8.0/ayanova/docs/home-user-settings.md index 6802dbec..7454cb07 100644 --- a/docs/8.0/ayanova/docs/home-user-settings.md +++ b/docs/8.0/ayanova/docs/home-user-settings.md @@ -3,26 +3,29 @@ This form controls various settings for the currently logged in User. ## Dark mode -This setting controls the alternative dark theme for UI display. Note that unlike the other settings on this page, this is a local device setting only to allow for different themes when working with different devices in different settings. + +This setting controls the alternative dark theme for UI display. Note that unlike the other settings on this page, this is a local device setting only to allow for different themes when working with different devices in different settings. ## Translation -This setting is *required* and controls which [translation](adm-translations.md) of AyaNova is used to display program text to the current logged in user. + +This setting is _required_ and controls which [translation](adm-translations.md) of AyaNova is used to display program text to the current logged in user. The default value is "en" for English. If you change the language setting here you must logout and back in for the changes to take effect. ## User email address + This is the email address used to send AyaNova related information to the user by the AyaNova [Notification system](ay-notification.md). This setting is not required (except for notifications if used) and the default value for this setting is empty. - ## Map URL template + This setting controls which mapping provider to use for viewing addressible objects online on a map. -If nothing is set it will default to Google maps. +If nothing is set it will default to Google maps. AyaNova supports either geographic coordinates (latitude, longitude) or address based online mapping support. -Several online mapping providers are provided for selection in the drop down box below this field. Selecting one of these providers will automatically fill in this field with the correct (at time of release) URL to use. +Several online mapping providers are provided for selection in the drop down box below this field. Selecting one of these providers will automatically fill in this field with the correct (at time of release) URL to use. You can also enter any url you wish in this field for specific needs not covered by the defaults. @@ -31,37 +34,40 @@ You can also enter any url you wish in this field for specific needs not covered AyaNova expects one or two url's per provider separated with the following special sequence of characters: `<|>` to separate urls if there are two. You can have an Address based url and / or a geocoordinate based url as most map providers support one or the other. -AyaNova will favor the geo-coordinate version if both are supplied. +AyaNova will favor the geo-coordinate version if both are supplied. AyaNova will substitute the following tokens in the URL template before attempting to open the map url in your browser: -`{ayaddress}` This token will be substituted with the Address fields favoring physical address fields over postal ones. The order the url is constructed from an address is Street address, city, region (state or province), country, postal code. If any of those fields are empty it will attempt to use the Postal version. +`{ayaddress}` This token will be substituted with the Address fields favoring physical address fields over postal ones. The order the url is constructed from an address is Street address, city, region (state or province), country, postal code. If any of those fields are empty it will attempt to use the Postal version. `{latitude}`, `{longitude}` These tokens will be used if filled in on the addressible objects entry form. Use the preset examples as a reference if making your own custom url. - ## Currency code + AyaNova is a single-currency program, it assumes all currency values entered are for the same currency and values entered are stored at the server as Decimal numbers so this setting will affect how values are displayed and accepted for entry only, it has no relation to actual currency values or exchange etc. -The Currency Code controls how currency values are displayed and accepted for input in AyaNova. The code must be one of the 3 character alphabetic [ISO 4217 active currency codes](https://wikipedia.org/wiki/ISO_4217#Active_codes) This value is *required* and cannot be determined from the Browser itself. If no setting is made the *default* value is "USD" for dollar symbol $. +The Currency Code controls how currency values are displayed and accepted for input in AyaNova. The code must be one of the 3 character alphabetic [ISO 4217 active currency codes](https://wikipedia.org/wiki/ISO_4217#Active_codes) This value is _required_ and cannot be determined from the Browser itself. If no setting is made the _default_ value is "USD" for dollar symbol $. Some other common currency codes are: "EUR" - Euro, "GBP" - Great British Pound, "CAD" - Canadian dollar, "AUD" - Australian dollar. ## 12 hour clock -This *optional* setting controls whether times are displayed and selected in 12 hour (AM/PM) format or 24 hour format. If not set it will be determined from the browser default language setting. + +This _optional_ setting controls whether times are displayed and selected in 12 hour (AM/PM) format or 24 hour format. If not set it will be determined from the browser default language setting. ## User browsers standard date time input controls -This *optional* setting switches between using the "Material" theme date and time picker controls or the browser's native input controls. This particular setting is *not* stored at the server but is kept with the browser itself allowing Users to choose browser by browser the most appropriate input controls for their needs as each browser brand and platform vary widely in their support for date and time inputs. + +This _optional_ setting switches between using the "Material" theme date and time picker controls or the browser's native input controls. This particular setting is _not_ stored at the server but is kept with the browser itself allowing Users to choose browser by browser the most appropriate input controls for their needs as each browser brand and platform vary widely in their support for date and time inputs. ## User color -This *optional* setting controls some aspects of AyaNova where multiple user's data is being displayed at once to make it easier to visually distinguish between users at a glance. + +This _optional_ setting controls some aspects of AyaNova where multiple user's data is being displayed at once to make it easier to visually distinguish between users at a glance. One example is the Schedule form when it is displaying schedules for more than one user. -The *default* value is black / transparent. +The _default_ value is black / transparent. ## Language code override / Time Zone override -Optional settings to override the values used by the web browser by default. These should not need to be set in most cases. -See [Localization override](ay-start-localization.md) for details. +Optional settings to override the values used by the web browser by default. These should not need to be set in most cases. +See [Localization override](ay-start-localization.md) for details. diff --git a/docs/8.0/ayanova/docs/index.md b/docs/8.0/ayanova/docs/index.md index 20561088..ac9344fe 100644 --- a/docs/8.0/ayanova/docs/index.md +++ b/docs/8.0/ayanova/docs/index.md @@ -1,14 +1,16 @@ # WELCOME TO AYANOVA -## About this documentation +This manual is accessible locally from the AyaNova software help links. + +We also maintain a copy of the latest version documentation on our website at [https://www.ayanova.com/docs/](https://www.ayanova.com/docs/) This manual has the following sections: -- [User guide](ay-start-user-intro.md) for using AyaNova +### [User guide](ay-start-user-intro.md) -- [Operations guide](ops-intro.md) AyaNova server installation and maintenance +### [Installing and maintaining AyaNova](ops-intro.md) -- [Software developers guide](api-intro.md) for interfacing with AyaNova +### [Software developers guide](api-intro.md) ## Beyond this manual diff --git a/docs/8.0/ayanova/mkdocs.yml b/docs/8.0/ayanova/mkdocs.yml index dc445ffa..7e693d18 100644 --- a/docs/8.0/ayanova/mkdocs.yml +++ b/docs/8.0/ayanova/mkdocs.yml @@ -20,7 +20,7 @@ nav: - 'Start here': 'ay-start-user-intro.md' - 'Changes from AyaNova 7': 'ay-start-changes-from-v7.md' - 'Trial mode login': 'ay-start-trial-login.md' - - Forms: + - User interface: - Introduction: - 'Overview': 'ay-start-form-overview.md' - 'Login': 'ay-start-login.md' @@ -110,7 +110,7 @@ nav: - 'Tags extension': 'ay-ex-tags.md' - 'Export extension': 'ay-ex-export.md' - 'Delete extension': 'ay-ex-delete.md' - - Customer User forms: + - Customer User interface: - 'Workorders': 'customer-workorders.md' - 'Customer service requests': 'customer-csr.md' - Features: @@ -125,6 +125,7 @@ nav: - Trying out AyaNova: - 'Evaluate': 'ay-evaluate.md' - Server operations guide: + - 'Introduction': 'ops-intro.md' - Installation: - 'Start': 'ops-install.md' - 'Windows': 'ops-install-windows.md' @@ -139,8 +140,7 @@ nav: - Backup & Restore: - 'Backup': 'ops-form-backup.md' - 'Restore': 'ops-restore.md' - - Forms: - - 'Introduction': 'ops-intro.md' + - Operations interface: - 'Server state': 'ops-server-state.md' - 'Backup': 'ops-form-backup.md' - 'Job queue': 'ops-jobs.md'