XODBC.BUNDLE for Omnis Studio 3.X ================================= The xodbc.bundle file for MacOS X (10.X) enables the V3 ODBC DAM to interface with a Darwin/Unix shared library driver manager. In Studio 3.X, only Darwin shared libraries are supported. This readme describes the steps necessary to configure the bundle and test an ODBC connection. 1. Install and Test Clientware ------------------------------ It is recommended that you obtain the latest version of the Openlink's driver manager (iODBC) and one or more ODBC drivers. The multi-tier/Generic ODBC driver is sufficient for most connections. Please see note 6 below for details on setting up a multi-tier ODBC connection. Add one or more datasources using the iODBC Administrator and test the connection where possible by pressing the 'Test' button. You can further test a given connection using the iODBC Test.command utility. 2. Install the xodbc.bundle --------------------------- Once the ODBC driver manager has been installed and one or more data sources setup and tested, expand the Omnis application by control-clicking and selecting "Show Package Contents". Expand this and place the new xodbc.bundle under "Contents->MacOS", replacing the existing file (if present). This version of xodbc.bundle is dynamically linked against Openlink's version 5.0 iODBC framework. Consequently, the required "iODBC" library must be present in the standard library search path. If necessary, you should create a symbolic link from a location on the standard library path, e.g. ln -s /Library/Frameworks/iODBC.framework/Versions/Current/iODBC /usr/lib/iODBC 3. Configure DAMODBC.INI ------------------------ Before starting Omnis, check that the environment variables contained in the OMNIS:XCOMP:DAMODBC.INI file are set correctly (and that this file exists at the given location). This file is read whenever an instance of an ODBCDAM session is created and the variable names found are assigned to the environment in which Omnis runs. Typically, this file consists of two lines of text similar to: ODBCINI=/Users/username/Library/Preferences/ODBC.preference UDBCINI=/Users/username/Library/Preferences/ODBC.preference where username is the name of the user who has added one or more User DSNs. If a System DSN is required, these are usually stored under the root user's preferences e.g. ODBCINI=/private/var/root/Library/Preferences/ODBC.Preference UDBCINI=/private/var/root/Library/Preferences/ODBC.Preference 4. Start Omnis and logon ------------------------ On starting Omnis (design), it may be helpful to have a Console window open which will display any operating system related error messages which occur as Omnis loads. Double-click on the Omnis application and once loaded, check the Console as well as the Omnis trace log for errors. Note that one or more messages in the trace log referring to ".INI" files which couldn't be loaded can be disregarded. As a further check, open the notation inspector and expand the $components node. You should see the ODBCDAM component listed fairly near the top of the list. It should now be possible to start using the DAM. As a test you might open the SQL Browser and create an ODBC session (ensuring the the Multi-threaded ODBC DAM is selected) 5. Troubleshooting ------------------ If the component was not loaded, check the "Console" for any error messages and the Omnis trace log. Problems loading the DAM are usually a result of: - the bundle file not being installed correctly. See above. - the contents of DAMODBC.INI do not point to the ODBC.preference file as generated by the iODBC Administrator. - the clientware is not installed correctly- this can usually be checked by testing your data source using the driver manager. - the dynamic linker could not locate the required client library (driver manager). Check the path to the driver manager and verify that the symbolic link (if used) is valid, e.g. use ls -l to show it's details. For a list of currently certified connections please refer to our website at http://www.omnis.net/develop/resources/notes/damconfig.html 6. About the Openlink Generic ODBC Driver ----------------------------------------- This section contains notes on Openlink's Generic ODBC Driver and configuring it to talk to remote ODBC Data sources. Please note that this section pertains only to the Generic ODBC Driver and not to single-tier ODBC drivers. -When configuring the local data source using the iODBC Administrator, click 'Add' to add a new data source and select Openlink Generic ODBC Driver. If this driver is not available, check that you have downloaded and installed the driver correctly. -On pressing the 'Finish' button, the Openlink Setup Dialog should appear. The fields of this dialog should be filled-in as follows: Name Name for the local DSN- your choice Comment Any comment of your choice Domain "Odbc" Protocol "TCP-IP" Hostname IP address of the Openlink Request Broker Port Usually 5000 (the default port used by the Request Broker) DSN *Must correspond with the name of an ODBC DSN as setup on the Request Broker Username Optional but if supplied must be a valid logon for the target database Read-only connection No No logon dialog box No (required for the Test Connect) Defer fetching of long data Yes Row buffer size 30 -Upon satisfactory enrty of the above details, you should test your connection by highlighting the new data source and pressing the "Test" button, completing the logon details to the database when prompted. The DAM will not be able to logon to this data source unless this test is successful. *Please refer to Openlink's website for further information on installing and configuring the Request Broker (www.openlinksw.com) The Request broker usually runs on a separate WindowsNT/2000 machine which also has some proprietry ODBC drivers and an ODBC Adminstrator installed. You should setup and test one or more System DSNs using this machine, making note of the name used for use in the DSN field above.