diff --git a/docs/docs/img/startqbi-authorize.png b/docs/docs/img/startqbi-authorize.png new file mode 100644 index 0000000..3eaf6d0 Binary files /dev/null and b/docs/docs/img/startqbi-authorize.png differ diff --git a/docs/docs/img/startqbi-desktop-shortcut.png b/docs/docs/img/startqbi-desktop-shortcut.png new file mode 100644 index 0000000..80b59b9 Binary files /dev/null and b/docs/docs/img/startqbi-desktop-shortcut.png differ diff --git a/docs/docs/img/startqbi-post-authorize.png b/docs/docs/img/startqbi-post-authorize.png new file mode 100644 index 0000000..2e34c8a Binary files /dev/null and b/docs/docs/img/startqbi-post-authorize.png differ diff --git a/docs/docs/img/startqbi-qb-not-running-message.png b/docs/docs/img/startqbi-qb-not-running-message.png new file mode 100644 index 0000000..91afc73 Binary files /dev/null and b/docs/docs/img/startqbi-qb-not-running-message.png differ diff --git a/docs/docs/img/startqbi-start-menu-shortcut.png b/docs/docs/img/startqbi-start-menu-shortcut.png new file mode 100644 index 0000000..97dc46d Binary files /dev/null and b/docs/docs/img/startqbi-start-menu-shortcut.png differ diff --git a/docs/docs/install-qbi.md b/docs/docs/install-qbi.md index 857617b..57b617a 100644 --- a/docs/docs/install-qbi.md +++ b/docs/docs/install-qbi.md @@ -101,7 +101,7 @@ Download the QBI setup file [ayanova-qbi-setup.exe](https://ayanova.com/download ### Run setup -Run the setup file `ayanova-qbi-setup.exe` and follow the standard installaer prompts to complete installation. +Run the setup file `ayanova-qbi-setup.exe` and follow the standard installer steps to complete installation. #### Smart screen warning @@ -119,7 +119,7 @@ Use the **`Run anyway`** button to start the installation. The installer checks that the _required_ QBFC15 integration package has been installed and will display an error message about this. -If you know you have installed QBFC15 as [mentioned above in the REQUIREMENTS section](#qbfc15-integration-package-installed) then it may just mean your PC needs to be rebooted so it's safe to accept the "Install anyway" prompt. +If you know you have installed QBFC15 [as mentioned above](#qbfc15-integration-package-installed) in the REQUIREMENTS section then it may just mean your PC needs to be rebooted so it's safe to accept the "Install anyway" prompt. If you did not install QBFC15 choose NO and cancel the QBI installation and come back to it again once you've read through and followed the instructions again from [the top](#installing-qbi). diff --git a/docs/docs/install-starting.md b/docs/docs/install-starting.md index b69ee43..2641d8b 100644 --- a/docs/docs/install-starting.md +++ b/docs/docs/install-starting.md @@ -1,4 +1,50 @@ # Starting QBI +Starting QBI will involve the following steps. -## TEST PAGE +Some steps are only required the first time you use QBI. + +### Start QuickBooks + +AyaNova QBI works by communicating with a running instance of QuickBooks so you must start QuickBooks and have it open to your company file before starting QBI. + +QBI will check if QuickBooks is running and if it isn't you will see this message: + +![qb not running error](img/startqbi-qb-not-running-message.png) + +### Start QBI from it's Shortcut + +The QBI installer will create two shortcuts to start QBI, one on your desktop: + +![qbi desktop shortcut](img/startqbi-desktop-shortcut.png) + +and one in the Windows Start Menu: + +![qbi start menu shortcut](img/startqbi-start-menu-shortcut.png) + +Double-click on either shortcut to start QBI now + +### Grant access + +If this is your first time using QBI with this QuickBooks company file you will be prompted in QuickBooks to grant access to QBI: + +![authorize qbi in QuickBooks](img/startqbi-authorize.png) + +(Your version of QuickBooks may display this prompt slightly different but the action is the same) + +Depending on your version of QuickBooks you may also have an additional confirmation: + +![authorize second confirmation](img/startqbi-post-authorize.png) + +### QBI Initialization + +QBI will now read in data from both QuickBooks and then AyaNova to cache lists of objects commonly used by QBI: + +![qbi init caching message](img/auth-processing.png) + + +### Confirm company file + +As a precaution QBI will prompt you when it starts to confirm that the QuickBooks company file you are using is the one you want to work with: + +![approve company file](img/confirm-company.png) \ No newline at end of file