%META:TOPICPARENT{name="SingleTierExpressInstallMac"}%
= Installation and Configuration of the Single-Tier "Express" Edition ODBC Driver for Firebird Data Sources, for Mac OS X=
**Review Preinstallation Documentation:**  [[PreInstallFirebirdExpressOSX|Pre-Installation Requirements]]
%TOC%

==Installation==

<i>Note: The software must be installed as a user with Administrative privileges on the machine.</i>


# The Single-Tier "Express" Edition ODBC Driver for Firebird Data Sources is distributed as a Disk Image ({{{.dmg}}}) file:  
# Double-click the disk image 'mul6efrb.dmg' to access the installer {{{.mpkg}}} file:
%BR%%BR%<img src="%ATTACHURLPATH%/ee-frb-00.png" style="wikiautogen"/>%BR%%BR%
# Double-click the {{{.mpkg}}} file to run the installer and follow the instructions to complete the installation:
%BR%%BR%<img src="%ATTACHURLPATH%/ee-frb-01.png" style="wikiautogen"/>%BR%%BR%
# This is the **Welcome** dialog for the <nop>OpenLink ODBC Driver for Firebird (Express Edition):
%BR%%BR%<img src="%ATTACHURLPATH%/ee-frb-02.png"/>%BR%%BR%
# Review the **Read Me** file for installation requirements and known issues:
%BR%%BR%<img src="%ATTACHURLPATH%/ee-frb-03.png"/>%BR%%BR%
# Read the **Software License Agreement** before continuing your installation:
%BR%%BR%<img src="%ATTACHURLPATH%/ee-frb-04.png"/>%BR%%BR%
# Select a destination volume for the driver installation:
%BR%%BR%<img src="%ATTACHURLPATH%/ee-frb-05.png"/>%BR%%BR%
# Choose to perform a custom or default installation of the driver:
%BR%%BR%<img src="%ATTACHURLPATH%/ee-frb-06.png"/>%BR%%BR%
# If you chose the custom option, select which of the following components to install:
%BR%%BR%<img src="%ATTACHURLPATH%/ee-frb-07.png"/>%BR%%BR%
# Note: The software must be installed as a user with Administrative privileges on the machine:
%BR%%BR%<img src="%ATTACHURLPATH%/ee-frb-08.png"/>%BR%%BR%
# After the driver has been installed, you will be prompted for a license file. If a license file already exists on the machine, select the 'use existing file' option. A trial (try) or full (buy) license can be obtained by selecting the 'try and buy' option which loads the online try and buy web page:
%BR%%BR%<img src="%ATTACHURLPATH%/ee-frb-09.png"/>%BR%%BR%
# To obtain the trial license you must be a registered user on the <nop>OpenLink Web site and login with the username (e-mail address) and password for that user. Click on the 'Shop' link to visit the online shop cart to purchase a full license if required:
%BR%%BR%<img src="%ATTACHURLPATH%/ee-frb-10.png"/>%BR%%BR%
# Click on the 'download license' button to obtain an immediate license file and save it to your desktop. Alternatively, a mail can be sent to your e-mail address with a link to your <nop>OpenLink Data Space (ODS). Here, all trial and full license files will be stored in a specialized Briefcase for download at a later date.
%BR%%BR%<img src="%ATTACHURLPATH%/ee-frb-11.png"/>%BR%%BR%
# Select the license file that you want to use for the installation:
%BR%%BR%<img src="%ATTACHURLPATH%/ee-frb-12.png"/>%BR%%BR%
# The installation is complete:
%BR%%BR%<img src="%ATTACHURLPATH%/ee-frb-13.png"/>%BR%%BR%


== Configuration ==

# To configure an ODBC DSN, run the <nop>OpenLink iODBC Administrator located in the /Applications/iODBC folder:
%BR%%BR%<img src="%ATTACHURLPATH%/ee-frb-14.png"/>%BR%%BR%
# Click the Add button:
%BR%%BR%<img src="%ATTACHURLPATH%/ee-frb-15.png"/>%BR%%BR%
# Select the <nop>OpenLink Firebird Driver (Express Edition) v6.0 from the list of available drivers. Select the Unicode version of the driver **if and only if** you are working with multi-byte character sets, as unnecessary translations can significantly affect ODBC performance:
%BR%%BR%<img src="%ATTACHURLPATH%/ee-frb-16.png"/>%BR%%BR%
# Provide a suitable DSN name and optional description for the Data Source:
%BR%%BR%<img src="%ATTACHURLPATH%/ee-frb-17.png"/>%BR%%BR%
# The Connection Tab takes the minimum parameters required to make a connection to the target database:
%BR%%BR%<img src="%ATTACHURLPATH%/ee-frb-18.png"/>%BR%%BR%
#* **Hostname** - The hostname of the server on which Firebird is running
#* **Port** - The port on which the Firebird instance listens
#* **<nop>DatabasePath** - Full path to a Firebird database
#* **User name** - A valid Firebird user
#* The advanced button displays additional optional parameters that can be configured.
| *Name* | *Description* |
| **<nop>BlobBufferLength**| Sets BLOB buffer length. This value influences performance when working with BLOB fields.|
| **<nop>BlobBufferSize** | Size of the BLOB buffer in bytes.| 
| **<nop>BuffersNumber** | Number of cache buffers that should be allocated for this connection. Should be specified for <nop>ClassicServer instances. <nop>SuperServer has a server-wide configuration parameter.| 
| **<nop>DefaultIsolation** | Sets the default transaction isolation level using a string. The following strings are allowed: 'TRANSACTION_READ_COMMITTED', 'TRANSACTION_REPEATABLE_READ', 'TRANSACTION_SERIALIZABLE' | 
| **<nop>Encoding** | Sets encoding for connections produced by this data source.| 
| **<nop>LoginTimeout** | Sets login timeout for this datasource in seconds.| 
| **<nop>RoleName** | SQL role to use. |
| **<nop>SocketBufferSize** | Socket buffer size in bytes. | 
| **<nop>SqlDialect** | SQL dialect of the client. |
| **<nop>TimestampUsesLocalTimezone** | 'true' if the <nop>JayBird 1.0 handling of the calendar in corresponding setters. This is also compatible with <nop>MySQL calendar treatment. |
| **<nop>UseStandardUdf** | 'true' if driver should assume that standard UDF are installed. | 
| **<nop>UseStreamBlobs** | 'true' if stream blobs should be created. Otherwise 'false.' |
| **<nop>UseTranslation** | Path to the character translation table. |
| **<nop>CharSet** | Character set for the connection. Similar to encoding property but accepts Java names instead of Firebird names. |
# Click continue to proceed to the Options tab. This tab contains optional parameters that are not required for basic ODBC connectivity:
%BR%%BR%<img src="%ATTACHURLPATH%/ee-frb-19.png"/>%BR%%BR%
#* **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.
#* **Drop Catalog from Meta calls** - Enable this option to have the catalog name not appear for tables, views, and procedures when requesting database meta-data.
#* **No support of quoted identifier** - If set, the call <nop>SQLGetInfo for 'SQL_IDENTIFIER_QUOTE_CHAR' will return a space (" "). It can be used if the DBMS doesn't support quoted SQL like select * from "account."
#* **Drop Schema from Meta calls** - Enable this option to have the schema-name not appear for tables, views, and procedures when requesting database meta-data.
#* **SQLStatistics disabled** -  Check this box to have SQLStatistics() return an empty resultset. Use this if the underlying database does not support retrieval of statistics about a table (e.g. what indexes it has).
#*  **No support of search string escape** - If set, the call <nop>SQLGetInfo for 'SQL_LIKE_ESCAPE_CLAUSE' will return a space (" "). It can be used if the DBMS doesn't support SQL escape patterns.
#* **Patch of NULL size of SQL_CHAR** -  If set, this option overrides the size of SQL_CHAR column type returned by the database with the value set in the text box (in bytes). With a default value of 0, the driver uses the size returned by the database.
#* **SQL_DBMS Name** - Manually overrides the <nop>SQLGetInfo(SQL_DBMS_NAME) response returned by the driver. This is required for products like Microsoft <nop>InfoPath for which the return the value should be "SQL Server".
# Click continue to proceed to the Preferences tab. This tab contains optional parameters that are not required for basic ODBC connectivity:
%BR%%BR%<img src="%ATTACHURLPATH%/ee-frb-20.png"/>%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.
#* **Disable Autocommit** - Changes the default commit behaviour of the <nop>OpenLink driver. The default mode is <nop>AutoCommit (box unchecked).
#* **Disable Rowset Size Limit** - Disables a limitation enforced by the cursor library. This limitation is enforced by default. It prevents the driver from claiming all available memory in the event that a resultset  generated from an erroneous query is very large. The limit is normally never reached.
#* **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.
#* **Multiple Active Statements Emulation** - Enables use of Multiple Active statements in an ODBC application even if the underlying database does not allow this, as it is emulated in the driver.
# Click on the 'Test Data Source' button to make a connection to the database to verify connectivity:
%BR%%BR%<img src="%ATTACHURLPATH%/ee-frb-21.png"/>%BR%%BR%
# Enter a valid username and password for the database:
%BR%%BR%<img src="%ATTACHURLPATH%/ee-frb-22.png"/>%BR%%BR%
# A successful connection to the database has been made:
%BR%%BR%<img src="%ATTACHURLPATH%/ee-frb-23.png"/>

==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 <b><nop>OpenLink License Manager</b> technology: [[UDALicenseApplication|License Technology &amp; Application]].