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

@@ -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.