Documente Academic
Documente Profesional
Documente Cultură
QODBC
QODBC Limited Use Software License.......................................................................................................... 3 Introduction..................................................................................................................................................... 5 Installation ...................................................................................................................................................... 7 Testing Driver Capabilities........................................................................................................................... 19 Tutorials and Documentation....................................................................................................................... 20 Configuring QRemote after QODBC is setup .............................................................................................. 21 Connecting with 64 Bit Applications............................................................................................................ 26 QODBC Frequently Asked Questions.......................................................................................................... 34 QODBC Support............................................................................................................................................ 34 QODBC Credits............................................................................................................................................. 36
QODBC
QODBC
QODBC
Introduction
What is ODBC?
ODBC (Open Data Base Connectivity) is a specification designed by Microsoft to: 1. Allow Windows applications to access multiple data sources through a single method with no regard for various file formats; 2. Overcome the problem of different databases having different means of providing access to the information contained within them and; 3. Simplify access requirements so that the user no longer requires a high level of skill to access databases. ODBC also provides the following benefits: 1. SQL (Structured Query Language) is promoted as the method for accessing data through ODBC; 2. It simplifies application development, making access to multiple databases easier; 3. It insulates applications from changes to underlying network and database versions. Modifications to networking services, servers, and databases will not impact current ODBC applications; 4. The Corporation's investment in the existing database is protected; 5. The developer's acquired database programming skills are protected; 6. Making this easily accessed data available to some users can increase productivity and is a basis for more informed decisions. Microsoft, along with a few other database manufacturers designed the ODBC driver to provide a standard, consistent and simple process of connecting a wide range of databases. Vendors of ODBC drivers (like this one) follow the specifications for ODBC so that any ODBC compliant application can access the data available through the driver. ODBC compliant applications include: Microsoft SQL Server, Microsoft Access, Word, Excel, PowerBuilder, Borland Delphi, Crystal Pro Report Writer, Visual Basic and hundreds of others. The placement of this driver can be seen in the illustration below.
QODBC
What is QODBC?
QODBC is an ODBC driver (DLL) for QuickBooks format files. QuickBooks by default stores its data in its own proprietary DBMS file format (.qbw). This driver allows users of any ODBC compliant front-end application to read and write data contained in QuickBooks format files similarly to any other ODBC enabled database. QODBC works by accepting SQL commands through the ODBC interface, then converting those calls to navigational commands to the QuickBooks DBMS and returning record sets that qualify for the query results.
Best of all, this driver is transparent and works in exactly the same fashion of ODBC drivers from other vendors. QuickBooks application developers now can offer this driver to their customers to allow them direct access to data important to them through custom third party applications. Business personnel who require up-to-the-minute data to make on the fly business decisions will have that real-time data instantly available to virtually hundreds of desktop applications.
QODBC
Installation
Initial Setup
If you have downloaded this program by modem, run the self-extracting executable in a temporary directory to extract the installation files. Don't forget to read the "Readme" file during installation for the latest information on QODBC setup, new features and other driver information. Unload Microsoft Office toolbar from memory, as well as any other Windows applications that can impair installation. Click on the Install program from within Windows to install the driver. You will be asked to select the Region of QuickBooks you are using, this should match the version of the driver you purchased. Next select the destination directory to install the QODBC support files. Click "OK" to continue.
The FLEXquarters QODBC Driver for QuickBooks has been successfully installed onto your computer. You can begin to use it immediately because it will run as a free 30 day evaluation edition, serving as all editions of QODBC depending on how it is configured.
To install a full purchase QODBC registration code to an evaluation copy from a previous download, see the Icons that have been added to your Start Menu under QODBC Driver for QuickBooks The first step in configuring the driver is to click on the ODBC Setup Screen icon and the following screen will be become available.
QODBC
Use the company file thats now open in QuickBooks allows QODBC to use the company file that you have open and allows you to switch between files without having to create separate DSNs for each file. Locate a company file is the path where your QuickBooks data file resides. For example: C:\Program Files\Intuit\QuickBooks Pro\Myapp.qbw. The browse button () will let you choose your QuickBooks company file from the folder it is in. Data Source Name is a display name for your QuickBooks data (QuickBooks Data, QBPRO, My QB Data, etc.) QuickBooks Data is the default DSN. Mode when opening includes multiple ways of opening a QuickBooks file, and this setting allows you to determine how QODBC should open each company file. Same as company file If you select Follow Company File, we will simply use whatever mode is currently set on the company file. Multi-user mode Selecting Multiuser Mode will set the file to Multi-user status, where multiple users can update the file simultaneously. Single-user mode If you require exclusive write access to the file, select Single User Mode. Test Connection to QuickBooks will determine if you have a proper installation and settings with QuickBooks and a company file open. The following popup screen should appear:
QODBC
Messages Tab
Messages allows you to review message logs from QODBC regarding errors and issues communicating with QuickBooks, Clear these messages, and review messages produced by the QuickBooks SDK interface. Detail Tracing (Slow) creates a trace log of exactly what QODBC is doing in the background with the application using it for debugging purposes. Make sure the log is turned off when not needed as these logs can use up large amounts of disk space. Display Optimizer Status Panel will display the progress of optimization on the data, this is especially helpful on large data files being reloaded in their entirety. Verbose Optimizer Status causes the Optimizer panel to come up whenever optimizer of any kind happens. The normal check box only pops up the optimizer when doing full update or reload all. Display Driver Status Panel when selected shows exactly what QODBC is doing when accessing the QuickBooks data and provides a good assessment of speed using optimized data and non-optimized data. Status Icon displays a green Q in your system tray when QODBC is in use. It allows you to interact with QODBC while you are connected to QuickBooks. Warning Bubble When this is checked the QODBC icon will display a warning message reminding you that QODBC is still working if QuickBooks takes longer than 30 seconds to return information.
QODBC
Optimizer Tab
Use Optimizer brings some data to a local cache to increase retrieval performance for queries. Here you can adjust where optimizations are stored and when they are updated. Check to activate the Optimizer. Optimizer Database Folder specifies where the local data store will be saved on disk. The default location is under the folder where you specified QODBC to be installed. The data will be stored in a file in this folder with a name similar to the company file name. If you opt to store that data somewhere other than the default click the browse button and select the destination folder. With very large company files we suggest running synchronization after hours. Keep my optimized data up to date as of when you choose the optimizer to synchronize itself with your Company data. Depending on how static your data need is and the size of the file, you can opt for various time frames of synchronization. The farther down the list you go the less synchronization will occur and your queries will run much faster, but will be using less current data than the company file itself. The start of every query is the default setting using the most current data. If your reporting needs require the latest up to the minute data and speed is not the primary focus use this default setting. The end of yesterday is used for a better balance between speed and data updating and would be the option that works best for most users. It only has to synchronize each table once per day and the data will be current as of the end of the previous day. The end of last month option is a great speed boost for running last month or last years reports. It does not need to synchronize again to get the data.
QODBC
10
The last time I pressed one of the load data buttons option allows you to control the synchronize timing. Synchronizing only occurs when you manually run it by pressing the Load Update Data. For balances and stock quantities: the option "Nulls" - will return NULLs for all fields that cannot be kept in sync, "Dirty Reads" - means return the most current value that was loaded into the optimizer cache, and "Real Time" uses the slower method to get the data directly out of QuickBooks making sure you get the most current value for the requested fields. (Real Time is the previous method used). Optimize data after an Insert or Update: causes QODBC to do "Load Updated Data" after an insert or update is executed on a table. Useful for programmers who want to test that their data has successfully been written to QuickBooks. Multi-Table Sync: This option is unchecked by default for all non-USA enterprise users. If checked, the QODBC optimizer will use other tables to re-sync tables; however, this will slow down performance. When off all Multi-Table Sync fields become Real-Time fields. (Similar to version 7.0.x) Note: This feature is basically ignored and set to unchecked if the version is QBOE or SDK is less than v3 (used by QuickBooks 2004 USA and all QuickBooks versions outside USA). Prior to SDK v3 the other multi-sync tables did not exists so using real data for those fields is safer. Load Updated Data This button is used to synchronize your optimized data with your company file. This will only load the data that has changed since the last automatic or manual synchronization. Reload All Data This button is used to completely rebuild the optimized data from scratch. It is useful when you start with a new company if you do not want to synchronize the tables as you first encounter them and make sure your data is 100% current.
Server Tab
Use DCOM Servers for Web editions of QODBC require QuickBooks to be running on the Server Console. They are more secure and require no extra overhead but are more rigid on how it is setup and it can be difficult to configure the security of the DCOM servers. The other option for web configuration is the Remote Connector. See http://www.qodbc.com/QODBCweb.htm for detailed information for Web Edition setup.
QODBC
11
Remote Data Sharing is a component that allows an integrated application on a machine without QuickBooks to access another machine with QuickBooks and the company file remotely, typically on a Local Area Network. (Note: RDS replaces the IBiz remote connector in previous editions of QODBC) See http://www.qodbc.com/qodbcrds.htm for setup instructions.
QODBC
12
Connect to QuickBooks Online Edition with QODBC and a front-end application such as MS Excel, MS Access or Visual Basic to name a few applications, to Read and or Write data to your QBOE data file. See http://www.qodbc.com/qodbconline.htm for additional setup instructions.
Advanced Tab
The selected defaults in the Advanced settings should apply to most users and need not be changed. Reconnect Delay Is an amount of time to wait after a disconnect when using the remote connector. This allows QuickBooks to fully unload it if it is being loaded in the background on the Host Remote Connector, before you connect again. Maximum Field Name Length is set to the QuickBooks limitation but certain applications like Delphi can not handle this limit and must be set accordingly. Use Case Sensitive RefNumber Searches when checked means a refnumber of 'ABC' and 'abc' will be different, but means QuickBooks can use an index internally for a search instead of a complete table scan. (Note: this feature applies to versions of QuickBooks 2005 and higher) Include Raw Files if checked will display both filtered and raw data formats. QODBC formats data into SQL field types more easily used in programming languages for math and comparison operations. The Raw tables return the data as it is returned to QODBC without modification. Run 2.1 ODBC Compatibility is checked for certain applications that require ODBC 2.1 Compatibility to use QODBC. Anything that uses the Java ODBC library, like ColdFusion, requires this option turned on or recordsets will be returned with no rowsets or only 1 rowset.
QODBC
13
Simulate Transaction Support for SQL Server will turn transaction support on so that SQL Server will allow updates when using QODBC as a linked server. QODBC still does not support transactions, but simulates the turning on and off of transactions. Use Iterators and Interator or Chunk Size fields allows you to turn off iterators. This is needed on systems like MS-SQL and Web Servers that use multiple threads. Convert All Numerics to VARCHARS is useful for loading tables in Access when Access chooses the wrong size numeric field sizes. Access will give an error data too large for field DECIMAL. When you get this error, switching this option on will allow all the data to be loaded into Access as strings. The data can be converted as needed by your programs. Turn on Remote Connector will resurrect a tab for the Ibiz connector which allows QODBC to talk to QuickBooks anywhere and transfers data in an un-encrypted fashion so it is not recommended for Internet applications, but primarily for LAN applications. See http://www.qodbc.com/QODBCremote.htm for more information on this feature. Add XML to trace log is an advance option to put more information in the trace log to help the support team diagnose a problem. It should not be used unless directed by the support staff, as this will generate extremely large amounts of data in the trace log. Integrated Application Defaults are the defaults set in the integrated applications dialog within QuickBooks and are available in the US versions of QuickBooks 2005 2012.
Activate/Deactivate Tab
QODBC
14
This tab allows you to purchase a CDKey, activate a license with the CDKey or deactivate a currently active license and move that license to a new machine.
Activate is the online option for entering the CDKey that was issued to you upon purchasing the product to fully activate QODBC from the evaluation version to either the full Read Only, Read/Write or Web Edition that has been purchased. If you do not have internet access to activate the product, you can use the phone option to supply your reseller or distributor with the information to activate the product for you.
Deactivate is the online method of deactivating a currently registered version of QODBC for the transfer of the product to another machine. This process will take 24 to 48 hours before your CDKey account is credited with the deactivated license and you can reactivate the license on a different machine. If internet access is not available from the registered machine, you can use the phone option to supply your reseller or distributor with the information to deactivate the product CDKey for you.
QODBC
15
About Tab
About screen shows the QODBC version currently installed, whether it is an evaluation copy or fully registered. The first letter in the serial number denotes what type of license is installed, the 2nd & 3rd digits the QODBC version and the fourth denotes what version of QuickBooks (US, CA, UK, AU) the license is compatible with. (The serial number may be required for upgrades, rebate offers, technical installation support or the Help Desk system.) Check Website for Updates will launch your internet browser to our web site and check to see if you have the latest available version of QODBC installed on your machine. You can view the Readme file for the list of all the latest features in the current version of QODBC and download the latest updater should you be using an older version of the driver.
QODBC
16
Click on the VB Demo icon to launch the demo. To establish a connection: From the menu bar select "Connection" / "Add a new connection ", select the QuickBooks Data Source you want, Click "OK.
After you click OK a QODBC splash screen will pop up if you are using the QODBC Evaluation copy of the product, and a mouse click will allow you to continue. No such splash screen appears in the registered version. When the driver starts, QuickBooks will ask permission for the driver to access your QuickBooks data. Answer "Yes, Always to this and the QODBC driver is added to the Integrated Application list. This will allow applications to integrate with QuickBooks data when QuickBooks is running on the desktop. There may be instances in which you want an integrated application designed to share data with QuickBooks to access QuickBooks files automatically, without user intervention. This might permit, for example, a particular application to run during the night when there is no other activity on the company file. Also QuickBooks need not be running on the desktop for ODBC compliant applications to access the data files while set in this mode.
QODBC
17
Note: QODBC does have a digital certificate (right click on fqqb32.dll/properties in the Windows>System 32 Directory) but since another application is trying to access QuickBooks through QODBC and QuickBooks does not know what the application is, it generates that message.
Allowing an application to login automatically To change any of these options, from the QuickBooks Edit menu, select Preferences, and then select Integrated Applications.
QODBC
18
Click the Company preferences tab and make sure that the "Don't allow any applications to access this company file" checkbox isn't checked. The "Notify the user before running any applications whose certificate has expired" checkbox can be checked. If it is, however, automatic access will be suspended if the application's certificate expires. Select the FLEXquarters QODBC driver you want to run automatically and click Properties.
Check "Allow this application to access this company file." Uncheck "Prompt before Allowing Access." Check "Allow this application to log in automatically." Check Allow this application to access Social Security Numbers, cc information and other personal data if appropriate.
This procedure need only be done once for QODBC to be able to connect with the QuickBooks data from any other ODBC compliant application in the future. Additionally if you plan to modify the files, you will also need to choose Multi-User Mode from the Files menu in QuickBooks to allow this.
QODBC
19
To disconnect, you can either select "connections" / "remove the connection" or Click the "disconnect" button.
QODBC
20
Double click the QRemote Server icon from the system tray.
QRemote Server Main screen, shows the IP address and Port it allows the QRemote Client to connect to.
QODBC
21
Make a note of IP address and Port number listed on the QRemote Server Event Logs window
Create a new DSN entry o Before creating A DSN entry verify you have created a DSN entry for QODBC which can connect to QuickBooks. The ODBC Manager 32Bit can be found under Control Panel > ODBC ( 32 Bit )
To create a new QRemote DSN entry, navigate to ODBC Manager 64 Bit. Located under Control Panel > Administrative Tools > Data Sources (ODBC).
QODBC
22
From the driver list select QRemote for QuickBooks and click Finish
QODBC
23
Under the QRemote for QuickBooks Client DSN configuration screen, Please fill in the following information Data Source Name : Name of your DSN entry Server : IP address displayed on QRemote Server Port : Port displayed on QRemote Server Encryption Key : encryptionkey Remote DSN : select the QODBC DSN from the list. ( Make sure QRemote Server is running)
QODBC
24
Verify the QRemote Client connects to server and the below listed logs are logged in the event window.
QODBC
25
QODBC
26
Select the QRemote DSN from the list under Machine Data Source
You can notice the connection information getting logged under QRemote Server.
QODBC
27
Select the table(s) you would like to import to MS Access and click OK
QODBC
28
After all the import process is completed a notification window appears in MS Access.
QODBC
29
QODBC
30
You will notice the connection information getting logged under QRemote Server.
QODBC
31
If you want to filter the data, you can opt for the data filtering based on the criteria you specify.
QODBC
32
QODBC
33
QODBC Support
This driver has the following ODBC support and limitations: Only ODBC Core Level SQL is supported. Only ODBC Level 2 API calls are supported. ODBC Version 3.0 compliant. Column and table names are not case-sensitive, string data comparisons are case sensitive. Character values supplied for parameterized queries (SELECT * FROM EMP WHERE NAME = ?) are limited to 255 characters. Transactions are not supported. Qualifiers and owners are not allowed on databases, tables, etc. Table creation and deletion are not supported currently.
QODBC
34
Windows Support
QODBC version 12 supports Microsoft Windows 95, Windows 98, Windows NT, Windows ME, Windows 2000, Windows XP, Windows Vista and Windows 7.
Product Support
We offer a free fully functional trial copy of QODBC limited to selected elements in the QuickBooks system. A FAQ section and a Help Desk support system is available for registered users and those evaluating QODBC. Those purchasing the product will receive Free installation support for 30 days from the date of purchase. Program anomalies will be addressed at no charge and updaters posted on our web site. Other issues may be subject to a fee. Support can be obtained by the following methods:
Mail: FLEXquarters.com Limited
mailto:info@qodbc.com
(248) -886-1664
The most effective of these methods is the Forum support system via our website, since you can attach an ODBC or SDK trace log to the message and we can attach an updated product to you if we have a patch. Before contacting us, run an ODBC trace log of the operations you are having problems with and contact the vendor of your application to see if they are driver related problems. If they are, send us the file and a description of the problem.
Product Updates
Since the product is distributed in Demo form, the latest updated versions will always be available on-line at our web page: http://www.qodbc.com/qodbcDownload.htm
QODBC
35
QODBC Credits
QODBC versions 2.x thru 12.x For Microsoft Windows 95, Windows 98, Windows ME, Windows NT, Windows 2000 Windows XP, Microsoft Windows, Vista and Windows 7. Copyright 1995-2011, FLEXquarters.com Limited, All Rights Reserved Worldwide Portions of this product Copyright Intuit Incorporated QODBC is a trademark of FLEXquarters QuickBooks Pro, QuickBooks Premier, QuickBooks Enterprise Solution and QuickBooks Online Edition are registered trademarks of Intuit Incorporated Windows, Vista and Windows 7 are registered trademarks of Microsoft Corporation All other trademarks are copyrights of their respective holders Version 2.0 First released October 2002 Version 3.0 First released January 2003 Version 4.0 First released November 2003 Version 5.0 First released October 2004 Version 6.0 First released November 2005 Version 7.0 First released October 2006 Version 8.0 First released September 2007 Version 9.0 First released October 2008 Version 10.0 First released September 2009 Version 11.0 First released October 2010 Version 12.0 First released October 2011 Program published and supported by: FLEXquarters.com Limited 2620 S Maryland Pkwy Ste 14 # 557 Las Vegas, NV 89109-1692 WWW: E-mail: Fax: http://www.qodbc.com info@qodbc.com 248- 886-1664
FLEXquarters Sales Office: FLEXquarters USA Sales P.O. Box 0036 Union Lake, MI 48387-0036 E-mail: Voice: Fax: Technical Support mark@qodbc.com 800-932-6448 (In the US & CA) or 248-886-1662 248-886-1664 248-886-1663 (Registered user installation issues only)
Program developed by Brad Waddell and Matthew Froncek Documentation produced by Mark Kuznar, Brad Waddell, Rajendra Dewani and Matthew Froncek.
QODBC
36