This commit is contained in:
2022-01-14 21:23:14 +00:00
parent 9d8a603516
commit 76e0aca6d1
9 changed files with 201 additions and 24 deletions

View File

@@ -16,7 +16,7 @@ Read only access
## How to access Seed numbers
From the `Administration` navigation pane [Global settings form](adm-global-settings.md) click on the `Set next seed number` button.
From the `Administration` navigation pane [Global settings form](adm-global-settings.md) in the `Business` section of the form click on the `Set next seed number` button.
## How seed numbers work

View File

@@ -1,8 +1,55 @@
# SELECT LIST TEMPLATES
# Select list templates
This form is used to set the fields displayed and searched in select lists on forms.
This form is used to set which fields of an AyaNova object are displayed and [searchable](ay-start-form-select-list.md#filtering-searching) in [select lists](ay-start-form-select-list.md) on [forms](ay-start-form-overview.md).
#b4beta
In most cases when users of AyaNova need to select from a list of AyaNova objects on a form they will be looking at the "Name" field however in many cases there are other fields that are equally important. For example when looking for a particular [part](inv-parts.md) to select on a [work order](svc-workorders.md) it may be helpful to be able to find the part by not only the part name but also by the part manufacturer or supplier number or other fields.
[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.
AyaNova lets you choose the fields that are most appropriate for _your_ business.
## Authorization Roles required
This form is available to User's with the following [roles](ay-biz-admin-roles.md):
Full access
- Business administration
Read only access
- Business administration - restricted
## How to access Select list templates
From the `Administration` navigation pane [Global settings form](adm-global-settings.md) in the `User interface` section of the form click on the `Select list templates` button.
In the select list template form at the top is a list of AyaNova objects that have select lists that can be templated and selecting an object will open it's template for editing.
## How select list templates work
### templates are shared by all users
Select list templates are a global setting that affects all users, there is no way to specify a unique template per user.
### templates do not control _display_
Select lists templates are used for **selection** purposes only, not general display purposes. In other words when you need to select a part you will likely require more fields to help make the selection than you typically want to see when viewing an object with that part selected.
For most objects, the `Name` field will be the **primary identifier** used to display an object as it's required to be unique and it's the value that is displayed most often in the user interface and on reports.
### example
Let's use the [part](inv-parts.md) object as an example. By default the part select list template will have (in order left to right) the `Name`, `Manufacturer` and `Tags` fields of a part selected to include in a part select list:
![example select list template parts](img/form-select-list-template-example-part.png)
In the image above you can see the selected fields as well as other fields available. The order displayed can be changed by using the ordering arrow controls under each field to move it to the desired location.
In this example the `Name` field is mandatory and will always be checked as it's the primary identifier for this object, however you can move it to any location desired.
When the user needs to select a part the default list will look similar to this:
![example select list parts](img/form-select-list-example-part.png)
In the image above the part name is on the far left, the manufacturer in the center and the tags set on that part to the right.
All fields displayed are searchable so in this case the user can search by part name, manufacturer name or by tags.
If, for example you don't need the `tags` or `manufacturer` fields but _do_ want the part's `UPC` code field you would un-check the tags and manufacturer and check the UPC field. After saving that template all users will see name and UPC and be able to search for parts by either field.

View File

@@ -16,6 +16,10 @@ Read only access
- Business administration - restricted
## How to access Global settings
From the `Administration` navigation pane select the `Global settings` navigation item.
## Business settings
### Default parts purchase tax
@@ -61,7 +65,7 @@ Enter your company contact information here. The stock AyaNova [report templates
### Business logos
This button will take you to the business logo upload form where you can upload various sized logos.
This button will take you to the [business logo form](adm-global-logo.md) where you can upload various sized logos.
Logos are displayed on login forms and the stock AyaNova [report templates](ay-report-edit.md) if set.
You do not _need_ to upload a logo however it's strongly recommended if you are going to give your Customers access to AyaNova so they are confident they are in the right place.
@@ -77,7 +81,7 @@ The small logo is the most commonly used on reports and the small and medium are
### Select list templates
Searchable [select lists](ay-start-form-select-list.md) are used throughout AyaNova for areas where you need to select another AyaNova object on a form, for example selecting a Customer on a Work order or a Part on a Purchase Order. This button will take you to the select list templates form where you can configure what information is displayed in select lists for each object type depending upon your specific requirements. The templates allow you to control which fields from the source object are displayed and searched in that type of objects selection lists.
Searchable [select lists](ay-start-form-select-list.md) are used throughout AyaNova for areas where you need to select another AyaNova object on a form, for example selecting a Customer on a Work order or a Part on a Purchase Order. This button will take you to the [select list templates form](adm-global-select-templates.md) where you can configure what information is displayed in select lists for each object type depending upon your specific requirements. The templates allow you to control which fields from the source object are displayed and searched in that type of objects selection lists.
Note that this setting affects select lists only for searching and identification purposes, not how names of objects are displayed generally in AyaNova forms or on reports. These templates are for the Users to help them more quickly select objects.

View File

@@ -1,3 +1,47 @@
# ADM-HISTORY Placeholder
# Global history
[UNDER CONSTRUCTION]
The global history form is an event log that shows important events that took place in AyaNova including User activity. While not a formal audit log, it does provide detailed information to help track down and resolve any unusual issues that might arise related to usage of AyaNova.
## Authorization Roles required
This form is available to User's with the following [roles](ay-biz-admin-roles.md):
Full access
- Business administration
Read only access
- Business administration - restricted
## How to access global history
From the `Administration` navigation pane select `History` navigation item.
## How global history works
When an important event takes place in AyaNova, the server logs it to the database. This includes any modifications to business objects tracked in AyaNova as well as some other key events.
### business object events
Most events are related to changes to **"business objects"** in AyaNova, that is objects that are related to the business like a Customer or Work order, not the internal workings of AyaNova such as a select list or form template.
### data that is tracked
AyaNova tracks the timestamp of the event, the type of event, the type of business object and it's id if the event is related to a particular business object and the User who triggered the event. This makes it possible to
### events that are tracked
- `Business object created`: user created and saved a new business object
- `Business object updated`: user modified and saved an existing business object
- `Business object retrieved`: user has opened the edit form for a business object
- `Business object deleted`: user has created a new business object
- `Attachment created`: user has [attached](ay-start-form-attachments.md) a file to a business object
- `Attachment retrieved`: user has downloaded a file [attached](ay-start-form-attachments.md) to a business object
- `Attachment modified`: user has modified the descriptive notes or name of a file [attached](ay-start-form-attachments.md) to a business object
- `Attachment deleted`: user has removed an [attached](ay-start-form-attachments.md) file from a business object
- `License updated`: AyaNova has installed a new replacement license key
- `Server state change`: AyaNova server has been put into an [alternative state](ops-server-state.md)
- `Seed database`: user has requested that the AyaNova database be overwritten with sample data for [evaluation](ay-evaluate.md)
- `Erase all data`: user has requested that the AyaNova database be erased and all data removed
- `Backup downloaded`: user has downloaded a copy of the [AyaNova backup](ops-form-backup.md) files

View File

@@ -1,6 +1,10 @@
# ADM-IMPORT Placeholder
# Import
NOTE: AyaNova 8's native data interchange format is JSON as JSON supports hiearchical structured data of the type AyaNova uses for nearly all it's object types.
[UNDER CONSTRUCTION]
DOC NOTES:
AyaNova 8's native data interchange format is JSON as JSON supports hiearchical structured data of the type AyaNova uses for nearly all it's object types.
For this reason, import ONLY supports JSON format files. Importing CSV files is *not* supported.
@@ -8,6 +12,6 @@ A 3rd party tool can be used to convert CSV files to JSON if necessary.
https://duckduckgo.com/?t=ffab&q=csv+to+json&ia=web
We recommend exporting some records of the object desired to import so that you can see the exact format used and replicate it for import
TODO: How to use the IMPORT feature, limitations, auto tag, etc

View File

@@ -1,26 +1,104 @@
# ADM-LICENSE Placeholder
# License
[UNDER CONSTRUCTION]
The license form is used to view the AyaNova license and perform license related activities.
todo: document how downgrade license frees up techs based on oldest login first
## Authorization Roles required
This form is available to User's with the following [roles](ay-biz-admin-roles.md):
Full access
- Business administration
Read only access
- Business administration - restricted
## How to access License
From the `Administration` navigation pane select `License` navigation item.
## License form
### license display
The license form displays the details of the current AyaNova license in effect:
#### Licensed to
This is the name to which the AyaNova license is officially registered, typically your company name.
#### Database ID
This is the number that uniquely identifies a single AyaNova database for licensing and support purposes and will not change. If a company has multiple separate AyaNova databases each will have it's own unique ID.
This number allows the AyaNova server to match new licenses with the database so they can be installed automatically when available.
#### License serial number
This is the unique serial number of the _active_ AyaNova license in use. When a new replacement license is installed it will have a new unique serial number.
#### License expiration date
If AyaNova is licensed for temporary time periods (e.g. monthly) this will show the upcoming expiration date of this particular license.
In the case of regular non temporary licenses this will be empty.
#### Support and updates expiration date
This is the date that the current support and updates agreement will expire. After this time AyaNova will not be upgradeable to the latest version and technical support will no longer be available if required.
#### Licensed options
This section shows the options selected for the current license include service technician user count and other options such as accounting integration.
### Purchase button
The `Purchase a license` button is provided as a direct link to the license purchasing page and will automatically include the database id required to allow AyaNova to automatically install the new license after purchase.
### Install button
The `Install license` button will trigger the AyaNova server to contact the license server and check for a new replacement license, if found it will automatically be installed.
AyaNova will automatically check for replacement licenses on a regular schedule (if connected to the internet), this button just speeds up the process but is not necessary if a new license has been automatically issued when a purchase was made or a temporary license renewed.
### Menu options
`Copy database ID` - this menu option will copy your database id to clipboard which may be required when communicated with technical support or sales to help identify your records in order to provide support.
`Install license` - this is a duplicate of the functionality of the `Install license` button.
`Erase entire AyaNova database` - this option is provided to completely and permanently erase all user entered data in the AyaNova database. You will be prompted twice to make sure you really want to do this. This action can only be reversed by [restoring](ops-restore.md) from [backup](ops-form-backup.md).
## Downgrading a license
If a replacement license is installed that has fewer service technicians that the prior license and the administrator has not disabled the extra service techncians first, AyaNova will automatically disable any excess service techs / scheduleable Users by setting their `Active` property to false in order to remain with the purchased license count. It tries to do this with the least disruptive way possible by favoring disabling in this order:
1. disable subcontractors first over in-house service techs
2. users that have no login records (have never logged in to AyaNova)
3. oldest last login (users who haven't logged in for the longest time)
This attempts to not disable current active service technicians.
We recommend the administrator disable the excess service techs before downgrading the license to avoid any potential disruption. If a tech was automatically disabled that shouldn't be you can set another tech inactive and then set the de-activated tech back to active so they can continue working.
# Key release
(docs note, this subsection name is linked from Client help adm-license.vue so keep in sync)
User starts AyaNova, no key found this is one of the options in UI License form under using a previously purchased key with an empty database
1) can just fetch if it's not fetched yet
2) was this being used before and want to start fresh? How to request the key be freed, implications etc
3) was this being used before and want to use existing data? Link to restore page in docs
1. can just fetch if it's not fetched yet
2. was this being used before and want to start fresh? How to request the key be freed, implications etc
3. was this being used before and want to use existing data? Link to restore page in docs
# User count exceeded
If you receive an error message stating that the Server is locked due to exceeding licensed active scheduleable User limit this means that AyaNova has found there to be more Active Scheduleable Users than the license permits.
This is typically a sign that the database has been directly edited outside of AyaNova and needs to be fixed by restoring from backup made *before* the editing took place or, if it is absolutely *certain* this was the only change made, setting Scheduleable User's to Active=false to match the *Licensed* Active Schedulable user count.
If you receive an error message stating that the Server is locked due to exceeding licensed active scheduleable User limit this means that AyaNova has found there to be more Active Scheduleable Users than the license permits.
This is typically a sign that the database has been directly edited outside of AyaNova and needs to be fixed by restoring from backup made _before_ the editing took place or, if it is absolutely _certain_ this was the only change made, setting Scheduleable User's to Active=false to match the _Licensed_ Active Schedulable user count.
Directly editing the database circumvents the many checks and balances for ensuring data integrity and can lead to breaking AyaNova completely or worse: problems that are not noticed for some time resulting in data damaged beyond reasonable repair.
Modifying the data outside of AyaNova itself should never be attempted unless directed by AyaNova technical support personnel.
Modifying the data outside of AyaNova itself should never be attempted unless directed by AyaNova technical support personnel.
Your support agreement does *not* cover damage caused by directly editing the database and if this is found to be the case it may lead to costly down time and hourly charges at our discretion to repair the damage.
Your support agreement does _not_ cover damage caused by directly editing the database and if this is found to be the case it may lead to costly down time and hourly charges at our discretion to repair the damage.

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

View File

@@ -94,7 +94,7 @@ nav:
- 'Localization': 'ay-start-localization.md'
- 'Report templates': 'adm-report-templates.md'
- 'adm-attachments.md'
- 'History': 'adm-history.md'
- 'Global history': 'adm-history.md'
- 'Import': 'adm-import.md'
- 'Vendors': 'vendors.md'
- Misc: