%META:TOPICPARENT{name="SingleTierLiteInstallMac"}% = Installation and Configuration of the Lite Edition (Single-Tier) ODBC Driver for Oracle 10g Data Sources, for Mac OS X= **Review Preinstallation Documentation:** [[PreinstallOracleLiteOSX|Pre-Installation Requirements]] %TOC% == Installation== # The **Lite Edition (Single-Tier) ODBC Driver for Oracle 10g** for Mac OS X is distributed in a single disk image (.dmg) file, which contains a Macintosh Installer mpkg. %BR%%BR%%BR%%BR% # Double-click the mpkg to start the installation process. %BR%%BR%%BR%%BR% # You will encounter a warning message that will ask you if you are sure that you want to install the software. Click Continue. %BR%%BR%%BR%%BR% # The installer will display a **Welcome** message. Click "Continue." %BR%%BR%%BR%%BR% # The next screen will display the **Read Me** file, including any last- minute updates to these documents. Please read carefully and click "Continue" when finished. %BR%%BR%%BR%%BR% # The next screen will display the **License Agreement** for the OpenLink Single-Tier Driver for ODBC. Please read and click "Continue." %BR%%BR%%BR%%BR% # You will be prompted to "Agree" to continue the installation or "Disagree" to abort. %BR%%BR%%BR%%BR% # You will be asked to select a Destination Volume. Generally, this should be your Mac OS X boot volume. Click on the desired disk icon and then click "Continue." %BR%%BR%%BR%%BR% # You may now choose the Easy Install, or if you are an experienced user, you may Customize which components are installed. OpenLink generally recommends the Easy Install. # If you have installed OpenLink or iODBC components in the past, click "Upgrade" to continue; otherwise, click "Install." %BR%%BR%%BR%%BR% # If you chose the custom option, select which of the following components to install. %BR%%BR%%BR%%BR% # You must have an Administration username and password to install the OpenLink driver. Enter your Mac OS X Username and Password. %BR%%BR%%BR%%BR% # You will be shown a graphical progress bar as the Installation progresses, followed by System Optimization.%BR%%BR% # After the driver has been installed, you will be prompted to locate a license file.%BR%%BR% //**NOTE** -- If a correctly named file already exists in {{{$OPL_LICENSE_DIR}}}, {{{/Library/Application Support/openlink/bin/}}}, 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 [[http://support.openlinksw.com/supportweb/ApplyingLicenseFiles| manually apply a valid license file]] after installation is completed.//%BR%%BR% //**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.//%BR%%BR% %BR%%BR%%BR%%BR% #* If a license file already exists on the machine, select the 'use existing' option. (Previously generated license files may be [[http://support.openlinksw.com/supportweb/ODSBriefcaseLicenseStorage| re-downloaded from your ODS-Briefcase data space]].)%BR%%BR% #* 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.%BR%%BR% # When the process is complete, you will be told that the software was successfully installed. Click "Close" and your new database driver for ODBC is ready for use. %BR%%BR%%BR%%BR% == Configuration == # To configure an ODBC DSN, run the OpenLink iODBC Administrator located in the /Applications/iODBC folder: %BR%%BR%%BR%%BR% # Click the **System DSN** tab: %BR%%BR%%BR%%BR% # Click the Add button. Then, select the OpenLink Oracle Lite Driver from the list of available drivers: %BR%%BR%%BR%%BR% # Click **Finish**.%BR%%BR% # The Data Source tab prompts for information that identifies the Oracle database server and listen port. It also requests a name for your Data Source. You may also supply an optional description for your Data Source Name. %BR%%BR%%BR%%BR% #* **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 }}} # Click Continue. # The Connection Tab takes a combination of required and optional parameters to make a connection to the target database: %BR%%BR%%BR%%BR% #* **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. [[WhatDoesOCIPrefetchRowsDo|More]] #* **OCIPrefetchMemory** — Sets the memory allocated for rows to be pre-fetched. The application then fetches as many rows as will fit into that much memory. [[WhatDoesOCIPrefetchMemoryDo|More]] #* **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 the value should be "SQL Server". # Click Continue to view additional preferences that can be set for the connection. %BR%%BR%%BR%%BR% #* **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. When dynamic cursor sensitivity is set high, the Cursor Library calculates checksums for each row in the current rowset and compares these with the checksums (if any) already stored in the row version cache for the same rows when fetched previously. If the checksums differ for a row, the row has been updated since it was last fetched and the row status flag is set to SQL_ROW_UPDATED. The row version cache is then updated with the latest checksums for the rowset. From the user's point of view, the only visible difference between the two sensitivity settings is that a row status flag can never be set to SQL_ROW_UPDATED when the cursor sensitivity is low. (The row status is instead displayed as SQL_ROW_SUCCESS.) In all other respects, performance aside, the two settings are the same. Deleted rows don't appear in the rowset. Updates to the row since the row was last fetched are reflected in the row data, and inserted rows appear in the rowset, if their keys fall within the span of the rowset. If your application does not need to detect the row status SQL_ROW_UPDATED, you should leave the 'High Cursor Sensitivity' checkbox unchecked, as performance is improved. The calculation and comparison of checksums for each row fetched carries an overhead. If this option is enabled, the table oplrvc must have been created beforehand using the appropriate script for the target database. #* **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. Use this option in conjunction with Oracle queries. When enabled, the **{{{REMARKS}}}** column of a {{{SQLColumns()}}} result set includes the comments from the **{{{COMMENTS}}}** column of the Oracle {{{ALL_COL_COMMENTS}}} data dictionary view. When disabled, the **{{{REMARKS}}}** column is empty. Disabling **Show Remarks** improves performance. #* **Disable autocommit** - Changes the default commit behaviour 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 query do not include LONG data fields. #* **Always include VIEWS in table list** - #* **Always include alltypes 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. [[WhatDoesCustomCatalogViewsDo|More]] #* **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. [[WhatDoesCountStoredProcedureParametersInSQLProceduresDo|More]] # Click the Finish button to save your new Data Source Name. == Next... == * [[TestingMacODBCDSNs|Test your DSNs with our sample program]].%BR%%BR% * If anything isn't working as you expect, including errors resulting from the test above, [[UDATroubleshootingResources|see our Troubleshooting Resources]].%BR%%BR% * Should you decide to purchase a commercial license at the end of your evaluation period, be sure to consult our documentation which explains the placement and uptake of commercial license files and the use of our OpenLink License Manager technology: [[UDALicenseApplication|License Technology & Application]].