How To Install and Configure the Lite Edition ODBC Drivers for Oracle (macOS)

Pre-Installation Guide

  1. You must be able to establish a connection with your target Oracle Database using existing Oracle Client Software. If you encounter problems making a connection to your target database, please check the following settings:
    • Oracle SID: Specify the Oracle System Identifier (SID) of your database.
    • Oracle TCP Port: Provide the TCP port number used for communication with the Oracle database.
    • Oracle SQL*Net or Net Service Name: Specify the Oracle SQL*Net or Net Service Name if required. This is only necessary when the Multi-Tier server components are not installed on the Oracle server.
    • Hostname or IP address of Oracle database server: Provide the hostname or IP address of the server where your Oracle database is located.

Installation Guide

  1. Download and open the Lite Edition (Single-Tier) ODBC Driver for Oracle 10g Data Sources. It is distributed in a single disk image (.dmg) file, which contains a Macintosh Installer package (.mpkg).
    • Double-click the .mpkg to start the installation process.
    • After the driver has been installed, you will be prompted to locate a license file.
      NOTE: If a correctly named file already exists in $OPL_LICENSE_DIR, /Library/Application Support/OpenLink/Licenses/, you will not see this dialog. If the existing file is not valid (evaluation has expired, it's for a different OS, it permits insufficient processor cores, etc.), you will need to manually apply a valid license file after installation is completed.
      NOTE: In some environments, this dialog may be hidden by the Installer.app or other windows on your Mac. Please minimize, hide, and/or move windows until you can see and act on this dialog. If you do not answer this dialog, the installation will not complete properly, and the driver will not function as desired.
    • If a license file already exists on the machine, select the 'use existing' option. (Previously generated license files may be re-downloaded from your ODS-Briefcase data space.)
    • If you need to obtain a new trial or permanent license file, select the 'try or buy' option, which will load a relevant web page from which you can obtain a license file.
  2. To configure an ODBC DSN, run the OpenLink iODBC Administrator located in the /Applications/iODBC folder:

Configuration Guide

  1. To configure an ODBC DSN, run the OpenLink iODBC Administrator located in the /Applications/iODBC folder.
  2. Click the System DSN tab.
  3. Click the Add button. Then, select the OpenLink Oracle Lite Driver from the list of available drivers.
  4. Click Finish.
  5. The Data Source tab prompts for information that identifies the Oracle database server and listen port.
    • DSN: A brief and meaningful title for your Data Source Name
    • Description: An optional description for your Data Source Name
    • Oracle Directory: Provides the full path to your local Oracle or Oracle client installation
    • Connection String: Your Oracle connection URL. Takes the following form:
      //oracle_server_ip_address:oracle_listening_port/oracle_SID
      For example:
      //openhp2.OpenLinksw.com:1521/ORCL
  6. Click Continue.
  7. The Connection tab takes a combination of required and optional parameters to make a connection to the target database:
    • Username: A Oracle username
    • Row Buffer Size: This attribute specifies the number of records to be transported over the network in a single network hop. Values can range from 1 to 99.
    • Hide Login Dialog: Suppresses the ODBC "Username" and "Password" login dialog boxes when interacting with your ODBC DSN from within an ODBC compliant application.
    • Read Only connection: Specifies whether the connection is "Read-only." Make sure the checkbox is unchecked to request a "Read/Write" connection.
    • OCIPrefetchRows: Sets the number of rows to be prefetched.
    • OCIPrefetchMemory: Sets the memory allocated for rows to be pre-fetched.
    • SQL_DBMS Name: Manually overrides the SQLGetInfo(SQL_DBMS_NAME) response returned by the driver. This is required for products like Microsoft InfoPath for which the return value should be "SQL Server".
  8. Click Continue to view additional preferences that can be set for the connection.
  9. The third tab contains settings that are not required for a basic connection:
    • Initialization SQL: Lets you specify a file containing SQL statements that will be run automatically against the database upon connection.
    • Cursor Sensitivity: Enables or disables the row version cache used with dynamic cursors.
    • Max Rows Override: Allows you to define a limit on the maximum number of rows to be returned from a query. The default value of 0 means no limit.
    • Show Remarks: Affects output from the SQLColumns() ODBC API call.
    • Disable autocommit: Changes the default commit behavior of the OpenLink driver. The default mode is AutoCommit (box unchecked).
    • Disable rowset size limit: Removes OpenLink's default 100 rowset restriction.
    • Defer fetching of long data: Defers fetching of LONG (BINARY, BLOB, etc.) data unless explicitly requested in a query. This provides significant performance increases when fields in the query do not include LONG data fields.
    • Always include VIEWS in table list:
    • Always include all types in table list:
    • Custom Catalogue Views: Dictates whether custom OpenLink views are used to return metadata for certain ODBC catalog functions: SQLForeignKeys(), SQLPrimaryKeys(), SQLProcedureColumns(), SQLProcedures(), and SQLSpecialColumns(). These custom views provide more metadata than is normally provided by the standard Oracle data dictionary views.
    • User's own tables first in SQLTables: This option is specific to OpenLink's Oracle drivers. It prompts the SQLTables() ODBC API call to display the connected user's tables first in table lists. The default ordering is alphabetical.
    • Count stored procedure parameters in SQL Procedures: This parameter is specific to the Oracle data source. It affects the output from SQLProcedures() when "Custom Catalog Views" is enabled.
  10. Click the Finish button to save your new Data Source Name.