@@ -455,7 +455,7 @@ todo:3 todo: check out this SPA memory leak detector, it *does* have a login abi
|
||||
|
||||
|
||||
|
||||
|
||||
todo: 2 the Customize form for User edit form is showing the Required checkbox for the last login field, sb marked not requireable
|
||||
|
||||
todo: 2 Make the eye icons for showing passwords *not* be a tab stop so that user can tab through fields without getting stuck on them
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Authorization roles
|
||||
|
||||

|
||||
|
||||
Authorization roles are used to control access to AyaNova business objects and features. Roles roughly follow typical job descriptions for various departments in a service company.
|
||||
|
||||
There are a total of 17 roles available, 9 major roles and 8 'restricted' versions of most of the major roles which generally means read-only access to features and objects where the main role has full read/write access.
|
||||
@@ -8,7 +10,7 @@ For example a "Business administration" role can edit report templates but a "Bu
|
||||
|
||||
This is useful to allow junior members of staff the ability to help other users in other departments by being able to look up information but not entrusted yet to change that information.
|
||||
|
||||
Roles can be layered, in other words you can add multiple roles to a single User account to grant access to multiple areas of AyaNova.
|
||||
Roles can be layered, in other words you can add multiple roles to a single User account to grant access to multiple areas of AyaNova.
|
||||
|
||||
When there are multiple roles the effective rights are those of all the _greatest_ (least restrictive) rights available to each role. In other words granting a restricted role to a user doesn't take away any greater rights that come from another Role granted.
|
||||
|
||||
@@ -26,7 +28,9 @@ The AyaNova super user account has all roles (except Customer roles) by default
|
||||
|
||||
### Accounting
|
||||
|
||||
This role is intended for a person responsible for typical Accounting processes in AyaNova such as setting rates, tax codes and contracts as well as integrating AyaNova with external accounting software. There is no restricted version of this role.
|
||||
This role is intended for a person responsible for typical Accounting processes in AyaNova such as setting rates, tax codes and contracts as well as integrating AyaNova with external accounting software such as [QuickBooks](https://ayanova.com/r/qbi/docs/).
|
||||
|
||||
There is no restricted version of this role.
|
||||
|
||||
Accounting role can view costs and prices of any object in AyaNova.
|
||||
|
||||
@@ -36,13 +40,13 @@ The Accounting role has access to the `Accounting` [navigation drawer](ay-start-
|
||||
|
||||
### Business administration
|
||||
|
||||
This is the most powerful role and has access to all areas of AyaNova and all objects with the sole exception of some of the more dangerous options available to the `Server operations` role.
|
||||
This is the most powerful role and has access to all areas of AyaNova and all objects with the sole exception of some of the more dangerous options available to the `Server operations` role.
|
||||
|
||||
This role is appropriate for senior level administration who are interested in making changes in AyaNova including creating other Users and granting their Roles.
|
||||
|
||||
This role has access to the `Administration` [navigation drawer](ay-start-form-overview.md#navigation-drawer) options.
|
||||
|
||||
This is an appropriate role for a User responsible for setting up critical *business* settings in AyaNova that affect all users such as [Global settings](adm-global-settings.md), and various customization features which affect all users.
|
||||
This is an appropriate role for a User responsible for setting up critical _business_ settings in AyaNova that affect all users such as [Global settings](adm-global-settings.md), and various customization features which affect all users.
|
||||
|
||||
`Business administration - restricted` this role has read-only rights to the same data as the full `Business administration` role and is more appropriate for a senior level administrator who needs to _view_ information in all areas of AyaNova but isn't involved in making changes to any data in AyaNova.
|
||||
|
||||
@@ -56,15 +60,15 @@ Customers with the Customer role are potentially able to use the Customer featur
|
||||
|
||||
### Head office
|
||||
|
||||
This role is intended to be used by a Customer type user who is responsible for multiple other Customers.
|
||||
This role is intended to be used by a Customer type user who is responsible for multiple other Customers.
|
||||
|
||||
In most ways it's identical to a Customer role but has the ability to view workorders, create and view service requests for *any* Customer in AyaNova that shares the same Head Office as this User.
|
||||
In most ways it's identical to a Customer role but has the ability to view workorders, create and view service requests for _any_ Customer in AyaNova that shares the same Head Office as this User.
|
||||
|
||||
There is no restricted version of this role.
|
||||
|
||||
### Inventory
|
||||
|
||||
This role has full access to all items in the Inventory [navigation drawer](ay-start-form-overview.md#navigation-drawer) as well as the Vendors [navigation drawer](ay-start-form-overview.md#navigation-drawer) item.
|
||||
This role has full access to all items in the Inventory [navigation drawer](ay-start-form-overview.md#navigation-drawer) as well as the Vendors [navigation drawer](ay-start-form-overview.md#navigation-drawer) item.
|
||||
|
||||
Inventory role does _not_ have access to any items in the Service, Accounting, Administration or Operations [navigation drawer](ay-start-form-overview.md#navigation-drawer) areas.
|
||||
|
||||
@@ -88,13 +92,13 @@ This user can also view Costs for rates and parts.
|
||||
|
||||
### Service technician
|
||||
|
||||
This role is for service technicians that are employees of the service company. Technicians can view all items in the `Customer` [navigation drawer](ay-start-form-overview.md#navigation-drawer) but not edit them.
|
||||
This role is for service technicians that are employees of the service company. Technicians can view all items in the `Customer` [navigation drawer](ay-start-form-overview.md#navigation-drawer) but not edit them.
|
||||
|
||||
In the `Service` pane they have full read-write access to all areas of Service work orders with the exception of any Cost fields as well as full access to Customer Units, however they do not see any Quotes or Preventive Maintenance orders and have read-only access to Customer Service Requests, Loaner items and Projects.
|
||||
|
||||
They are also permitted to view read-only `Vendors` and `Accounting` [navigation drawer](ay-start-form-overview.md#navigation-drawer) items.
|
||||
|
||||
`Service technician - restricted` - this role is appropriate for less trusted, probationary or new staff service technicians and allows a User to perform service with the lowest possible access to any unrelated data to their job.
|
||||
`Service technician - restricted` - this role is appropriate for less trusted, probationary or new staff service technicians and allows a User to perform service with the lowest possible access to any unrelated data to their job.
|
||||
|
||||
They can be scheduled on work orders and view their own schedule only from their `Home -> Schedule` [navigation drawer](ay-start-form-overview.md#navigation-drawer) as well as enter the labor, travel or expenses of work they perform only on a work order's item where they are one of the scheduled users.
|
||||
|
||||
|
||||
@@ -1,16 +1,18 @@
|
||||
# Customize form
|
||||
|
||||
The Customize form is provided to show or hide unused form fields on an edit form and also to set individual fields to require data be entered in them.
|
||||

|
||||
|
||||
The Customize form is provided to show or hide unused form fields on an edit form and also to set individual fields to **required** entry.
|
||||
|
||||
Custom fields can also be enabled here to provide additional data entry fields unique to your business.
|
||||
|
||||
## Authorization Roles required
|
||||
|
||||
Many roles can *select* this object on other records where approriate. Editing or viewing this object in detail is only available to Users with the following [roles](ay-biz-admin-roles.md):
|
||||
Many roles can _select_ this object on other records where approriate. Editing or viewing this object in detail is only available to Users with the following [roles](ay-biz-admin-roles.md):
|
||||
|
||||
Full access
|
||||
|
||||
- Business administration
|
||||
- Business administration
|
||||
|
||||
Read only access
|
||||
|
||||
@@ -50,9 +52,9 @@ Address fields in work orders and quotes that are set to required will check the
|
||||
|
||||
Some fields by their nature can't be set to required and will not display a Required checkbox:
|
||||
|
||||
- many fields are already required internally by AyaNova such as a Customer Name and many numeric / currency fields which are not optional
|
||||
- some control types such as checkboxes don't support the concept of no entry due to having only two states
|
||||
- logistics reasons apply to other controls such as signature controls on work orders which logically can't be signed until the work is completed
|
||||
- many fields are already required internally by AyaNova such as a Customer Name and many numeric / currency fields which are not optional
|
||||
- some control types such as checkboxes don't support the concept of no entry due to having only two states
|
||||
- logistics reasons apply to other controls such as signature controls on work orders which logically can't be signed until the work is completed
|
||||
|
||||
### Custom fields
|
||||
|
||||
@@ -67,14 +69,14 @@ There are three steps to enabling a Custom field:
|
||||
1. make the custom field visible
|
||||
2. choose the data type that will be tracked in this field. There are 8 choices available and they will show on the form as:
|
||||
|
||||
- `Date / Time` date _and_ time picker control
|
||||
- `Date` date only picker control
|
||||
- `Time` time only picker control
|
||||
- `Text` multiline text box for small or large amounts of text (Unicode and Emojis 🌡️ supported as with all AyaNova text fields)
|
||||
- `True / False` checkbox control
|
||||
- `Integer` integer whole number input control, no fractions
|
||||
- `Decimal` decimal number input control, fractional
|
||||
- `Money` currency control with currency symbol
|
||||
- `Date / Time` date _and_ time picker control
|
||||
- `Date` date only picker control
|
||||
- `Time` time only picker control
|
||||
- `Text` multiline text box for small or large amounts of text (Unicode and Emojis 🌡️ supported as with all AyaNova text fields)
|
||||
- `True / False` checkbox control
|
||||
- `Integer` integer whole number input control, no fractions
|
||||
- `Decimal` decimal number input control, fractional
|
||||
- `Money` currency control with currency symbol
|
||||
|
||||
3. Change the User's translation(s) to show the desired title above the control: Make a note of the translation key for the custom field. It will be shown just beneath the current translation for that field, for example "Custom5" in the Customer form has an internal translation key of "CustomerCustom5". Save your changes here and then use the translation key to [find and edit the translation](adm-translations.md) so that the desired title shows with the Custom field. There is a _Translation_ menu item on the Customize form to save a click.
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Trying out AyaNova
|
||||
|
||||

|
||||
|
||||
## Install AyaNova first
|
||||
|
||||
If you are trying out AyaNova the first step is to [install AyaNova](ops-install.md).
|
||||
@@ -38,9 +40,11 @@ After you have [installed AyaNova](ops-install.md) and [requested an evaluation
|
||||
|
||||
The _Generate sample data_ button in the evaluate page opens a dialog to select the quantity of sample data you wish to generate and set the time zone desired for the sample data to be generated within and optionally set _every_ generated object with an email address to the same specific address for testing notification features.
|
||||
|
||||
Note that sample data is randomly generated each time so all names and addresses are purely random and not intended to reflect any real world objects, people or places.
|
||||
|
||||
### Database will be erased
|
||||
|
||||
Seeding will trigger erasure of **all** data in AyaNova in order to return it to a clean state with the following exceptions.
|
||||
Seeding will trigger erasure of all data in AyaNova in order to return it to a clean state with the following exceptions.
|
||||
|
||||
- Global settings
|
||||
- Operations backup settings
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Delete extension
|
||||
|
||||

|
||||
|
||||
The Delete extension can be used to permanently delete multiple items at once.
|
||||
|
||||
It operates in the exact same way as deleting an object from it's edit form but in bulk so if an object could not be deleted in it's edit form due to rights or links to other objects, it will not delete here either.
|
||||
@@ -14,7 +16,7 @@ The delete extension is accessed from the [extensions](ay-extensions.md) menu it
|
||||
|
||||
## How the Delete extension works
|
||||
|
||||
AyaNova will attempt to delete all selected items and will indicate the number of any records that were not able to be deleted.
|
||||
AyaNova will attempt to delete all selected items and will indicate the number of any records that were not able to be deleted.
|
||||
|
||||
If an item is linked to another item it may not be able to be deleted, for example attempting to delete a Customer with Work orders.
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Export extension
|
||||
|
||||

|
||||
|
||||
The Export [extension](ay-extensions.md) can be used to export selected records from AyaNova.
|
||||
|
||||
## Authorization Roles required
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Tags extension
|
||||
|
||||

|
||||
|
||||
The Tags extension can be used to make batch changes to selected item's Tags collection.
|
||||
|
||||
## Authorization Roles required
|
||||
|
||||
@@ -1,10 +1,14 @@
|
||||
# Extensions
|
||||
|
||||

|
||||
|
||||
Extensions provide a way to perform a bulk operation over multiple business objects at once, for example mass deleting selected objects or tagging them.
|
||||
|
||||
## Authorization Roles required
|
||||
|
||||
Extensions require the same rights as would be required to perform the operation manually that the extension automates. For example, if an extension is used to delete records in bulk the User must have the right to delete a single record manually.
|
||||
Extensions require the same rights to make bulk changes on multiple objects as would be required to perform the same operation on a single record of that type of object.
|
||||
|
||||
For example, if an extension is used to delete Customer records in bulk the User must have the right to delete a single Customer record from the Customer edit form.
|
||||
|
||||
## How to access Extensions
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Web app diagnostic log
|
||||
|
||||

|
||||
|
||||
The web app diagnostic log shows events such as errors that occur during use of the AyaNova web app.
|
||||
|
||||
This log can be useful for troubleshooting purposes.
|
||||
@@ -22,6 +24,6 @@ When you see an error displayed in AyaNova chances are it was also logged here s
|
||||
|
||||
## Gathering information for technical support
|
||||
|
||||
The log display is intended for reading only, if you need to send the log or save it for later, the [About form's](ay-about.md) "Copy support information" menu option will automatically copy the log contents as well as some diagnostic information about the current browser in use and other information potentially useful when requesting support.
|
||||
The log display is intended for reading only, if you need to send the log or save it for later, the [About form's](ay-about.md) "Copy support information" menu option will automatically copy the log contents as well as some comprehensive diagnostic information about the current browser in use and other information potentially useful when requesting support.
|
||||
|
||||
Because the log only retains the most recent 100 items, it is sometimes necessary to recreate an error before copying the log to send to technical support as the error could have dropped off the log if many other items were logged since the error first appeared.
|
||||
Because the log only retains the most recent 100 items, it is sometimes necessary to recreate an error before copying the log to send to technical support as the error could have been rotated off the log if many other items were logged since the error first appeared.
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
# Autocomplete lists
|
||||
|
||||
Autocomplete lists are used to search for and select a business object on forms.
|
||||

|
||||
|
||||
Autocomplete lists are used to search for and select a related business object on forms.
|
||||
|
||||
For example a Part on a Workorder form.
|
||||
|
||||
@@ -32,11 +34,11 @@ If a search is invalid the control will show an error message with a help link t
|
||||
|
||||
By default the Name field (or other primary identifier) is always present and searchable but other fields can be added for selection and searching via template.
|
||||
|
||||
Tags will only *display* if added to the template but you can *always* search for them displayed or not.
|
||||
Tags will only _display_ if added to the template but you can _always_ search for them displayed or not.
|
||||
|
||||
### Case sensitivity
|
||||
|
||||
By default AyaNova searches are case **in**-sensitive. This can be changed in the [Global settings form's](adm-global-settings.md#filtering-is-case-sensitive) *Filtering is case sensitive* checkbox. Setting this to checkmarked (true) means that all searches will be treated as case sensitive so for example searching a list for "group" will NOT match to "Group".
|
||||
By default AyaNova searches are case **in**-sensitive. This can be changed in the [Global settings form's](adm-global-settings.md#filtering-is-case-sensitive) _Filtering is case sensitive_ checkbox. Setting this to checkmarked (true) means that all searches will be treated as case sensitive so for example searching a list for "group" will NOT match to "Group".
|
||||
|
||||
### Search by text
|
||||
|
||||
@@ -49,7 +51,7 @@ By default searches are _not_ case sensitive however that can be adjusted via [G
|
||||
|
||||
Searching, sort order and case sensitivity are affected by your [Server locale setting](ops-server-locale.md)
|
||||
|
||||
For example if you want to quickly select a Customer named "Paul's Perogies" you could type `pau` and up to 100 of the Customers with "pau" anywhere in their autocomplete list template would be returned for selection.
|
||||
For example if you want to quickly select a Customer named "Paul's Perogies" you could type `pau` and up to 100 of the Customers with "pau" anywhere in their autocomplete list template would be returned for selection.
|
||||
|
||||
You could also type `per` which would also match to "Paul's Perogies" and any other Customers with "per" anywhere in their template.
|
||||
|
||||
@@ -67,7 +69,7 @@ You can also search by tag and by text combined, for example entering 'aul ..sid
|
||||
|
||||
### Item not appearing in results?
|
||||
|
||||
Inactive records are not valid for selection in many forms so if you are searching for a business object that has been deactivated by un-checking it's *Active* field to set it to false it will not appear in your results on most forms by default.
|
||||
Inactive records are not valid for selection in many forms so if you are searching for a business object that has been deactivated by un-checking it's _Active_ field to set it to false it will not appear in your results on most forms by default.
|
||||
|
||||
### Opening selected record
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Wiki
|
||||
|
||||
Wiki is a feature that allows AyaNova users to freely create and edit rich documentation for most AyaNova business objects.
|
||||
Wiki is a feature that allows AyaNova users to freely create and edit rich documentation for most AyaNova business objects.
|
||||
|
||||
There is no specific way to use the wiki feature it can be used for anything that is useful to your business.
|
||||
|
||||
@@ -137,12 +137,6 @@ A more detailed Markdown guide is available here: [www.markdownguide.org](https:
|
||||
|
||||
<br>
|
||||
|
||||
## Markdown and Wiki documents
|
||||
|
||||
Wiki's are formatted using **[Markdown](https://en.wikipedia.org/wiki/Markdown)** a plain text formatting language.
|
||||
This document is a quick reference guide and at the bottom is a link to a more comprehensive guide online.
|
||||
You can also use the formatting toolbar above to perform the same tasks.
|
||||
|
||||
# Headings
|
||||
|
||||
# Heading 1st level
|
||||
@@ -182,9 +176,9 @@ _Italic_
|
||||
|
||||
### Unordered list
|
||||
|
||||
- List
|
||||
- List
|
||||
- List
|
||||
- List
|
||||
- List
|
||||
- List
|
||||
|
||||
### Ordered list
|
||||
|
||||
@@ -202,12 +196,12 @@ Ordered lists don't need the numbers to be in order, just that they start with 1
|
||||
|
||||
### Nested lists
|
||||
|
||||
- First
|
||||
- subitem One
|
||||
- subitem Two
|
||||
- Second
|
||||
1. sub one
|
||||
2. sub two
|
||||
- First
|
||||
- subitem One
|
||||
- subitem Two
|
||||
- Second
|
||||
1. sub one
|
||||
2. sub two
|
||||
|
||||
# Blank lines
|
||||
|
||||
@@ -232,8 +226,8 @@ print 'indent 4 spaces'
|
||||
|
||||
# Task lists
|
||||
|
||||
- [ ] task one
|
||||
- [x] task two (completed)
|
||||
- [ ] task one
|
||||
- [x] task two (completed)
|
||||
|
||||
# TABLES
|
||||
|
||||
@@ -251,7 +245,7 @@ Link to [our website](https://ayanova.com ""Hover text tooltip"") example
|
||||
If you don't need an inline link you can simply enter it in angle brackets:
|
||||
<https://ayanova.com>
|
||||
Even email links work:
|
||||
<support@ayanova.com>
|
||||
[support@ayanova.com](mailto:support@ayanova.com)
|
||||
<br>
|
||||
You can also use emphasis characters with links:
|
||||
Link to **[our website](https://ayanova.com)** example
|
||||
@@ -271,4 +265,3 @@ Emoji characters are supported:
|
||||
<br>
|
||||
|
||||
---
|
||||
|
||||
|
||||
BIN
docs/8.0/ayanova/docs/img/ay-biz-admin-roles.png
Normal file
|
After Width: | Height: | Size: 24 KiB |
BIN
docs/8.0/ayanova/docs/img/ay-customize.png
Normal file
|
After Width: | Height: | Size: 56 KiB |
BIN
docs/8.0/ayanova/docs/img/ay-evaluate.png
Normal file
|
After Width: | Height: | Size: 25 KiB |
BIN
docs/8.0/ayanova/docs/img/ay-ex-delete.png
Normal file
|
After Width: | Height: | Size: 71 KiB |
BIN
docs/8.0/ayanova/docs/img/ay-ex-export.png
Normal file
|
After Width: | Height: | Size: 72 KiB |
BIN
docs/8.0/ayanova/docs/img/ay-ex-tags.png
Normal file
|
After Width: | Height: | Size: 53 KiB |
BIN
docs/8.0/ayanova/docs/img/ay-extensions.png
Normal file
|
After Width: | Height: | Size: 71 KiB |
BIN
docs/8.0/ayanova/docs/img/ay-log.png
Normal file
|
After Width: | Height: | Size: 76 KiB |
BIN
docs/8.0/ayanova/docs/img/ay-start-form-autocompleted.png
Normal file
|
After Width: | Height: | Size: 20 KiB |