Qvinci.web Sync Application Setup Instructions For Server-Based QuickBooks Files Table of Contents What is Qvinci.web?... 2 What is the Qvinci.web Sync Application?... 2 How does the Hosted Qvinci.web Sync Application work?... 2 Required Server Settings:... 3 Troubleshooting:... 3 Could Not Start QuickBooks Error Message... 3 Server Farm Environment:... 4 Installing in a Server Farm/Shared Server Environment:... 5 The Schedule Controller (Part 1 of 3):... 5 The Background Sync (Part 2 of 3):... 6 The Qvinci Sync Client (Part 3 of 3):... 7 Dedicated Server Environment:... 8 Installing in a Dedicated Server Environment:... 9 The Schedule Controller (Part 1 of 3):... 9 The Background Sync (Part 2 of 3):... 10 The Qvinci Sync Client (Part 3 of 3):... 11 1
What is Qvinci.web? Qvinci.web is an online, financial reporting solution. Qvinci.web delivers instantaneous business reports from 1 to 20,000 QuickBooks files anywhere in the world over the internet. Its ability to consolidate financial and operational data provides users with instant understanding and insight of their company s information. What is the Qvinci.web Sync Application? Our sync application connects to QuickBooks and syncs financial data to the Qvinci servers. Reports can then be viewed from within the Qvinci.web application. How does the Hosted Qvinci.web Sync Application work? 1) Hosting company installs the software which includes the schedule controller, background sync and Qvinci sync client. 2) The end user will run the Qvinci sync client to link and sync their QuickBooks files. 3) When inside the Qvinci sync client, the end user will click the Schedule Sync button which requests a background sync take place. 4) Hosting company will set up the background sync schedule for the end user. [Refer to The Background Sync (Part 2 of 3), Section C] 5) The end user s QuickBooks files will be sync d according to the schedule set by the hosting company. 2
Required Server Settings: There are certain permissions on a server that must be enabled in order for the hosted sync application to work properly. The following internet security options must be set to (Enable). In order for these to be changed, the user (Network Administrator) must go to the control panel and select the Internet Options icon. After opening the Internet Options page, they will need to select the security tab. All servers will be defaulted to HIGH security, to change these settings they will need to select Custom Level. After they have opened the custom level, the will need to select (Enable) on each of the above items from this screen. 1. Run ActiveX and plug-ins 2. Scrip ActiveX controls marked safe for scripting 3. Active scripting 4. Scripting of Java Applets 5. QBCFMonitorService must be set to automatic startup 6. QuickBooksDB19 and QuickBooksDB20 must be set to manual, automatic, or delayed start Troubleshooting: Could Not Start QuickBooks Error Message If syncs do not start, and the background log specifies that QuickBooks returned Could not start QuickBooks error message, then check the following: 1. The user account running the background sync service is not Local System account and has rights to run QuickBooks and ActiveX scripts 2. The account has write permissions to its own folder 3. The account has read permissions to the QuickBooks file 4. QuickBooks is updated. If QuickBooks loads with a dialog specifying it needs to be updated the syncs may not work correctly. 3
Server Farm Environment: 4
Installing in a Server Farm/Shared Server Environment: The Admin of the server must install three services/applications in order for the client to sync QuickBooks data: 1) The Schedule Controller, 2) The Background Sync, and 3) The Qvinci Sync Client. The Schedule Controller (Part 1 of 3): In a Server Farm/Shared Server environment the Schedule Controller must be installed on ONE server. These instructions are intended for a technical audience that has administrative rights on a terminal server. This service is to control the scheduling of sync clients to background sync services. The following instruction set can also be found here: https://web.qvinci.com/syncclient/qvincisyncschedulecontrollerservice.zip A) To install: 1) Place all contents into a directory of your choice and manually install the service using sc.exe. 2) Make sure there's a space after the = sign, and the executable name is in quotes. Example: sc create QvinciWebSyncScheduleControllerService binpath= "C:\QvinciWebSync\Scheduler\QvinciWeb.SyncScheduleControllerService.exe" start= auto B) Make sure the account running the service has write permissions to its executable directory, and anywhere required for logging (as specific in the config file). C) All configuration and examples are in the file QvinciWeb.SyncScheduleControllerService.exe.config If the config file is changed, the service must be restarted. D) To enable Qvinci.web sync clients to connect to this controller service place the server s ip:port" (without the quotes) in the file %ALLUSERSPROFILE%\Qvinci.web\SyncControllerServer.config. Otherwise the sync clients will attempt to schedule syncs using Window Task Scheduler. NOTE: This file must be created by the server s Administrator. 5
Installing in a Server Farm/Shared Server Environment (Continued): The Background Sync (Part 2 of 3): In a Server Farm/Shared Server environment the Background Sync should be installed on ALL servers where a client may log in to manage their QuickBooks files. These instructions are intended for a technical audience that has administrative rights on a terminal server. This service performs the sync from QuickBooks to Qvinci's servers. The following instruction set can also be found here: https://web.qvinci.com/syncclient/qvincisyncschedulebackgroundservice.zip A) To install: 1) Place all contents into a directory of your choice and manually install the service using sc.exe. 2) Make sure there's a space after the = sign, and the executable name is in quotes. Example: sc create QvinciWebSyncScheduleBackgroundService binpath= "C:\QvinciWebSync\BackgroundSync\QvinciWeb.BackgroundSyncService.exe" start= auto B) Make sure the account running the service has the following access: 1) Write permissions to its executable directory 2) Write permissions required for logging (as specific in the config file) 3) Access to run QuickBooks, and read any files the user(s) wish to sync. 4) Ability to connect to the Qvinci.web Sync Schedule service (as specified in the config file) WARNING: Local System Account, by default, cannot run QuickBooks. C) The following configuration and examples are located in the file QvinciWeb.BackgroundSyncService.exe.config a. Listening address and port- default port 54113 b. Time to run schedule c. Logging options 1) If the config file is changed, the service must be restarted. 6
Installing in a Server Farm/Shared Server Environment (Continued): The Qvinci Sync Client (Part 3 of 3): In a Server Farm/Shared Server environment the Qvinci Sync Client should be installed on ALL servers where a client may log in to manage their QuickBooks files. Things to know prior to installing: A) The person responsible for installing the Sync App must have Windows Admin permissions. B) Hosting company must open Port 808 in order for the Sync App to function. Downloading/Installing the Qvinci Sync client: A) Use this link: https://web.qvinci.com/syncclient/qvincisyncsetup.zip 1) Save the zip file to the same location where the QuickBooks application is installed. It should default to being saved in a file called QvnciSyncSetup. 2) Navigate to the QvinciSyncSetup file and choose extract all files from the zip file. 3) Once extracted, run the QvinciSync installer to install the Sync Client. Note: The Qvinci Sync Client should be installed on ALL servers where a client may log in to manage their QuickBooks files. 4) Once the QuickBooks file is manually linked and sync d, then click the Schedule Sync button inside the Client to confirm the schedule for future automated syncing. The user may also perform this task. 7
Dedicated Server Environment: 8
Installing in a Dedicated Server Environment: The Admin of the server must install three services/applications in order for the client to sync QuickBooks data: 1) The Schedule Controller, 2) The Background Sync, and 3) The Qvinci Sync Client. The Schedule Controller (Part 1 of 3): In a Dedicated Server environment the Schedule Controller must be installed on ALL servers. These instructions are intended for a technical audience that has administrative rights on a terminal server. This service is to control the scheduling of sync clients to background sync services. The following instruction set can also be found here: https://web.qvinci.com/syncclient/qvincisyncschedulecontrollerservice.zip A) To install: 1) Place all contents into a directory of your choice and manually install the service using sc.exe. 2) Make sure there's a space after the = sign, and the executable name is in quotes. Example: sc create QvinciWebSyncScheduleControllerService binpath= "C:\QvinciWebSync\Scheduler\QvinciWeb.SyncScheduleControllerService.exe" start= auto B) Make sure the account running the service has write permissions to its executable directory, and anywhere required for logging (as specific in the config file). C) All configuration and examples are in the file QvinciWeb.SyncScheduleControllerService.exe.config If the config file is changed, the service must be restarted. D) To enable Qvinci.web sync clients to connect to this controller service place the server s ip:port" (without the quotes) in the file %ALLUSERSPROFILE%\Qvinci.web\SyncControllerServer.config. Otherwise the sync clients will attempt to schedule syncs using Window Task Scheduler. NOTE: This file must be created by the server s Administrator. 9
Installing in a Dedicated Server Environment (Continued): The Background Sync (Part 2 of 3): In a Dedicated Server environment the Background Sync must be installed on ALL servers. These instructions are intended for a technical audience that has administrative rights on a terminal server. This service performs the sync from QuickBooks to Qvinci's servers. The following instruction set can also be found here: https://web.qvinci.com/syncclient/qvincisyncschedulebackgroundservice.zip A) To install: 1) Place all contents into a directory of your choice and manually install the service using sc.exe. 2) Make sure there's a space after the = sign, and the executable name is in quotes. Example: sc create QvinciWebSyncScheduleBackgroundService binpath= "C:\QvinciWebSync\BackgroundSync\QvinciWeb.BackgroundSyncService.exe" start= auto B) Make sure the account running the service has the following access: 1) Write permissions to its executable directory 2) Write permissions required for logging (as specific in the config file) 3) Access to run QuickBooks, and read any files the user(s) wish to sync. WARNING: Local System Account, by default, cannot run QuickBooks. 4) Ability to connect to the Qvinci.web Sync Schedule service (as specified in the config file) C) The following configuration and examples are located in the file QvinciWeb.BackgroundSyncService.exe.config a. Listening address and port- default port 54113 b. Logging options 1) If the config file is changed, the service must be restarted. 10
Installing in a Dedicated Server Environment (Continued): The Qvinci Sync Client (Part 3 of 3): In a Dedicated Server environment the Qvinci Sync Client must be installed on ALL servers. Things to know prior to installing: A) The person responsible for installing the Sync App must have Windows Admin permissions. B) Hosting company must open Port 808 in order for the Sync App to function. Downloading/Installing the Qvinci Sync client: A) Use this link: https://web.qvinci.com/syncclient/qvincisyncsetup.zip 1) Save the zip file to the same location where the QuickBooks application is installed. It should default to being saved in a file called QvnciSyncSetup. 2) Navigate to the QvinciSyncSetup file and choose extract all files from the zip file. 3) Once extracted, run the QvinciSync installer to install the Sync Client. Note: The Qvinci Sync Client should be installed on ALL servers where a client will log in to manage their QuickBooks files. 4) Once the QuickBooks file is manually linked and sync d, then click the Schedule Sync button inside the Client to confirm the schedule for future automated syncing. The user may also perform this task. 11