From 97a23d0aaee8922933bd18036bbf03154ff8f061 Mon Sep 17 00:00:00 2001 From: Polina <112084241+pzaichkina@users.noreply.github.com> Date: Mon, 13 Jan 2025 13:06:17 +0000 Subject: [PATCH 1/2] delete legacy quickbooks docs --- .../accounting-quickbooksdesktop.md | 15 +- .../legacy/accounting-quickbooksdesktop.md | 133 -------------- .../install-qbd-connector-right-networks.md | 145 --------------- .../installing-the-quickbooks-connector.md | 165 ------------------ .../legacy/quickbooks-desktop-faq.md | 23 --- .../quickbooks-desktop-troubleshooting.md | 121 ------------- .../software-and-hardware-requirements.md | 88 ---------- redirects.config.js | 5 +- 8 files changed, 2 insertions(+), 693 deletions(-) delete mode 100644 docs/integrations/accounting/quickbooksdesktop/legacy/accounting-quickbooksdesktop.md delete mode 100644 docs/integrations/accounting/quickbooksdesktop/legacy/install-qbd-connector-right-networks.md delete mode 100644 docs/integrations/accounting/quickbooksdesktop/legacy/installing-the-quickbooks-connector.md delete mode 100644 docs/integrations/accounting/quickbooksdesktop/legacy/quickbooks-desktop-faq.md delete mode 100644 docs/integrations/accounting/quickbooksdesktop/legacy/quickbooks-desktop-troubleshooting.md delete mode 100644 docs/integrations/accounting/quickbooksdesktop/legacy/software-and-hardware-requirements.md diff --git a/docs/integrations/accounting/quickbooksdesktop/accounting-quickbooksdesktop.md b/docs/integrations/accounting/quickbooksdesktop/accounting-quickbooksdesktop.md index 7f3825894..d9e2738ab 100644 --- a/docs/integrations/accounting/quickbooksdesktop/accounting-quickbooksdesktop.md +++ b/docs/integrations/accounting/quickbooksdesktop/accounting-quickbooksdesktop.md @@ -3,19 +3,6 @@ title: "QuickBooks Desktop (on-premise)" description: "Learn about our QuickBooks Desktop on-premise connector" --- -:::caution New web connector documentation - -This documentation describes the use of our new QuickBooks Desktop web connector. If you are using our legacy on-premise connector, refer to the previous version of our documentation: - -* [QuickBooks Desktop (on-premise) overview](/integrations/accounting/quickbooksdesktop/legacy/accounting-quickbooksdesktop) -* [Install the QuickBooks Desktop connector on Right Networks](/integrations/accounting/quickbooksdesktop/legacy/install-qbd-connector-right-networks) -* [Install the QuickBooks Desktop connector](/integrations/accounting/quickbooksdesktop/legacy/installing-the-quickbooks-connector) -* [FAQs](/integrations/accounting/quickbooksdesktop/legacy/quickbooks-desktop-faq) -* [Troubleshooting](/integrations/accounting/quickbooksdesktop/legacy/quickbooks-desktop-troubleshooting) -* [QuickBooks Desktop requirements](/integrations/accounting/quickbooksdesktop/legacy/software-and-hardware-requirements) - -::: - Our QuickBooks Desktop connector enables SMBs who use QuickBooks Desktop to share their consented accounting data through the Codat platform, supporting the following ways of connecting to QBD: - QuickBooks Desktop app @@ -30,7 +17,7 @@ View the coverage of our QuickBooks Desktop connector in the [Data coverage expl :::caution Attachments not supported -Uploading and downloading attachments to QuickBooks Desktop is not supported for any data type. This functionality is not supported by the QuickBooks SDK. +Uploading and downloading attachments to QuickBooks Desktop is not supported for any data type. This functionality is not supported by Intuit's own QuickBooks SDK. ::: diff --git a/docs/integrations/accounting/quickbooksdesktop/legacy/accounting-quickbooksdesktop.md b/docs/integrations/accounting/quickbooksdesktop/legacy/accounting-quickbooksdesktop.md deleted file mode 100644 index 0349c958d..000000000 --- a/docs/integrations/accounting/quickbooksdesktop/legacy/accounting-quickbooksdesktop.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -title: "QuickBooks Desktop (on-premise)" -description: "Learn about our QuickBooks Desktop on-premise connector." ---- - -Our QuickBooks Desktop on-premise connector enables SMBs who use QuickBooks Desktop to share their consented accounting data through the Codat platform. - -The connector is a Windows application that runs on the SMB user's local machine. - -## Data type coverage - -View the coverage of our QuickBooks Desktop on-premise connector in the [Data coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-integration&integrationKey=pqsw). - -:::caution Attachments not supported - -Uploading and downloading Attachments to QuickBooks Desktop is not supported for any data type. This functionality is not supported by the QuickBooks SDK. - -::: - -## Features and benefits - -Our connector provides a seamless and full featured integration to QuickBooks Desktop. - - - -## Initial setup - -Before your SMB users can download and install the on-premise connector, you'll need to perform the following tasks in the Codat Portal. - -### 1. Add your branding - -Add your company branding: this is used in the link flow and in the connector app. - -From the SMB user's perspective, they'll see the connector app as being owned and branded by you, rather than by Codat. - -### 2. Configure the link flow - -You can choose to configure the built-in Codat link flow for the connector. This will create a download link for the connector and provide the unique company ID (used as the license key) for each of your SMB users. - -Here's how that looks to your users: - -![](/img/old/c266e47-qbd-connector_download-page-end-of-link-flow.png) - -Alternatively, you can choose to build this functionality yourself using the Codat API. This involves calling the QuickBooks Desktop connector download endpoint (provided in the data connection response) and the customer ID. This allows you to maintain the look and feel of your company's brand, or to implement a specific workflow. - -### 3. Enable the connector - -Enable the QuickBooks Desktop connector in the Codat Portal. - -1. Select **Settings > Integrations > Accounting**. -2. Click **Set up** next to **QuickBooks Desktop**. -3. Select the toggle to set the integration to **Enabled**. - -## SMB user flow - -Here's how your SMB users interact with the QBD connector. - -- The SMB user downloads the connector as part of the link flow. -- The user needs administrator privileges (admin rights) to run the connector installer. Alternatively, a different administrator can approve the installation and run the connector. -- The SMB user completes some simple steps to complete the installation (as described in [Install the QuickBooks Desktop connector](/integrations/accounting/quickbooksdesktop/installing-the-quickbooks-connector)). In summary, they'll need to: - - Enter their unique license number (their Codat Company ID), which is provided during the link flow. - - Complete some steps to point the connector at the correct accounting software data file on their local machine. - -When installed, the QBD connector doesn’t require any further interaction by the SMB user, and administrator privileges are no longer required. - -The connector has a UI that is accessible from the system tray. Your SMB users do not usually need to interact with this, but there is functionality available for advanced users, such as adding connections to multiple companies, pausing syncs, and manually starting syncs. - -## System requirements - -See [QuickBooks Desktop requirements](/integrations/accounting/quickbooksdesktop/software-and-hardware-requirements) to learn about the supported versions of QuickBooks Desktop, and the hardware, software, environment and networking requirements for running the connector. - -## Install the connector - -See [Install the QuickBooks Desktop connector](/integrations/accounting/quickbooksdesktop/installing-the-quickbooks-connector) to learn how to set up and enable the connector. - -:::info Installation in hosted environments - -[Installation on Right Networks hosted instances](/integrations/accounting/quickbooksdesktop/install-qbd-connector-right-networks) is currently available in beta. - -::: diff --git a/docs/integrations/accounting/quickbooksdesktop/legacy/install-qbd-connector-right-networks.md b/docs/integrations/accounting/quickbooksdesktop/legacy/install-qbd-connector-right-networks.md deleted file mode 100644 index 4ec718a2a..000000000 --- a/docs/integrations/accounting/quickbooksdesktop/legacy/install-qbd-connector-right-networks.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -title: "Install the QuickBooks Desktop connector on Right Networks" -description: "Learn how to install our QuickBooks Desktop connector on Right Networks hosted instances of QBD." -sidebar_label: Installing on Right Networks ---- - -:::caution Right Networks - Beta testing - -Please note, support for installing the QBD connector in Right Networks hosted environments is in beta testing. If you're interested in using this functionality, please contact your Account Manager or Account Executive to find out more and gain access. - -::: - -Your SMB customers can install our QuickBooks Desktop connector on a hosted instance of QuickBooks Desktop (QBD) provided by Right Networks. In a hosted instance, users access QBD through a virtual desktop hosted in the cloud rather than by installing the program locally. - -## Prerequisites for installation - -Your organization must first be approved as a Right Networks independent software vendor (ISV). To request this, contact [cpadula@rightnetworks.com](mailto:cpadula@rightnetworks.com) and state that you are working with Codat. - -To meet Right Networks requirements you must meet one of the below criteria: -- A single Right Networks account with 10 active hosted desktop users that use the app. -- Several Right Networks accounts with a combined total of 25 active hosted desktop users that would use the app. - -Your SMB customers, who will share their data through the integration, must use one of the [supported hosted products](/integrations/accounting/quickbooksdesktop/install-qbd-connector-right-networks#supported-hosted-products) in order to install the connector. - -## Setup overview - -As a Codat client, you need to complete the following tasks to enable your SMB customers to install our QBD connector on Right Networks hosted instances. - -1. Check your SMB customers are using a [supported hosted product](/integrations/accounting/quickbooksdesktop/install-qbd-connector-right-networks#supported-packages). -2. [Customize branding, upload installation files, and test your implementation](/integrations/accounting/quickbooksdesktop/install-qbd-connector-right-networks#customize-branding-upload-app-installation-files-and-test-your-implementation). -3. [Enable the QBD integration](/integrations/accounting/quickbooksdesktop/install-qbd-connector-right-networks#enable-the-qbd-integration) in the Codat Portal. -4. If you're using Link, [enable the Right Networks installation option](/integrations/accounting/quickbooksdesktop/install-qbd-connector-right-networks#optional-enable-right-networks-installation-for-your-smb-customers) in the Link flow. - -:::note Options for SMB authentication - -Instead of using Link, you can provide your SMB customers with separate instructions for installing and licensing the QBD connector in their Right Networks hosted environment. - -::: - -Next, your SMB customers must do the following: - -1. [Connect to QBD and request connector installation](/integrations/accounting/quickbooksdesktop/install-qbd-connector-right-networks#smb-customer-connects-to-qbd-and-requests-connector-installation). -2. [Connect to QuickBooks Desktop on Right Networks](/integrations/accounting/quickbooksdesktop/install-qbd-connector-right-networks#smb-customer-connect-to-quickbooks-desktop-on-right-networks). -3. [Open QBD on Right Networks](/integrations/accounting/quickbooksdesktop/install-qbd-connector-right-networks#smb-customer-open-qbd-on-right-networks). - -## Supported hosted products - -Your SMB customers must use one of the following supported products: - -| Supported product | Provider | -| :-------------------------------------------------------------------------------------------------------------------------- | :------------- | -| [QuickBooks Application Cloud](https://www.rightnetworks.com/quickbooks-hosting/quickbooks-application-cloud/) | Right Networks | -| [QuickBooks Enterprise with cloud access](https://quickbooks.intuit.com/desktop/enterprise/hosting/). **Deluxe tier only.** | Intuit | - -## Customize branding, upload app installation files, and test your implementation - -If Right Networks approve your request to become a registered ISV, they'll provide instructions for uploading your connector app to a secure site. Your connector app files must be approved by Right Networks before your implementation is made live. - -1. Sign in to the Codat Portal. -2. Go to the Organization settings area. -3. Add your organization name, and upload a logo and an ICO file to use as the QBD connector icon. -4. Download your connector app installation files from the Codat Portal and provide them to Right Networks for evaluation. - 1. In the navigation bar, select **Settings > Integrations > Accounting**. - 2. Click **Manage** next to the **QuickBooks Desktop** integration. - 3. In the **Right Networks / QuickBooks enterprise with cloud access** section, click **Download**. The installation files are downloaded to your computer as a ZIP file. - 4. Upload the ZIP file to the secure site as advised by Right Networks. -5. Right Networks evaluate the connector app files. -6. Right Networks provide you with access to a test account in which a QBD instance and our QBD connector are both installed. Use the test account to validate that the implementation works as expected. You'll need to create a test company in the Codat Portal. -7. Inform Right Networks that you want to proceed with the implementation. -8. Right Networks set the implementation to _Live_. - -## Optional: Enable Right Networks installation for your SMB customers - -If you're using Link, you can enable the Right Networks installation path in the Codat Link flow. This lets your SMB customers choose whether to install the QBD connector locally, or in their Right Networks hosted environment. - -1. Sign in to the Codat Portal. -2. In the navigation bar, select **Settings > Integrations > Accounting**. -3. Click **Manage** next to the **QuickBooks Desktop** integration. -4. Select the checkbox named **Enable your customer users to see the Right Networks install guide in the QBD connector download UI**. - - :::note Enabling the checkbox - - This checkbox must be enabled by your Solutions Consultant. - - ::: - -## Enable the QBD integration - -In the Codat Portal: - -1. In the navigation bar, select **Settings > Integrations > Accounting**. -2. Use the toggle to enable the **QuickBooks Desktop** integration. - -You can now send Link URLs to your SMB customers. - -## SMB customer: Requests connector installation - -In the Link site, your SMB customer requests that Right Networks install the Codat connector App to their cloud instance. - -Your SMB customer does the following: - -1. Opens the Link URL. - -2. In Link, they select the **Intuit QuickBooks Desktop / Pro** tile. - - ![Select your accounting software](/img/old/96cef1f-qbd-right-networks-link-flow-select-qbd-accounting-software.png "Select your accounting software") - -3. On the **How do you use QuickBooks Desktop?** step, they select the second option: - - **I'm accessing QuickBooks Desktop hosted in the cloud by Right Networks, including QuickBooks Desktop Enterprise with cloud access**. - -4. The **Connection steps** dialog is displayed, containing instructions for your SMB customers to request installation of the connector App and access their license key. - - ![Connection steps](/img/old/6074fa3-right-networks-dialog-connection-steps-new.png "Connection steps") - -5. Finally, they copy their license key from the **License key** box to use in the next procedure. - -When the connector App is installed, a shortcut named **QuickBooksDesktopUI.exe** appears on the SMB customer's cloud instance Start menu. They can now connect to QBD by following the next procedure. - -## SMB customer: Connects to QuickBooks Desktop on Right Networks - -Next, your SMB customer does the following: - -1. Opens the **QuickBooksDesktopUI.exe** application from their Start menu. - - :::note - - If the app doesn't open, they can try opening it from the Windows system tray. - ::: - -2. In the connector app setup wizard, clicks **Add new connection**. - -3. Enters their license key from Link into the **License Key** box (see step 5 of the previous task), then clicks **Next**. - - - -4. To finish installing the connector, they must follow the steps in the **Setup Connection** and **Verify Connection** steps of the wizard. For more details, see procedures 3–5 in [Install the QuickBooks Desktop connector](/integrations/accounting/quickbooksdesktop/installing-the-quickbooks-connector). - -To verify the connector is running, your SMB customer should look for the **QuickBooks Connector** app in the Windows system tray. The app uses your organization's logo. - -## SMB customer: Opens QBD on Right Networks - -Next, your SMB customer opens the **QuickBooks Desktop** application. - -The QuickBooks Desktop connector is now ready to use. diff --git a/docs/integrations/accounting/quickbooksdesktop/legacy/installing-the-quickbooks-connector.md b/docs/integrations/accounting/quickbooksdesktop/legacy/installing-the-quickbooks-connector.md deleted file mode 100644 index 206eb37cf..000000000 --- a/docs/integrations/accounting/quickbooksdesktop/legacy/installing-the-quickbooks-connector.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -title: "Install the QuickBooks Desktop connector" -description: "Guide for SMB users to install our QuickBooks Desktop on-premise connector." -sidebar_label: Install the connector ---- - -:::info QuickBooks Desktop installation checklist - - Check version is supported - -Your customer needs to be running a supported version of QuickBooks Desktop Pro, Enterprise or Professional. QuickBooks for Mac is not supported. - - Check operating system requirements - -The connector works on Windows 10, Windows 11, and Windows Server 2019, and may not work correctly on earlier versions of Windows. Your customer will need administrator permissions on your computer to complete the installation. - - Consider antivirus and firewall - -The user's local antivirus or firewall settings may prevent the download and running of the connector. To resolve, you need to allowlist the connector. - -::: - -To install the QuickBooks Desktop connector, the user who is connecting their company data must complete the following tasks: - -1. [Download the connector](/integrations/accounting/quickbooksdesktop/installing-the-quickbooks-connector#1-download-the-connector) - -2. [Launch the connector and enter the licence key](/integrations/accounting/quickbooksdesktop/installing-the-quickbooks-connector#2-launch-the-connector-and-enter-the-licence-key) - -3. [Verify files, select a region and initiate Link](/integrations/accounting/quickbooksdesktop/installing-the-quickbooks-connector#3-verify-files-select-a-region-and-initiate-link) - -4. [Authorize the connector to access QuickBooks](/integrations/accounting/quickbooksdesktop/installing-the-quickbooks-connector#4-authorize-the-connector-to-access-quickbooks) - -5. [Wait for the connector to complete first link](/integrations/accounting/quickbooksdesktop/installing-the-quickbooks-connector#5-wait-for-the-connector-to-complete-first-link) - - -:::info Linking companies using the QuickBooks Desktop connector - -The QuickBooks Desktop connector must be run on the same computer as the QuickBooks Desktop application. Advise your client to install the connector on the computer they normally use when working with QuickBooks Desktop. - -Before they start the linking process, the user must open QuickBooks Desktop and log in to the company they want to link. - -If the user works with a hosted instance of QuickBooks Desktop (e.g. Right Networks), they must first be approved by Right Networks before proceeding. Please review our [prerequisites documentation](/integrations/accounting/quickbooksdesktop/install-qbd-connector-right-networks). - -::: - - -## 1. Download the connector - -First, the user downloads the connector from a Codat Link URL. - -:::info Connector download file - -The QuickBooks Desktop connector is packaged as a .exe file. To increase your client's trust in the download, the filename is prefixed with your company name (the name of the company the user is connecting their data to). For example: `YourCompanyName-quickbooksDesktop-connector.exe`. Symbols in the filename are replaced with dashes. - -Additionally, the file is signed with an Extended Validation Code Signing Digital Certificate issued by GlobalSign. - -::: - -If you're using the Codat Link flow, the user can download the connector after they've selected QuickBooks Desktop as their accounting software. - -If you've built your own Link flow, the **linkUrl** field on the company's QuickBooks data connection will initiate the installer download. - -**Administrator privileges (admin rights) are required to run the connector.** When you add a new company, a user with admin rights needs to run the installer, which will display the following dialog: - - - -The user copies their license key (the same as their _CompanyId_ in Codat) to use in the next step. - -:::info What if the SMB user isn't a Windows admin? -If the SMB user isn't a Windows administrator on their own system, a different administrator must approve the installation and run Quickbooks Desktop using the **Run as Administrator** option, both during the initial link and when adding companies to an existing connector. When installed in this way, the connector is only able to sync data while Quickbooks Desktop is closed. -::: - -## 2. Launch the connector and enter the licence key - -Next, the user runs the downloaded file to start the connector. They're prompted to enter their licence key, which is the same as their _CompanyId_ in Codat. - -:::info Link flows and licence keys - -The licence key is only shown to the customer automatically if you're using the Codat Link flow rather than building your own Link flow. -::: - - - -They should paste the licence key copied in the previous task into the **Licence Key** box, and then click **Install**. - -## 3. Verify files, select a region and initiate link - -Next, the user needs to verify their data and selects their geographical region – either Canada, UK, or US – and then clicks **Link with [company name]**. - - - - - -The connector initiates the connection with QuickBooks Desktop and the user is prompted to grant access. - - - -:::info Open one copy of QuickBooks -An error is displayed if Quickbooks Desktop is not open, or multiple instances of Quickbook Desktop are running on the same machine. -::: - -## 4. Authorize the connector to access QuickBooks - -In QuickBooks Desktop, the user is prompted to allow the application to read and modify the QuickBooks company file. Any of the **Yes** options will allow the connector to work. However, for the best user experience, we recommend choosing **Yes, always** to allow access even if QuickBooks Desktop is not running. - -Options might vary between QuickBooks versions but are similar to: - -- **No** -- **Yes, prompt each time** -- **Yes, whenever this QuickBooks company file is open** -- **Yes, always; allow access even if QuickBooks is not running**. - -In all cases, we recommend choosing the option that allows the most access to QuickBooks so that you can sync data as easily as possible. - - - -Check the details in the **Access Confirmation** dialog, and then click **Done**. - - - -## 5. Wait for the connector to complete first link - -Once access to QuickBooks has been granted, the connector will process the datasets you have chosen to _fetch on first link_ (see [Data Sync Settings](/core-concepts/data-type-settings)). Upon completion of the first link, a message will be shown to the user confirming that their data has been synchronized. - -If you have chosen to have your connectors perform a one-time synchronization, the connector will uninstall itself and set the company status to _deauthorised_. - -If you have chosen to install your connectors for ongoing synchronizations, the connector will periodically process any dataset syncs or write operations you have queued using the Codat portal or API. The connector will also be set to automatically start when the system reboots. - - - -## Installation path - -The QuickBooks Desktop connector is installed in Program Files inside a directory named with your client name in Codat. - -``` - C:\\Program Files (x86)\\\\QuickBooks-connector -``` - -For example: - - - - -## Uninstalling - -If your user wants to remove the QuickBooks Desktop connector and disconnect the service, there are two ways they achieve this on their computer. - -### System Tray - -The connector can be deleted from the system tray by selecting the up arrow on the Windows taskbar this will reveal any hidden icons, and the user will be able to select the connector if they use the secondary mouse button (left click) a pop up with dialog will appear. -From this menu, the user would be able to click on Uninstall QuickBooks Connector, this launches a pop up where the user can confirm they wish to uninstall the connector. - -### System Settings - -The other way users can uninstall the connector is to go to Windows Settings > Apps & features from the menu and then search for the connector in the filter form - -The QuickBooks Connector will then show as a result in the list, and the user can select Uninstall to remove the connector. - -### Removing the App Certificate - -Once the user has removed the Connector, they may still want to remove the application certificate. To do this they should open QuickBooks and go to: - -Edit > Preferences > Integrated Applications > Company Preferences - -You will then need to select the application named 'QuickBooks Connector' and click Remove. diff --git a/docs/integrations/accounting/quickbooksdesktop/legacy/quickbooks-desktop-faq.md b/docs/integrations/accounting/quickbooksdesktop/legacy/quickbooks-desktop-faq.md deleted file mode 100644 index 8c4e65c90..000000000 --- a/docs/integrations/accounting/quickbooksdesktop/legacy/quickbooks-desktop-faq.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "FAQs" -description: "Frequently asked questions about our QuickBooks Desktop on-premise connector" -sidebar_label: FAQs ---- - -## Do I need to run the QBD connector on the same machine where QuickBooks is installed? - -Yes. Any user journey should make it clear that the user must run the connector on the machine they use to access QuickBooks. Functionality to email a link to the connector to a third-party (such as an accountant) can help to reduce these issues. - -## Can a user install multiple QBD connectors on the same machine? - -Yes. Multiple companies can be synced from the same computer. If a user would like to sync multiple companies, they should complete the link flow once per company, ensuring that they are logged in to the correct QuickBooks company when they confirm that QuickBooks is open and logged in. - -## Does the QBD connector require administrator rights? - -Yes, the connector requires administrator privileges (admin rights) in order to install. Admin rights are not required to run the connector after installation. - -You might need to request permission to install the connector from your IT department, in accordance with your company's internal processes. - -## Are there any limits on reading historical data from QBD? - -Yes. The QBD connector can read data that is dated from 1 January, 1980 onwards only. Data older than this can't be read using the integration. diff --git a/docs/integrations/accounting/quickbooksdesktop/legacy/quickbooks-desktop-troubleshooting.md b/docs/integrations/accounting/quickbooksdesktop/legacy/quickbooks-desktop-troubleshooting.md deleted file mode 100644 index 43bd9b0e7..000000000 --- a/docs/integrations/accounting/quickbooksdesktop/legacy/quickbooks-desktop-troubleshooting.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -title: "Troubleshooting" -description: Common issues with QuickBooks Desktop ---- - -## Accessing logs - -The connector logs can assist when diagnosing issues for QuickBooks Desktop. There are two sets that are useful in our investigations. - -#### QuickBooks Connector Logs - -The logs files created by the connector itself are located in: - -```C:\Program Files (x86)\\QuickBooks-connector\logs\connector.log``` - -It can also be useful to get the link.json file which is located in: - -```C:\Program Files (x86)\\QuickBooks-connector\link.json``` - -You can also check the log files location by signing in to the Codat Portal, then navigating to Monitor (1) > Health > Offline connectors (2) then selecting searching for and selecting the company. On the System Tab (3) and you will be able to see the connector location in the Computer information (3) section. - -#### QuickBooks Logs - -There are also logs created by QuickBooks itself which are located in: - -```C:\ProgramData\Intuit\QuickBooks\qbsdklog.txt``` - -## The connector can't be downloaded or run due to corporate policy or antivirus software - -Some corporate policies or particularly stringent anti-virus software may block the connector from running. Codat actively submits the connector files with supporting information to common anti-virus packages so that it is not incorrectly marked as a potential threat. - -If any of your customers have issues regarding anti-virus blocking please report these to us using your normal Codat support channel. - -## Syncs and write operations are still marked as queued or pending even though the connector is running - -The connector's ability to access data is dependent on permissions granted by the User, normally at time of installation. - -![](/img/old/f336207-c650d8d-QBD-Auth.png "c650d8d-QBD-Auth.png") - -If the user has not given the connector the permission to _always_ modify the company data file (allowing access even if QuickBooks is not running), the connector will be unable to process any queued syncs or write operations, unless the user has QuickBooks open and is logged in to the relevant company file. The connector will periodically check whether the correct file has been opened and will complete the queued/pending items as soon as possible. - -## The first link was successful but the company became deauthorized immediately after the datasets completed - -You can configure the QuickBooks Desktop connector to run in one of two modes: - -- One-time sync -- Ongoing sync - -For more information about these modes, see [On-premise connector setup](/integrations/accounting/offline-connectors). If one-time sync is configured, the connector will be uninstalled once the sync has completed, and the company will transition to deauthorized status. - -If you'd like to enable ongoing syncs with the company, update your connector settings, and ask the SMB user to complete the linking process (i.e. downloading and installing the connector) again. - -:::note Re-linking and company IDs - -> The same Company ID must be used when re-completing the linking process. - -::: - -## The QuickBooks Connector tray icon is red - -![Image](/img/integrations/accounting/quickbooksdesktop/unhealthy-qbd-connector-trayicon.png "Unhealthy QuickBooks Connector Icon") - -If your QuickBooks Connector tray icon is red, this indicates that the connector application is currently not running. - -To restore the connector's functionality, do the following: - -1. Open the Windows Task Manager by pressing `Ctrl+Alt+Del` and selecting **Task Manager**. -2. Go to the **Details** tab in the Task Manager. -![Image](/img/integrations/accounting/quickbooksdesktop/task-manager-details.png) - -3. Find the process named `QuickbooksDesktopUI.exe`, then right-click on this item and click **End Task**. -4. Open the Windows Task Scheduler. You can find this by opening your start menu and entering `Task Scheduler`. -5. Find the two tasks named `QuickbooksDesktop_{YOUR_CLIENT_NAME}` and `QuickbooksDesktopUi_{YOUR_CLIENT_NAME}`. The two processes shown below are from our internal development build; your client name would replace "Codat Engineering - Integration". -![Image](/img/integrations/accounting/quickbooksdesktop/task-scheduler-qbd-tasks.png "Task Manager entries for QuickBooks Connector processes") - -6. Right-click and select **Run** on the two tasks in the following order: - 1. `QuickbooksDesktop_{YOUR_CLIENT_NAME}` - 2. `QuickbooksDesktopUi_{YOUR_CLIENT_NAME}` - -The tray icon should no longer be red, which indicates a healthy connection. If the tray icon does not reappear or is still red, you can try restarting your machine. - -![Image](/img/integrations/accounting/quickbooksdesktop/healthy-qbd-connector-trayicon.png "Healthy QuickBooks Connector Icon") - - -If the tray icon remains red after a restart, contact our Support Team. - -## Reinstalling the Application Certificate - -In Order for the connector to link to the QuickBooks desktop datafile, the user needs to have accepted a QuickBooks Application Certificate. - -Typically this will pop up as a prompt the first time the user downloads the connector and looks like this - - -The user must select "Yes, always; allow access even if QuickBooks is not running", as this will allow the Connector to communicate with the QuickBooks file even when the users QuickBooks session is not active. - -To get back to the certificate settings within QuickBooks go to: - -Edit > Preferences > Integrated Applications > Company Preferences - -You will then need to select the application named 'QuickBooks Connector' and click remove. - -Once you have removed the certificate, you can then re-run the installation process for the connector - either by running the downloaded (this might be in the downloads folder and might be named `YOUR_COMPANY-quickbooksdesktop-connector`) or alternatively by re-visiting the connector download page. During the installation process you will then receive a prompt asking for permission from the application certificate. - -## Whitelisting - -### Webroot SecureAnywhere desktop app - -Some companies using our offline connectors and Webroot SecureAnywhere anti-virus have reported experiencing difficulties when trying to sync data. - -We have identified that Webroot SecureAnywhere sometimes blocks updates to the QuickBooks desktop connector as it is incorrectly identifying connectors as a possible threat. - -We recommend white-listing the folder where the connector has been installed to prevent Webroot SecureAnywhere blocking the connector from running after an update. - -To white-list the connector folder, your users should: - -Open their Webroot SecureAnywhere Desktop app and click on Settings icon in the PC Security section. -Navigate to the 'Whitelisted Scripts' tab and click on Advanced Whitelist -Using the tree hierarchy, select the folder in which the connector has been installed (C:\Users\YOUR_USERNAME\AppData\Local\Codat) and click Select. - -*Note: We recommend that the user selects the whole folder and not just individual connector locations. * - -Double-check that the folder where the connector is located is displayed in the list and close the Webroot SecureAnywhere desktop app. diff --git a/docs/integrations/accounting/quickbooksdesktop/legacy/software-and-hardware-requirements.md b/docs/integrations/accounting/quickbooksdesktop/legacy/software-and-hardware-requirements.md deleted file mode 100644 index d16c617c6..000000000 --- a/docs/integrations/accounting/quickbooksdesktop/legacy/software-and-hardware-requirements.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: "QuickBooks Desktop requirements" -description: "Software, hardware, environment and network requirements and configurations" -sidebar_label: Requirements ---- - -## Supported QBD versions - -Codat follows Intuit’s service discontinuation policy for QuickBooks Desktop and fully supports the following versions, version tiers and special editions: - -The latest three versions of: - -- QuickBooks Desktop (UK) -- QuickBooks Desktop (US) -- QuickBooks Desktop (Canada) - -Version tiers: - -- Accountant -- Pro -- Pro Plus -- Premier -- Premier Plus -- Enterprise - -Special editions: - -- Contractor edition -- Manufacturing and Wholesale edition -- Accountant edition -- Professional Services edition -- Nonprofit edition - -Codat does not fix issues related to older versions of the software. Please upgrade to the latest version of QuickBooks Desktop to continue to use our QuickBooks Desktop connector. - -If you experience compatibility issues with companies using older versions of the software, Codat support will advise you to upgrade to a supported version. - -:::caution QuickBooks Desktop for Mac - -Codat does not currently support Intuit QuickBooks for Mac OS. Only the QuickBooks Desktop for Windows versions listed above are supported. -::: - -## Supported QBD modes - -The QBD connector works with QBD running in single-user or multi-user mode. In QBD multi-user mode, users on different machines with different QBD data files can sync data to Codat. - -## Limitations - -The following limitations apply when using the connector with QBD running in either single-user or multi-user mode. - -If QuickBooks Desktop is open on the SMB user's machine, the open QuickBooks company file must be the same as the company file that's configured for the connector. - -Only one instance of QBD can be open on a user's machine at a time. - -If QuickBooks Desktop is closed on the user's machine, syncing will only occur if the relevant option is selected when you [authorize the connector to access QuickBooks](/integrations/accounting/quickbooksdesktop/legacy/installing-the-quickbooks-connector#4-authorize-the-connector-to-access-quickbooks). - -## Supported operating systems - -The Codat QuickBooks Desktop Connector is supported for QuickBooks running on Windows 10 or Windows 11 with the latest service pack(s) installed. - -Users have successfully run the connector on older versions of Windows; however, we do not officially support this due to Microsoft's withdrawal of support for these operating systems. - -The connector will not run on Mac OS. - -:::note Supported environments - -Our QuickBooks Desktop Connector is designed to work in single-tenant environments only, where one Windows user logs on to the same computer they use to access QuickBooks Desktop. - -[Installation on Right Networks hosted instances](/integrations/accounting/quickbooksdesktop/legacy/install-qbd-connector-right-networks) is currently in beta. -::: - -## Hardware requirements - -You will need to ensure that the host machine meets Intuit's recommended specification for running QuickBooks Desktop. - -If you have a large number of companies, or particularly large company files, you should pay special attention to the consumption of CPU, memory, disk and network resources on the host machine and ensure there is sufficient headroom. - -## Firewall rules - -The QuickBooks Desktop connector communicates over port 443 to URLs hosted on `https://quickbooksdesktop.codat.io` in production. - -If you experience problems with the connector transmitting data, please add the following URLs to your firewall allow list: - -`https://quickbooksdesktop.codat.io/` - -`https://connectors.codat.io` - - diff --git a/redirects.config.js b/redirects.config.js index 42b18ea40..03068035b 100644 --- a/redirects.config.js +++ b/redirects.config.js @@ -457,10 +457,7 @@ module.exports = { }, { from: "/integrations/commerce/commerce-platform-keys", to: "/integrations/commerce/overview" - }, { - from: "/integrations/accounting/quickbooksdesktop/install-qbd-connector-right-networks", - to: "/integrations/accounting/quickbooksdesktop/legacy/install-qbd-connector-right-networks" - }, + }, // sfc { From a242f773ab3bdaa33b02c05ceba7c8c54be8ec43 Mon Sep 17 00:00:00 2001 From: Polina <112084241+pzaichkina@users.noreply.github.com> Date: Mon, 13 Jan 2025 13:16:10 +0000 Subject: [PATCH 2/2] corrected rightworks name --- .../quickbooksdesktop/accounting-quickbooksdesktop.md | 2 +- .../quickbooksdesktop/installing-the-quickbooks-connector.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/integrations/accounting/quickbooksdesktop/accounting-quickbooksdesktop.md b/docs/integrations/accounting/quickbooksdesktop/accounting-quickbooksdesktop.md index d9e2738ab..7cc184530 100644 --- a/docs/integrations/accounting/quickbooksdesktop/accounting-quickbooksdesktop.md +++ b/docs/integrations/accounting/quickbooksdesktop/accounting-quickbooksdesktop.md @@ -7,7 +7,7 @@ Our QuickBooks Desktop connector enables SMBs who use QuickBooks Desktop to shar - QuickBooks Desktop app - QuickBooks Enterprise Cloud -- Right Networks +- Rightworks The connector utilizes the Intuit Web Connector, a Windows application that runs on the SMB user's local machine. diff --git a/docs/integrations/accounting/quickbooksdesktop/installing-the-quickbooks-connector.md b/docs/integrations/accounting/quickbooksdesktop/installing-the-quickbooks-connector.md index e390da1da..80d287ad7 100644 --- a/docs/integrations/accounting/quickbooksdesktop/installing-the-quickbooks-connector.md +++ b/docs/integrations/accounting/quickbooksdesktop/installing-the-quickbooks-connector.md @@ -42,7 +42,7 @@ Before they start the linking process, the user must open QuickBooks Desktop and If the user selects "QuickBooks Desktop app" on the initial Link screen, they will be directed to download the web connector from a Codat Link URL. -If they select "QuickBooks Enterprise Cloud" or "Right Networks", they will immediately proceed to the [next step](/integrations/accounting/quickbooksdesktop/installing-the-quickbooks-connector#2-run-the-configuration-file-to-authorize-access-to-quickbooks) as these hosted environments already have the web connector installed. +If they select "QuickBooks Enterprise Cloud" or "Rightworks", they will immediately proceed to the [next step](/integrations/accounting/quickbooksdesktop/installing-the-quickbooks-connector#2-run-the-configuration-file-to-authorize-access-to-quickbooks) as these hosted environments already have the web connector installed. :::info Connector download file