admin/ravenqbi
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Browse Source
This commit is contained in:
John Cardinal
2022-07-14 23:29:02 +00:00
parent 2ba7e17a90
commit d02c7fe215
1 changed files with 29 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
docs/docs/install-qbi.md
View File

@@ -1,6 +1,6 @@
# Installation # Installation
Did you hear about Bertram? Did you hear about Bertram?
He didn't read all the instructions before starting installation and the whole thing took twice as long and resulted in so many problems down the road it was a right kerfuffle! He didn't read all the instructions before starting installation and the whole thing took twice as long and resulted in so many problems down the road it was a right kerfuffle!
@@ -8,19 +8,19 @@ Don't be a Bertram; read these instructions before you install QBI.
## Requirements before installation ## Requirements before installation
### AyaNova QBI License #### AyaNova QBI License
AyaNova QBI is an _optional_ product to use with AyaNova. A license for QBI must be purchased and added to your AyaNova license to use QBI. AyaNova QBI is an _optional_ product to use with AyaNova. A license for QBI must be purchased and added to your AyaNova license to use QBI.
You can purchase a QBI license from [our website](https://ayanova.com/). You can purchase a QBI license from [our website](https://ayanova.com/).
### 64 Bit Windows operating system #### 64 Bit Windows operating system
AyaNova QBI requires a 64 bit version of Windows AyaNova QBI requires a 64 bit version of Windows
### Supported QuickBooks for Windows installed #### QuickBooks for Windows installed
The following versions of QuickBooks **Desktop** edition **with latest service patches** are supported by QBI: Any of the following versions of QuickBooks **Desktop** edition **with latest service patches** are required to use QBI:
- U.S. QuickBooks 2008 or newer - U.S. QuickBooks 2008 or newer
- Canadian QuickBooks 2008 or newer - Canadian QuickBooks 2008 or newer
@@ -29,7 +29,7 @@ The following versions of QuickBooks **Desktop** edition **with latest service p
QuickBooks must be installed to the same computer you want to use with QBI and must be able to open your QuickBooks company data file without issue. QuickBooks must be installed to the same computer you want to use with QBI and must be able to open your QuickBooks company data file without issue.
### QBFC15 integration package installed #### QBFC15 integration package installed
AyaNova QBI uses and requires the QBFC version 15 integration package from Intuit that allows QBI to communicate with QuickBooks. AyaNova QBI uses and requires the QBFC version 15 integration package from Intuit that allows QBI to communicate with QuickBooks.
@@ -37,31 +37,33 @@ You must [download](https://ayanova.com/download/QBFC15_0Installer.exe) and run
QBI will not work without QBFC being installed first. QBI will not work without QBFC being installed first.
## AyaNova User requirements ### AyaNova User requirements
### Accounting role User #### Accounting role User
AyaNova QBI can only be used by [Users](https://www.ayanova.com/docs/adm-users/) with the [Accounting Authorization Role](https://www.ayanova.com/docs/ay-biz-admin-roles/#accounting). AyaNova QBI can only be used by [Users](https://www.ayanova.com/docs/adm-users/) with the [Accounting Authorization Role](https://www.ayanova.com/docs/ay-biz-admin-roles/#accounting).
### Single login applies #### Single login applies
Be aware that AyaNova only issues a [single login token](https://www.ayanova.com/docs/ay-start-login/#login-token) at a time for the same User account, so if you were to log in to AyaNova QBI while previously logged in to AyaNova, the AyaNova session will be terminated as the new login to QBI has made the original login token expired and invalid. Be aware that AyaNova only issues a [single login token](https://www.ayanova.com/docs/ay-start-login/#login-token) at a time for the same User account, so if you were to log in to AyaNova QBI while previously logged in to AyaNova, the AyaNova session will be terminated as the new login to QBI has made the original login token expired and invalid.
If you need to work in both QBI and AyaNova at the same time then we recommend creating a separate User account specifically for using QBI. If you need to work in both QBI and AyaNova at the same time then we recommend [creating](https://www.ayanova.com/docs/adm-users/) a separate User account specifically for using QBI.
### AyaNova object rights #### AyaNova object rights
Some of QBI's features will modify AyaNova objects and require the same User Role permissions to modify those objects as you would need to do so in AyaNova. Ensure the QBI User is granted sufficient [Roles](https://www.ayanova.com/docs/ay-biz-admin-roles/) to make the modifications necessary. Some of QBI's features will modify AyaNova objects and require the same User Role permissions to modify those objects as you would need to do so in AyaNova.
## AyaNova Work order status requirements Ensure the QBI User is granted sufficient [Roles](https://www.ayanova.com/docs/ay-biz-admin-roles/) to the objects that are required to be modified in QBI.
AyaNova QBI needs to modify Service Work orders in AyaNova when it Invoices and / or adjusts prices if that feature is used. ### AyaNova Work order status requirements
QBI needs to modify [Service Work orders](https://www.ayanova.com/docs/svc-workorders/) in AyaNova when it Invoices and / or adjusts prices if that feature is used.
Any security rights and Roles required by AyaNova to make those modifications in the regular AyaNova User interface are also requried when doing the same modifications via QBI, there is no difference security-wise. Any security rights and Roles required by AyaNova to make those modifications in the regular AyaNova User interface are also requried when doing the same modifications via QBI, there is no difference security-wise.
For this reason the AyaNova [Work order status](https://www.ayanova.com/docs/svc-work-order-status/) feature and it's Remove and Select Roles features if used are very relevant to using QBI. For this reason the AyaNova [Work order status](https://www.ayanova.com/docs/svc-work-order-status/) feature and it's Remove and Select Roles features (if used) are very relevant to using QBI:
### Work order status Remove and Select Roles #### Work order status Remove and Select Roles
In AyaNova a work order can be set to a [Work order status](https://www.ayanova.com/docs/svc-work-order-status/) that [locks](https://www.ayanova.com/docs/svc-work-order-status/#is-a-locking-status) the work order and prevents it from being modified unless a User with sufficient Roles to [remove](https://www.ayanova.com/docs/svc-work-order-status/#who-can-remove) that status changes it to an different, unlocked status which is exactly what QBI does whenever it modifies Work orders. In AyaNova a work order can be set to a [Work order status](https://www.ayanova.com/docs/svc-work-order-status/) that [locks](https://www.ayanova.com/docs/svc-work-order-status/#is-a-locking-status) the work order and prevents it from being modified unless a User with sufficient Roles to [remove](https://www.ayanova.com/docs/svc-work-order-status/#who-can-remove) that status changes it to an different, unlocked status which is exactly what QBI does whenever it modifies Work orders.
@@ -69,10 +71,18 @@ This means that the User who logs in to QBI must have any required Roles that ar
The simplest way to accomplish this is to be sure to always add the Accounting role to any Work order Status' required Remove or Select Roles settings if that feature is used. The simplest way to accomplish this is to be sure to always add the Accounting role to any Work order Status' required Remove or Select Roles settings if that feature is used.
### QBI special Work Order Status #### QBI's own special Work Order Status
When QBI is installed it automatically creates it's own Work order status: `z_Accounting integration edit` for the purpose of editing Work orders. When QBI is installed it automatically creates it's own Work order status:
This special status is a requirement for using QBI and if it's removed or modified in such a way as to prevent it working properly QBI will alert you to this on startup with instructions on how to fix this issue. `z_Accounting integration edit`
for the purpose of editing Work orders.
This special status is a requirement for using QBI and if it's removed or modified in such a way as to prevent it working properly, QBI will alert you to this on startup with instructions on how to fix this issue.
Do not modify this status in AyaNova unless it's to fix it after someone else broke QBI by changing it.
Note that QBI looks for this status by name, not by internal ID so if someone renames it QBI will assume it's not there at all and create a new one with the same name causing older work orders to have the original status ID set and newer ones to have the new one set. You will _not_ be alerted to this if it the name is changed and there is no easy way to fix this if it happens.
This special status use also means you can see at a glance in AyaNova exactly when each work order was modified by QBI by looking at the [Status change history in the Work order header](https://www.ayanova.com/docs/svc-workorders/#work-order-status). This special status use also means you can see at a glance in AyaNova exactly when each work order was modified by QBI by looking at the [Status change history in the Work order header](https://www.ayanova.com/docs/svc-workorders/#work-order-status).