docs/8.0/customer/docs/ay-start-form-data-tables.md

@@ -0,0 +1,139 @@
+# Data tables
+
+Data tables are used to view, report, or open AyaNova business objects.
+
+Date, time and currency columns are displayed according to the web browser's default however they can be overriden in the [User settings form](home-user-settings.md).
+
+## Common menu options
+
+Most data tables in AyaNova share the same common menu options. Some of these options might not be available for _all_ forms depending upon the Roles assigned to the current User or the type of AyaNova business object being listed.
+
+#### Help
+
+The help menu item will open a specific help page from this manual related to the form being viewed.
+
+#### About AyaNova
+
+About menu option will open the `About` form which displays the version information and other information and links helpful for technical support and diagnostic / troubleshooting purposes.
+
+## Table header
+
+![data table header](img/form-data-table-header.png)
+
+The data table header area above the table itself from left to right contains the refresh button which fetches a fresh copy of the data table from the server and a [column selector](#column-selector) control to choose which columns are displayed and in which order.
+
+
+#### Column selector
+
+Use the column selector button ![data table column selector button](img/form-data-table-column-selector-button.png) to open the colum selector interface:
+
+![data table column selector](img/form-data-table-column-selector.png)
+
+Here you can select which columns will be included for display in the data table and the order they are displayed by moving them to the desired location and saving the form.
+
+There is a `reset to default` menu option to reset the selections back to their default locations and visibility.
+
+Some columns do not have an `include` checkbox option because they are the primary identifier for a record and need to be visible to be able to identify and open the record.
+
+Column settings are independent of filters.
+
+##### Filtered hidden columns indicator
+
+If a saved filter is selected and one or more of the columns being filtered are not selected to display the data table will indicate this by highlighting the column selector icon:
+
+![data table filter hidden column](img/form-data-table-filter-hidden-column.png)
+
+In this example the [column selector](#column-selector) is highlighted because there is a filter applied to the `Head Office` column which is not set to display.
+
+It is not necessary to display a hidden column, this highlighting is to indicate to the user that one or more hidden columns are being filtered.
+
+## Column headers
+
+![data table columns header](img/form-data-table-columns-header.png)
+
+Column headers not only display the name of that column but also provide controls to [filter](#filtering-columns) and [sort](#sorting-columns) the columns.
+
+Column header names are designed to wrap around in cases where they would not all fit horizontally to ensure as much data as possible can be displayed on all screen sizes.
+
+#### Sorting columns
+
+Columns are sorted by clicking on their names to toggle their sort mode betwen ascending, descending or unsorted. The column headers will display an arrow indicating the sort direction and a number indicating the order they were selected which affects the data returned:
+
+![data table sort](img/form-data-table-sort.png)
+
+In this example it can be seen that the data has been sorted by the Customer Name column _first_ in _ascending_ order indicated by the number 1 beside a downward pointing arrow sort indicator and then sorted by the work order column _secondarily_ in _descending_ order indicated by the number 2 beside an upward pointing arrow sort indicator.
+
+This results in a list ordered by customer name first from a to z then by work order number from highest to lowest.
+
+To remove a sort click on the column header name until the sort arrow indicator disappears.
+
+The column position does not affect the sort order.
+
+##### Sorting on Type fields
+
+Type fields can not be sorted in alphabetical order as they do not have a Name stored in the database, only a number. They sort by the underlying internal numerical value that indicates that particular type. This means you will see the column is sorted with identical types grouped together, however the displayed translated text representing these types is not sorted alphabetically.
+
+Type fields have square brackets around their translated display names, for example `[ Project ]`, in the column to indicate they are a type rather than a text field.
+
+#### Filtering columns
+
+Columns are filtered by clicking on their filter icon ![filter icon](img/form-data-table-filter-button.png).
+
+This will open the filter dialog where a filter can be set or edited:
+
+![filter example](img/form-data-table-filter-dialog-new.png)
+
+In the example above a new filter is being applied to the `Customer` column indicated in the name at the top. This filter will cause the data table to show only customers who have a Name that start with "J", "K" or "L".
+
+As seen in the example more than one filter can be applied in a single filter to include or exclude records and you can choose an `AND` type filter that returns only data that matches _all_ filters entered or an `OR` type filter that will return data that matches _any_ of the items in the filter list.
+
+Filters are created by first selecting a type of filter from the "Filter" selection list. The types of filters offered vary depending upon the type of data in that particular column.
+
+Some filters require a Value to be entered and others do not. If the filter requires a value one or more controls will appear below the filter selection and a value must be entered for that type of filter.
+
+For example a date based column filter has pre-selected date ranges available such as "Last year" and those do not require a value, however you can also select a Before filter which does require a date to be entered.
+
+Once your filter selection is made click on the `+` add button to make it official. If you click on `save` before clicking on `+` add the filter will _not_ include your selection.
+
+To remove a filter from a column or edit it click on the column filter icon again and either remove or adjust the items in the filter or select delete to remove them entirely.
+
+
+
+##### Filtering dates and time zones
+
+When viewing data in AyaNova that is filtered with one of the relative date filters (for example a filter of "TODAY"), the User's local time zone setting is taken into account in order to ensure that the user sees data appropriate to _their time zone_.
+
+This means that two people with browsers in different time zones using a filter of TODAY for a date field may see different lists of results from each other.
+
+
+
+###### Equality
+
+Will match when exactly the same tags in search are present (in any order) in the record and no other tags.
+
+For example an Equals tag filter with {red,green,blue} will return records with tags {green,red,blue} but _not_ match {red,green,blue,orange}
+
+###### Not equal
+
+The opposite of Equality; specifically exclude rows that exactly match all the search terms
+For example a Not equal filter with {red,green,blue} will return records with tags {red,green,blue,orange} but _not_ match {green,red,blue}
+
+###### NO value
+
+Will return records with no tags set at all.
+
+###### Has value
+
+Will return records with any tag set.
+
+###### Contains
+
+Returns records that contain the specified search tags. Records may have other additional tags but that's ok as long as it has the search term ones.
+
+For example a contains filter for tags {red,green,blue} will return records with tags {green,red,blue} and also {red,green,blue,orange}
+
+###### Not contains
+
+All tags in search query _NOT_ present in db record, doesn't care what else is in db record as long as it's not the search terms (in any order).
+
+For example a Not contains filter for tags {red,green,blue} will not return records with tags {green,red,blue} and also not return {red,green,blue,orange} but would return {red,green,black}

docs/8.0/customer/docs/customer-csr.md

@@ -1,2 +1,9 @@
 # Service requests
 
+When you first log into AyaNova via the URL provided from your service company, you will see a table that lists all service requests you have made so far sorted in descending order by the date the service request was created.
+
+![customer csr data tabe](img/cust-csr-data-table.png)
+
+If you want to sort by a different column, and/or filter to show only service requests that meet a certain criteria, refer to Filtering & Sorting for details on how to filter this Service Request table and/or the Workorders table.
+
+ 

docs/8.0/customer/docs/home-tfa.md

@@ -0,0 +1,42 @@
+# Two-factor authentication
+
+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 one-time passcode that changes every 30 seconds and is unique for every AyaNova User.
+
+Passcodes are generated in a 3rd party TFA App running on a device that you "link" to your AyaNova account. Typically this means a TFA app running on an Android or Apple iOS device.
+
+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.
+
+If AyaNova can be accessed outside a private network, we **strongly** recommend all users enable TFA, in particular the SuperUser account and any User accounts with Business Administration roles.
+
+## Authorization Roles required
+
+This form is available to all users regardless of role.
+
+## How to access Two factor authentication
+
+TFA settings are accessed from the [User settings](home-user-settings.md#two-factor-authentication) two factor authentication menu item.
+
+## Enabling TFA
+
+Two-Factor Authentication is enabled from the "Two Factor Authentication" menu option in the form `Home -> User Settings` menu.
+
+Due to the nature of TFA it is not possible for an Administrator to set this up on behalf of a User, it must be done logged in _as_ the User account with their device containing their TFA authentication App at hand.
+
+## Disabling TFA
+
+Two-Factor Authentication is disabled by the user from the "Two Factor Authentication" menu option in the form `Home -> User Settings` menu.
+A User with rights to edit other User accounts can disable TFA for any User from the `Adminstration -> User` edit form's menu.
+
+## TFA Apps
+
+There are many Two-Factor Authentication apps freely available for all device types and AyaNova uses an open standard so any legitimate TFA app should work with AyaNova.
+
+Here are some TFA applications that have been tested with AyaNova specfically:
+
+- [DUO](https://duo.com/product/multi-factor-authentication-mfa/duo-mobile-app)
+- [Google Authenticator for iOS](https://apps.apple.com/us/app/google-authenticator/id388497605)
+- [Google Authenticator for Android](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2)
+- [Microsoft Authenticator (iOS / Android)](https://www.microsoft.com/en-us/account/authenticator)
+- [Authy](https://authy.com/)
+
+These apps are all legitimate and widely used, however there are known cases of other malicious TFA applications so be careful and do some research if using one not on the list above.

docs/8.0/customer/docs/home-user-settings.md

@@ -0,0 +1,109 @@
+# User settings
+
+This form controls various settings for the currently logged in User and is available to all users.
+
+Administrators can also modify these settings on behalf of a User in the [User administration form](adm-users.md).
+
+## Authorization Roles required
+
+This form is available to all users regardless of role.
+
+## How to access user settings
+
+User settings are accessed in the following ways:
+
+- From the `Home` navigation pane `User settings` item
+
+## Edit form
+
+#### Dark mode
+
+![dark mode](img/home-user-settings-darkmode.png)
+![dark mode](img/home-user-settings-lightmode.png)
+
+This setting is a toggle that switches between the standard light and alternative dark theme for UI display.
+
+This is a local device setting only (not saved to the server) 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.
+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
+
+Optional setting for both reference purposes and also to save typing by being the default email address set in any new [Notification subscriptions](home-notify-subscriptions.md) created by this user.
+
+#### Map URL template
+
+This setting controls which internet mapping provider to use for viewing addressible objects online on a map.
+
+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 template to use.
+
+You can also enter any url you wish in this field for specific needs not covered by the defaults.
+
+##### Map url format
+
+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 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.
+
+`{latitude}`, `{longitude}` These tokens will be used if filled in on the addressible object's 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 $.
+
+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.
+
+#### Use browsers standard date time input controls
+
+This _optional_ setting switches between using the fixed "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.
+
+#### Override browser Language code
+
+Optional settings to override the Language code used by the web browser by default. This should not need to be set in most cases.
+See [Localization override](ay-start-localization.md) for details.
+
+#### Override browser Time Zone
+
+Optional settings to override the Time zone from the devices default setting used by the web browser by default. This should not need to be set in most cases.
+See [Localization override](ay-start-localization.md) for details.
+
+#### User color
+
+This setting is used to define a unique color for this User which is currently used on chart type dashboard widgets that have multiple User's data displayed at once.
+
+### Menu options
+
+In addition to the [common edit form menu options](ay-start-edit-forms.md#common-edit-form-menu-options) the User settings edit form also has these options:
+
+#### Set login password
+
+Opens the [change password form](home-password.md) to allow the user to change their own password.
+
+#### Two Factor Authentication
+
+Opens the [Two factor authentication form](home-tfa.md) to allow the user to set up two factor authentication for the strongest possible login security.
+
+We strongly recommend the use of two factor authentication if AyaNova will be accessible from the internet, particularly for any higher security roles such as the SuperUser or Business Administration roles.