This commit is contained in:
@@ -72,8 +72,6 @@ We recommend limiting the [authorization roles](ay-biz-admin-roles.md) initially
|
||||
|
||||
You should create a User account for every User who will be using AyaNova. AyaNova does not permit the same User account to be in active use for more than one user at a time.
|
||||
|
||||
Only Scheduleable type users [consume a license](adm-users.md#licensing-and-scheduleable-users) so there is no reason not to create as many User accounts as are required for your staff.
|
||||
|
||||
When you create the User accounts, give each User a temporary password and encourage them to change it immediately when they first log in following our [recommended best practices](home-password.md#long-not-complicated) for choosing a password.
|
||||
|
||||
While it's a good idea for any User, if the User has been granted the Business administration role we particularly encourage you to have them set up [Two factor authentication](home-tfa.md) to ensure the highest level security for what is a very powerful role in AyaNova.
|
||||
|
||||
@@ -4,7 +4,6 @@ The license form is used to view the AyaNova license and perform license related
|
||||
|
||||
The AyaNova license is stored inside the database so as long as you have a backup of the database you have the license backed up as well.
|
||||
|
||||
|
||||
## Trying out AyaNova
|
||||
|
||||
If you are trying out AyaNova for the first time this form will automatically prompt you to request an evaluation license.
|
||||
@@ -93,11 +92,21 @@ This number allows the AyaNova server to match new licenses with the database so
|
||||
|
||||
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 type
|
||||
|
||||
This field displays the license type matching which version of AyaNova is in use.
|
||||
|
||||
AyaNova is available as a self-installed version or as a subscription service.
|
||||
|
||||
Self-installed AyaNova licenses display here as "Perpetual" licenses.
|
||||
|
||||
Hosted subscription service AyaNova licenses display here as "Subscription" licenses.
|
||||
|
||||
#### License expiration date
|
||||
|
||||
If AyaNova is licensed for temporary time periods (e.g. month to month as a hosted service) this will show the upcoming expiration date of this particular license.
|
||||
If AyaNova is licensed for temporary time periods (e.g. month to month as a subscription service) this will show the upcoming expiration date of this particular license.
|
||||
|
||||
In the case of regular non temporary licenses this will not display.
|
||||
In the case of non expiring licenses this will not display.
|
||||
|
||||
#### Maintenance plan expiration date
|
||||
|
||||
@@ -107,19 +116,59 @@ After this time AyaNova will not be updateable and technical support will no lon
|
||||
|
||||
#### Licensed options
|
||||
|
||||
This section shows the options selected for the current license including service technician user count and other optional additions.
|
||||
This section shows the options selected for the current license including licensed user count and other optional additions.
|
||||
|
||||
##### Service technician Scheduleable users and licensing
|
||||
##### ServiceTechs licensed option
|
||||
|
||||
**Perpetual type licenses only**
|
||||
**Perpetual licenses only**
|
||||
|
||||
In order to provide fair pricing that scales with the size of a company AyaNova is licensed by service technician (scheduleable user) count.
|
||||
In order to provide fair pricing that scales with the size of a company self installed "Perpetual" AyaNova is licensed by service technician (scheduleable user) count.
|
||||
|
||||
Service technician and sub-contractor type Users also known as "scheduleable users" in AyaNova are Users that have their "User Type" field set to "Service user" or "Sub-contractor user" in their their [User record ](adm-users.md). Users set to this type are scheduleable and trackable for service in AyaNova and selectable on work orders, quotes and preventive maintenance orders.
|
||||
|
||||
Only scheduleable users that are set to Active in their [User record ](adm-users.md) will consume a Scheduleable User / service technician license from the total count available as licensed.
|
||||
Only scheduleable users that are set to Active in their [User record ](adm-users.md) will require a Scheduleable User / service technician license from the total count available as licensed.
|
||||
|
||||
Non scheduleable users such as administrators or office staff and inactive Scheduleable users will _not_ consume a license and we encourage you to make as many non scheduleable Users as you need to ensure every user has their own unique account in AyaNova.
|
||||
Scheduleable Users only appear in the [schedule form](svc-schedule.md) 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 before de-activating them.
|
||||
|
||||
With a Perpetual license type, non scheduleable users such as administrators or office staff and inactive Scheduleable users will _not_ consume a license and we encourage you to make as many non scheduleable Users as you need to ensure every user has their own unique account in AyaNova.
|
||||
|
||||
##### ActiveInternalUsers licensed option
|
||||
|
||||
**Subscription licenses only**
|
||||
|
||||
When AyaNova is used as a subscription service, every User that can login consumes resources so licensing is affected by any User type who is able to login to AyaNova.
|
||||
|
||||
There are two types of Users who can login to AyaNova, internal staff Users and external Customer Contact Users.
|
||||
|
||||
Internal users require a "ActiveInternalUsers" license if they are set to Active.
|
||||
|
||||
##### ActiveCustomerUsers licensed option
|
||||
|
||||
**Subscription licenses only**
|
||||
|
||||
Customer Contact Users only require a "ActiveCustomerUsers" license if they are set to Active **and** have Allow Login field also set to true.
|
||||
|
||||
Because Customer Contact login Users generally consume very little resources they are licensed separately for a [lower price](https://ayanova.com/r/pricing.htm) than a regular AyaNova User.
|
||||
|
||||
#### Server information
|
||||
|
||||
As a convenience, below the license information is a separate section showing the current Server information as it pertains to licensing.
|
||||
|
||||
##### Version
|
||||
|
||||
This is the current version of AyaNova in use and the build type.
|
||||
|
||||
##### Active scheduleable Users
|
||||
|
||||
Displays the number of Active scheduleable type users currently consuming a license **if** the current license type and AyaNova build is `Perpetual`.
|
||||
|
||||
##### Active internal Users
|
||||
|
||||
Displays the number of Active internal (non Customer contact) type users currently consuming a license **if** the current license type and AyaNova build is `Subscription`.
|
||||
|
||||
##### Active Customer Contact login Users
|
||||
|
||||
Displays the number of Active Customer contact type users currently consuming a license **if** the current license type and AyaNova build is `Subscription`.
|
||||
|
||||
### Purchase button
|
||||
|
||||
@@ -180,19 +229,12 @@ If a tech was automatically disabled to remain within the licensed limit that sh
|
||||
|
||||
**Subscription licenses**
|
||||
|
||||
AyaNova will autoamtically deactivate excess Users of any kind preferring Users who have not logged in ever or failing that the longest time since login.
|
||||
|
||||
We recommend the administrator disable the excess Users before downgrading the license to avoid any potential disruption.
|
||||
|
||||
If a User was automatically disabled to remain within the licensed limit that shouldn't be, you can set another User inactive and then set the de-activated User back to active so they can continue working.
|
||||
|
||||
AyaNova will _not_ autoamtically deactivate excess Users of any kind and license installation will fail if you have not manually disabled excess Users before attempting to install the license.
|
||||
|
||||
## User count exceeded
|
||||
|
||||
If you receive an error message stating that the Server is locked due to exceeding licensed limit this means that AyaNova has found there to be more Active Users than the license permits.
|
||||
|
||||
In the case of Perpetual licenses this is Scheduleable Users (Service Technicians) and for Subscription hosted licenses this is all Users.
|
||||
|
||||
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 requiring restarting with a new empty database.
|
||||
@@ -226,4 +268,3 @@ You will need to [purchase](https://ayanova.com/r/pricing.htm) a Maintenance pla
|
||||
AyaNova will not operate if it was released after your Maintenance plan expired and no one will be able to access AyaNova except the Super User account for the purposes of installing a license only.
|
||||
|
||||
You will need to [purchase](https://ayanova.com/r/pricing.htm) a Maintenance plan to continue working or downgrade back to the version you were using prior to upgrading.
|
||||
|
||||
|
||||
@@ -32,14 +32,6 @@ User access to the various features and business object types in AyaNova is cont
|
||||
|
||||
For example if a user is set to a User type of Subcontractor they will not be able to see Part costs and prices no matter what their roles are.
|
||||
|
||||
#### Licensing and Scheduleable Users
|
||||
|
||||
Only active, scheduleable type users consume a "service technician" license, see the [licensing page](adm-license.md#service-technician-scheduleable-users-and-licensing) for details.
|
||||
|
||||
Scheduleable Users only consume a license when they are set to Active. De-activating them is a way to free up a license and also preserve the history of their work in AyaNova.
|
||||
|
||||
Scheduleable Users only appear in the [schedule form](svc-schedule.md) 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 before de-activating them.
|
||||
|
||||
#### Do not share User accounts
|
||||
|
||||
Every User of AyaNova **must** have their own account.
|
||||
@@ -90,7 +82,7 @@ This also means when you grant a new role to a User they will need to log out an
|
||||
|
||||
##### Service user
|
||||
|
||||
This type of User [consumes an AyaNova service tech license](#licensing-and-scheduleable-users), is scheduleable for service and is appropriate for any staff User that peforms service and needs to have their service tracked.
|
||||
A Service User is scheduleable for service and is appropriate for any staff User that peforms service and needs to have their service tracked.
|
||||
|
||||
##### Non-Service user
|
||||
|
||||
@@ -98,7 +90,11 @@ This type of User does _not_ consume an AyaNova license, is not scheduleable for
|
||||
|
||||
##### Subcontractor
|
||||
|
||||
This type of User [consumes an AyaNova service tech license](#licensing-and-scheduleable-users), is scheduleable for service and is appropriate for any non-staff contracted User that peforms service under contract and needs to have their service tracked. This type of User has far more limited rights than a Service User and is restricted in AyaNova to only being able to view the exact data that is required for them to do their job. For example they are not able to see prices or costs in a work order or view parts of a work order not directly related to their job.
|
||||
A Subcontractor type User is scheduleable for service and is appropriate for any non-staff contracted User that peforms service under contract and needs to have their service tracked. This type of User has far more limited rights than a Service User and is restricted in AyaNova to only being able to view the exact data that is required for them to do their job. For example they are not able to see prices or costs in a work order or view parts of a work order not directly related to their job.
|
||||
|
||||
#### Allow login
|
||||
|
||||
This field controls whether a User is allowed to login to AyaNova.
|
||||
|
||||
#### New login name / New password
|
||||
|
||||
@@ -114,6 +110,8 @@ This read only field shows the most recent date and time this User logged in.
|
||||
|
||||
The active field controls whether a User is enabled in AyaNova. Inactive Users can not log in and their name is not offered in selection lists for new records by default.
|
||||
|
||||
Inactive Users are not counted against an [AyaNova license](adm-license.md).
|
||||
|
||||
##### Revoking access and locking out Users
|
||||
|
||||
Only active Users can login. If a User is set to inactive their authentication token is immediately revoked and even if they are currently logged in they will be logged out the moment they attempt any operation in AyaNova that needs to connect with the server or when the web application attempts to connect behind the scenes to check for notifications as it periodically does.
|
||||
|
||||
@@ -30,6 +30,8 @@ The third number, for example 8.1.**2** in the rightmost 'patch' position indica
|
||||
|
||||
Major version changes are not compatible with prior major releases whereas all minor and patch version changes are compatible within that major version release.
|
||||
|
||||
The Build type of this instance of AyaNova is displayed at the end of the version number, there are two types "Perpetual" for self-installed AyaNova and "Subscription" for AyaNova used as a hosted service.
|
||||
|
||||
#### User
|
||||
|
||||
This displays the current logged in [User](adm-users.md) account. You can also view this at the top of the [navigation drawer](ay-start-form-overview.md#navigation-drawer) if you need to quickly check which user you are logged in as.
|
||||
|
||||
@@ -6,28 +6,28 @@ Customer contacts are people associated with a Customer or Head office that migh
|
||||
|
||||
## 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
|
||||
|
||||
- Accounting
|
||||
- Business administration
|
||||
- Service manager
|
||||
- Sales
|
||||
- Accounting
|
||||
- Business administration
|
||||
- Service manager
|
||||
- Sales
|
||||
|
||||
Read only access
|
||||
|
||||
- Business administration - restricted
|
||||
- Service manager - restricted
|
||||
- Service technician
|
||||
- Sales - restricted
|
||||
- Business administration - restricted
|
||||
- Service manager - restricted
|
||||
- Service technician
|
||||
- Sales - restricted
|
||||
|
||||
## How to access Customer contacts
|
||||
|
||||
Customer contacts are accessed in the following ways:
|
||||
|
||||
- Contacts for a single Customer are listed in the [Contacts tab](customers.md#contacts-tab) of the Customer edit form
|
||||
- All Customer Contacts are listed in the `Customers` [navigation drawer](ay-start-form-overview.md#navigation-drawer) `Customer contacts` [data table](ay-start-form-data-tables.md) form
|
||||
- Contacts for a single Customer are listed in the [Contacts tab](customers.md#contacts-tab) of the Customer edit form
|
||||
- All Customer Contacts are listed in the `Customers` [navigation drawer](ay-start-form-overview.md#navigation-drawer) `Customer contacts` [data table](ay-start-form-data-tables.md) form
|
||||
|
||||
### Adding new Contacts
|
||||
|
||||
@@ -56,6 +56,10 @@ This is the only required field. Enter the User name here, we recommend `Firstna
|
||||
There are only two roles available, the full `Customer` role and the more restricted `Customer - restricted` role.
|
||||
This works in conjunction with the [Customer access](adm-global-settings.md#customer-access-settings) self-service feature controls to restrict access.
|
||||
|
||||
#### Allow login
|
||||
|
||||
This field controls whether a Customer Contact User is allowed to login to AyaNova. When AyaNova is being used as a hosted subscription service, this field also controls whether a Customer Contact [consumes a license](adm-license.md#active-customer-contact-login-users).
|
||||
|
||||
#### New login name / New password
|
||||
|
||||
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.
|
||||
@@ -70,7 +74,7 @@ This read only field shows the most recent date and time this Contact logged in.
|
||||
|
||||
#### Active
|
||||
|
||||
The active field controls whether a Contact user is enabled in AyaNova. Inactive Contacts can not log in.
|
||||
The active field controls whether a Contact user is offered for selection on selection lists, receives notifications.
|
||||
|
||||
##### Revoking access / locking out Contacts
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 66 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 50 KiB After Width: | Height: | Size: 53 KiB |
@@ -7,7 +7,7 @@ theme:
|
||||
site_name: AyaNova manual
|
||||
site_dir: '../../../server/AyaNova/wwwroot/docs'
|
||||
strict: true
|
||||
copyright: Copyright © 2022 Ground Zero Tech-Works Inc. REV-2022-08-15
|
||||
copyright: Copyright © 2022 Ground Zero Tech-Works Inc. REV-2022-08-29
|
||||
extra:
|
||||
generator: false
|
||||
# Extensions
|
||||
|
||||
Reference in New Issue
Block a user