How To Install and Configure the Multi-Tier Edition ODBC Drivers for Oracle (Linux)

Server Components

Installation (Request Broker and Database Agent)

  1. Log in to your Unix or Linux server machine, and Create and/or navigate to the intended OpenLink installation directory, e.g.,
    mkdir /opt/openlink
    cd /opt/openlink

    Note: cd into the installation directory.
  2. The installation files ship as an installation shell script, a driver .taz archive, and an optional administrator .taz file. Download these documents using binary-preserving methods (e.g., ftp in BIN mode, or scp), and place them in your installation folder.
  3. Run the following command to start the installation:
    sh install.sh

    You must choose a TCP port at which the OpenLink Request Broker will listen for requests. The default is 5000. You will need to know this port number and the Broker host's IP address or hostname when configuring ODBC Data Source Names (DSNs). You must choose a TCP port at which the OpenLink Request Broker's HTTP-based Admin Assistant will listen for requests. The default is 8000. You will need to know this port number and the Broker host's IP address or hostname to access your Admistrator in a Web browser. The URL will look like this:
    http://broker-host.example.com:8000/
  4. Additional Configuration Parameters:
    • Log file? enables you to specify the name and location of the OpenLink Request Broker's HTTP-based Admin Assistant's log file. It is best to go with the default.
    • You can choose to log all requests made to the OpenLink Request Broker's HTTP-based Admin Assistant. This is not diagnostic-level ODBC tracing nor multi-tier connection logging. The default is no, and this is generally appropriate.
    • You can change the OpenLink Request Broker's HTTP-based Admin Assistant's default username from "admin." This is the username you will use when working with the OpenLink Request Broker's HTTP-based Admin Assistant. (You can set up other usernames later; consider this one similar to "root.")
    • You can change the OpenLink Request Broker's HTTP-based Admin Assistant's default password from "admin." This is the password associated with the username you just set.
    The Installation is complete.
  5. Optionally, The domain section of the rulebook contains the Database Agent connection parameters for the outgoing connections towards your Oracle database.
    Default Database Agent names for oracle use the following pattern:
    [generic_ora{{version}}]. For Example, the Oracle 12 parameters are located in:
    [generic_ora12].
    Locate your Database Agent, and uncomment the "Connect Options" parameter.
    Add your hostname and port values using the following template:
    Connect Options = -H {{host}} -P {{port number}}.
    Configuration is complete.
  6. Installation is complete, proceed to making a test connection with your Client Component installation.
Non-Advanced Users should proceed to the Client Components installation and configuration guides
  1. Open the file $OPENLINK_INSTALL/bin/odbc.ini with a suitable text editor such as vi.
  2. Locate and edit the [OpenLink] section, which is a sample OpenLink Generic ODBC data source (DSN) created during the installation process. This is the sample DSN as created by the installer:
[OpenLink]
Driver          = /OPENLINK_INSTALL/lib/oplodbc.so
Host            = localhost:5000
ServerType      = Oracle 8.1.x
Database        = 
Options         = 
Username        = 
Password        = 
FetchBufferSize = 99
ReadOnly        = no
DeferLongFetch  = no
JetFix          = no
Description     = Sample DSN
  • Example Oracle 9.x (Full Client) Data Source:
[oracle9]
Driver          = /OPENLINK_INSTALL/lib/oplodbc.so
Host            = requestbroker_hostname:5000
ServerType      = Oracle 9.x
Options         = TNSNAME
Username        = oracle
Password        = **********
FetchBufferSize = 99
ReadOnly        = no
DeferLongFetch  = no
JetFix          = no
Description     = Sample Oracle 9.x (Full Client) Connection
  • Example Oracle 10.x (Full Client) Data Source:
[oracle10]
Driver          = /OPENLINK_INSTALL/lib/oplodbc.so
Host            = requestbroker_hostname:5000
ServerType      = Oracle 10.x
Options         = TNSNAME
Username        = oracle
Password        = **********
FetchBufferSize = 99
ReadOnly        = no
DeferLongFetch  = no
JetFix          = no
Description     = Sample Oracle 10.x (Full Client) Connection
  • Example Oracle 10.x (Instant Client) Data Source:
[oracle10]
Driver          = /OPENLINK_INSTALL/lib/oplodbc.so
Host            = requestbroker_hostname:5000
ServerType      = Oracle 10.x
Options         = //oracle_hostname:port/TNSNAME
Username        = oracle
Password        = **********
FetchBufferSize = 99
ReadOnly        = no
DeferLongFetch  = no
JetFix          = no
Description     = Sample Oracle 10.x (Instant Client) Connection

Presuming the OpenLink Request Broker is already running on the target machine, you are now ready to test the connection. Use the iodbctest tool which is packaged with the HTTP-based OpenLink ODBC Administrator as follows:

# cd OPENLINK_INSTALL
# . ./openlink.sh
# iodbctest oracle10

iODBC Demonstration program This program shows an interactive SQL processor Driver Manager: 03.52.0507.0105 Driver: 06.02.1217 OpenLink Generic ODBC Driver (oplodbc.so)

SQL>You should now be able to issue SQL statements directly against the target database.

Additional Information:

The bitness of the Generic ODBC Driver is determined by the bitness of your ODBC client application.

That is, if your ODBC client application is 32-bit, then the Generic ODBC Driver component MUST also be 32-bit.

  1. Prerequisites:
    • You MUST be proficient in using a Unix shell.
    • You MUST be proficient in using a Unix editor such as vi.
    • You MUST be in possession of relevant database connectivity details such as Database name, Username, password, etc.
    • You MUST have installed and available either a full installation of Oracle, Oracle Client, or Oracle Instant Client (release 6.x only).
  2. Open the file <OPENLINK_INSTALL>/openlink.sh with a suitable text editor such as vi.
  3. Locate the section that deals with the location of shared libraries pertaining to your system (LD_LIBRARY_PATH, LIBPATH, or SHLIB_PATH) and add to it the location of your Informix lib and lib/esql directories:
          LD_LIBRARY_PATH="<OPENLINK_INSTALL>/lib:/oracle/lib:$LD_LIBRARY_PATH"
        
  4. Open the file <OPENLINK_INSTALL>/openlink.ini with a suitable text editor such as vi.
  5. Locate the [Environment Oracle xxx] section that deals with the driver specific Oracle configuration and edit to reflect your Oracle installation:
          [Environment Oracle 10.x]
          ORACLE_HOME        = /oracle/
          ;ORACLE_SID         = ORCL
          ;ORACLE_SERVER      = T
          ;TWO_TASK           = P:
          ;ODBC_CATALOGS      = Y     ; Uncomment after loading odbccat10.sql
          ;MULTIPLEX_LDA      = 5     ; Allow 5 OpenLink clients on a single lda
          ;OPL_USR_TBLS_FIRST = Y     ; Sort SQLTables starting with user tables
          SHOW_REMARKS        = N     ; Retrieve SQLColumns REMARKS field
          CURSOR_SENSITIVITY  = LOW   ; Set to HIGH after loading odbccat10.sql
          ;OCI_PREFETCH_ROWS  = 100   ; Number of rows to prefetch
          ;OCI_PREFETCH_MEMORY = 65535 ; Amount of memory to use for prefetching
          ;NLS_LANG           = AMERICAN_AMERICA.UTF8 ; Unicode connection
        
  6. Open the file <OPENLINK_INSTALL>/bin/odbc.ini with a suitable text editor such as vi.
  7. Locate and edit the sample OpenLink Oracle ODBC data source (DSN) created during the installation process and edit as follows:
          [oracle]
          Driver            = <OPENLINK_INSTALL>/lib/ora100_mt_lt.so
          ServerType        = Oracle 10.x
          Options           = <TNSName>
          Username          = <scott>
          Password          = <**********>
          FetchBufferSize   = 99
          ReadOnly          =
          DeferLongFetch    =
          JetFix            = No
          Description       = Sample Oracle 10.x Lite Connection
        
  8. Use the iodbctest tool which is packaged with the HTTP-based OpenLink ODBC Administrator as follows:
          # cd <OPENLINK_INSTALL>
          # . ./openLink.sh
          # iodbctest oracle
        
    iODBC Demonstration program
    This program shows an interactive SQL processor
    Driver Manager: 03.52.0507.0105
    Driver: 06.02.1217 OpenLink Generic ODBC Driver (ora100_mt_lt.so)

    SQL>
  9. You should now be able to issue SQL statements directly against the target database.

Additional Information:
The bitness of the ODBC Driver for MySQL is determined by the bitness of your ODBC client application.
That is, if your ODBC client application is 32-bit then the Generic ODBC Driver component MUST also be 32-bit.

  1. Database Agent modifications are made using the Request Broker's Rulebook (oplrqb.ini).
    • Open this document using your preferred text editor (e.g., vim, vi).
  2. Oracle Environments are denoted by "Environment Oracle", followed by a version number. For example:
    [Environment Oracle6]
    • Locate your environment, and confirm that the ORACLE_HOME and ORACLE_SID values are correct.
    • For example:
      [Environment ORACLE180]
      ORACLE_HOME        = {Oracle-Installation-Home-Directory}
      ORACLE_SID         = {Oracle-System-ID}
    • Save these changes and exit the file.
  3. Run "oplrqb stop" to stop the request broker.
  4. Run "oplrqb start" to start the request broker with your new rulebook settings.

Client Components

Installation

  1. Prerequisites
    • You MUST be proficient in using a Unix shell.
    • You MUST be proficient in using a Unix editor such as vi.
    • You MUST be in possession of relevant database connectivity details such as Database name, Username, password, etc.
    • You MUST be aware of which Oracle client components have been configured for use by the Multi-tier server side components.
  2. Log onto the machine and create a suitable OpenLink installation directory (OPENLINK_INSTALL).
  3. Copy all relevant components to OPENLINK_INSTALL.

    At bare minimum, these will be the OpenLink Generic ODBC Driver and OpenLink Http Administration Assistant.

  4. Install using the "install.sh" shell script:
    #sh install.sh
    The installation should finish without error.

Configuration

  1. Open the file $OPENLINK_INSTALL/bin/odbc.ini with a suitable text editor such as vi.
  2. Locate and edit the [OpenLink] section, which is a sample OpenLink Generic ODBC data source (DSN) created during the installation process. This is the sample DSN as created by the installer:
[OpenLink]
Driver          = /OPENLINK_INSTALL/lib/oplodbc.so
Host            = localhost:5000
ServerType      = Oracle 8.1.x
Database        = 
Options         = 
Username        = 
Password        = 
FetchBufferSize = 99
ReadOnly        = no
DeferLongFetch  = no
JetFix          = no
Description     = Sample DSN
  • Example Oracle 9.x (Full Client) Data Source:
[oracle9]
Driver          = /OPENLINK_INSTALL/lib/oplodbc.so
Host            = requestbroker_hostname:5000
ServerType      = Oracle 9.x
Options         = TNSNAME
Username        = oracle
Password        = **********
FetchBufferSize = 99
ReadOnly        = no
DeferLongFetch  = no
JetFix          = no
Description     = Sample Oracle 9.x (Full Client) Connection
  • Example Oracle 10.x (Full Client) Data Source:
[oracle10]
Driver          = /OPENLINK_INSTALL/lib/oplodbc.so
Host            = requestbroker_hostname:5000
ServerType      = Oracle 10.x
Options         = TNSNAME
Username        = oracle
Password        = **********
FetchBufferSize = 99
ReadOnly        = no
DeferLongFetch  = no
JetFix          = no
Description     = Sample Oracle 10.x (Full Client) Connection
  • Example Oracle 10.x (Instant Client) Data Source:
[oracle10]
Driver          = /OPENLINK_INSTALL/lib/oplodbc.so
Host            = requestbroker_hostname:5000
ServerType      = Oracle 10.x
Options         = //oracle_hostname:port/TNSNAME
Username        = oracle
Password        = **********
FetchBufferSize = 99
ReadOnly        = no
DeferLongFetch  = no
JetFix          = no
Description     = Sample Oracle 10.x (Instant Client) Connection

Presuming the OpenLink Request Broker is already running on the target machine, you are now ready to test the connection. Use the iodbctest tool which is packaged with the HTTP-based OpenLink ODBC Administrator as follows:

# cd OPENLINK_INSTALL
# . ./openlink.sh
# iodbctest oracle10

iODBC Demonstration program This program shows an interactive SQL processor Driver Manager: 03.52.0507.0105 Driver: 06.02.1217 OpenLink Generic ODBC Driver (oplodbc.so)

SQL>You should now be able to issue SQL statements directly against the target database.

Additional Information:

The bitness of the Generic ODBC Driver is determined by the bitness of your ODBC client application.

That is, if your ODBC client application is 32-bit, then the Generic ODBC Driver component MUST also be 32-bit.