How to Install and Configure the Lite Edition ODBC Driver for SQL Server, on Windows

Basic DBMS & DBMS Version Support

• Do OpenLink drivers connect to Microsoft SQL Server?
  
• Microsoft SQL Server version support
  
• Detecting the Microsoft SQL Server DBMS version

Database Native Client Requirements

• Understanding the Microsoft SQL Server native client
  
• When do I need the Microsoft SQL Server native client?
  
• Obtain the Microsoft SQL Server native client (a.k.a "NetLib")
  
• Configure the Microsoft SQL Server native client

Key Database Native Variables (Set Before OpenLink Install)

• DSQUERY
  
• TDSHOST
  
• TDSPORT
  
• TDSVER

Database Native Settings You Need to Know

• Identify the Microsoft SQL Server Instance Name
  
• Identify the Microsoft SQL Server Listen Port

Database Configuration for Unicode

• Unicode Configuration

Database Configuration for XA Support

• XA Configuration
  

Do OpenLink drivers connect to Microsoft SQL Server?

Yes. OpenLink produces data access drivers that connect to Microsoft SQL Server.

Our drivers support connections to all versions of Microsoft SQL Server, from 4.x to current.

It is always best to use the latest TDS Version supported by the target DBMS Engine. The TDSVER Values and TDS Protocol Versions in use shown here are based on Release 7.0 of our Data Access products. Older driver releases do not support the most recent TDSVER values.

Notes: Microsoft SQL Server

Connections to later versions of Microsoft SQL Server (e.g., 2005) may often be made using earlier TDS versions (e.g., 7.0) -- but note that data type, networking, and security features are limited by the specified TDS version.

More recent security features may be enabled on the server-side, which prevent connections using the older TDS version, and thus require the more recent TDS version.

Notes: Sybase

In the Sybase naming, ASA stands for Adaptive Server Anywhere, and ASE stands for Adaptive Server Enterprise.

Table of settings

The following SQL query may be run through any SQL interface, including Query Analyzer --

SELECT @@VERSION

Alternately, if you have console access to the SQL Server host, you may use the following steps --

1. Launch the Microsoft SQL Server Enterprise Manager.
   
2. Expand the Microsoft SQL Servers menu tree.
   
3. Expand the Microsoft SQL Server Group menu tree.
   
4. Right-click the icon for your target instance.
   
5. Click Properties.
   
6. Click the General tab.
   
7. Look for the Product version: listing.
   

Understanding the Microsoft SQL Server native client

Microsoft SQL Server's dblib- or ctlib- based native client was commonly referred to as NetLib?. This marketting name may have changed.

When do I need the Microsoft SQL Server native client?

OpenLink's current data access products do not use the Microsoft SQL Server native client. Use of the Microsoft SQL Server native client was deprecated with the advent of OpenLink 4.0.

There are two scenarios in which you would require the Microsoft SQL Server native client. You must install the Microsoft SQL Server client on the same machine as any 1.x or 3.x Single-Tier driver. Additionally, you must install the Microsoft SQL Server client on the same machine as OpenLink's Request Broker and Microsoft SQL Server Database Agent, if the Broker and Microsoft SQL Server Agent do not reside on the same machine as the Microsoft SQL Server database, and the Microsoft SQL Server Agent is version 1.x or 3.x.

Obtain the Microsoft SQL Server native client (a.k.a "NetLib")

OpenLink Software does not supply the Microsoft SQL Server native client. Instead, the Microsoft SQL Server native client should ship with the standard Microsoft SQL Server DBMS install media.

If you do not have the Microsoft SQL Server client install CD, you should contact Microsoft.

Configure the Microsoft SQL Server native client

OpenLink's drivers do not require use of any Microsoft SQL Server client product. Consequently, OpenLink Product Support Staff do not document this procedure.

DSQUERY

The DSQUERY environment variable passes the name of the Microsoft SQL Server or Sybase instance to which you want to connect.

TDSHOST

The TDSHOST environment variable passes the hostname or IP address of the physical database server to which you want to connect.

TDSPORT

The TDSPORT environment variable passes the TCP port on which Microsoft SQL Server listens.

The TDSVER environment variable is used to set the TDS Protocol version to use when connecting to your desired target Sybase or Microsoft SQL Server instance, when the -V value is not set in the client DSN Options or Rulebook ConnectOptions.

See TDS Versions Explained for details.

Microsoft SQL Server 2000

1. Log in to your Microsoft SQL Server database server.
   
2. Launch the Microsoft SQL Server Network Utility (Start menu >> Programs >> Microsoft SQL Server).
   
3. Microsoft SQL Server instance names should be immediately visible.

Microsoft SQL Server 2005

1. Log in to your Microsoft SQL Server database server.
   
2. Launch the Microsoft SQL Server 2005 Configuration Manager (Start menu >> Programs >> Microsoft SQL Server).
   
3. Microsoft SQL Server instance names should be immediately visible.
   

Microsoft SQL Server 2000 and earlier

1. Log in to your Microsoft SQL Server database server.
   
2. Launch the Network Utility (Start menu >> Programs >> Microsoft SQL Server).
   
3. Highlight the TCP icon associated with your instance name.
   
4. Click Properties.

Microsoft SQL Server 2005 and later

1. Log in to your Microsoft SQL Server database server.
   
2. Launch the Configuration Manager (Start menu >> Programs >> Microsoft SQL Server).
   
3. Highlight your Microsoft SQL Server instance name.
   
4. Click the TCP/IP icon associated with the instance name.
   
5. Click the IP addresses tab on the dialog that appears.

Database Configuration for Unicode

Microsoft SQL Server 2000

There are no Unicode-specific settings for Microsoft SQL Server. When creating a Database, the collation type for the database can be specified but there is no UTF8 or Unicode specific setting, and a wide (Unicode) language type like Chinese or similar has to be selected, after which wide (Unicode) data can be inserted into the Microsoft SQL Server wide character types NCHAR & NVARCHAR.

Configuring Microsoft SQL Server for XA support

XA support was tested against the following Microsoft SQL Server versions:

• MSSQL 6.5 RTM (WinNt4 Sp3)

• MSSQL 7.0EE SP4 (Win2k AdvSrv Sp3)

• MSSQL 2000 SP3a (Win2k Sp3)

Before using the Microsoft SQL Server XA features, you must install and register the Microsoft SQL Server extended stored procedures, for this :

1) copy xp_oplxa.dll ( xp_oplxa65.dll for MSSQL 6.5) to the MSSQLServer_Root/binn directory

2) execute the command :

isql.exe -Usa -Psa_pwd -ig:xp_oplxa.sql

or

isql.exe -Usa -Psa_pwd -ig:xp_oplxa65.sql (for MSSQL 6.5)

Review Preinstallation Documentation: Pre-Installation Requirements

Installation

1. The Lite Edition (Single-Tier) ODBC Driver for Microsoft SQL Server and Sybase is distributed in a single .msi file.
   
2. Click the Open link that appears in your Downloads dialog.
   
   
3. The installer will display a Welcome message. Click Next.
   
   
4. The next screen will display the License Agreement for the OpenLink Lite Driver. Please read and check the "I accept the license agreement" checkbox. Then, click Next.
   
   
5. The driver needs a license file to operate. Click the Browse button to locate a commercial or evaluation license that you have previously downloaded onto your local hard drive. Alternatively, click the Try & Buy button to obtain a commercial or evaluation license. You can also tick the "I don't want to install a license file right now" check box. This option will permit you to install the product; however, you will not be able to use the product until you obtain a commercial or evaluation license key.
   
   
6. Click Next.
   
7. Choose from the Typical, Complete, and Custom installation types.
   
   
8. Click Next.
   
9. Click the Install button.
   
   
10. Installation is complete. Click the Finish button.
    
    
11. You may be prompted to restart your computer, if you have a pre-existing OpenLink License Manager running on your computer. This reboot not always necessary, but is generally recommended.

Configuration

1. Launch the ODBC Administrator appropriate to the bitness (32-bit or 64-bit) of your client application and driver.
   
   
2. Click the System DSN tab.
   
   
3. Click the Add button. Then, select the OpenLink "Lite" Driver for Sybase & Microsoft Sybase SQL Server 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.
   
   
4. Click Finish.
   
5. The first dialog prompts for a Data Source Name and optional description.
   
   
6. Click Next.
   
7. The second dialog prompts for information that identifies the Microsoft SQL Server DBMS and database. It also provides a checkbox that allows you to check your basic connection parameters before setting advanced and optional settings.
   
   
   • Server Name - Select the drop down list box to invoke the driver's Dynamic discovery of Microsoft SQL Server instance on the network and choose the required instance, if listed.
     
   • Connect now to verify that all settings are correct - Will attempt to connect to the database, once you click Continue.
     
   • Login ID - A valid Microsoft SQL Server username
     
   • Password - A valid Microsoft SQL Server password
     
8. Use the Advanced button to manually configure a connection if the Microsoft SQL Server instance could not be dynamically located, as detailed below.
   
   
   • ServerType - An OpenLink proprietary parameter that associates the connection with a particular TDS version.
     
   • Hostname - The hostname or IP address on which Microsoft SQL Server listens
     
   • Port number - The TCP port on which Microsoft SQL Server lists
     
   • Server Name - Microsoft SQL Server instance name on the specified host. A Microsoft SQL Server instance can also be specified by appending "\InstanceName" to the ServerName ie "ServerName\InstanceName"
     
   • Mirror Host - The name of the Failover Server hosting the mirrored database if configured
     
   • Use strong encryption of data - Enable SSL encryption of data between driver and database
     
   • Use Mars - Multiple Active Result Sets enables the concurrent processing of multiple statements/queries and/or result sets on a single connection
     
   • Verify Server Certificate - Verify the Database Server SSL certificate against the one specified in the "CA file" field
     
   • CA file - Specify the location of a Valid SSL Certificate for use during the connection
     
9. Click Next to continue.
   
10. The third dialog takes a combination of database specific and optional parameters.
    
    
    • Database - The Microsoft SQL Server database
      
    • Character set - The client application's character set (8-bit only; the Unicode driver always returns UCS-2 on Windows).
      
    • Language - The language you want error messages returned in; must be supported by the target server.
      
    • Packet Size - A value that determines the number of bytes per network packet transferred from the database server to the client. The correct setting of this attribute can improve performance. When set to 0, the initial default, the driver uses the default packet size as specified in the Microsoft SQL Server configuration. When set to -1, the driver computes the maximum allowable packet size on the first connect to the data source and saves the value in the system information. When set to x, an integer from 1 to 10, which indicates a multiple of 512 bytes (for example, Packet Size of 6 means to set the packet size to 6 * 512 equal 3072 bytes). For you to take advantage of this connection attribute, you must configure the System 10 server for a maximum network packet size greater than or equal to the value you specified for Packet Size.
      
    • Prepare Method - This option is specific to the TDS-based driver for Sybase & Microsoft SQL Server SQL Servers. It can take the values None, Partial, or Full (connectoptions = -O [0, 1, 2] respectively). It is used to determine whether stored procedures are created on the server for calls to SQLPrepare. More
      
    • No Quoted Identifiers - This option indicates that the underlying driver does not support quoted identifiers, which is required for Jet engine based products like MS Access.
      
    • Use ANSI nulls, padding and warnings - This option affects TDS agent & Lite Driver connections to Microsoft SQL Server databases. Sybase connectivity is not affected. More
      
    • Map Serializable to Snapshot isolation level - Enable Snapshot transaction isolation level in the driver. Snapshot Isolation is a new transaction isolation level available in Microsoft SQL Server 2005
      
11. Click Next to continue.
    
12. The fourth dialog enables you to set optional ODBC connection parameters.
    
    
    • Read-only connection — Specifies whether the connection is "Read-only." Must be unchecked to INSERT, UPDATE, or DELETE records, and to run some Stored Procedures including some built-in functions.
      
    • Defer fetching of long data — Defers fetching of LONG (BINARY, BLOB, etc.) fields in wildcard queries. This provides significant performance increases when fields in query do not include LONG data fields.
      
    • Disable interactive login — Suppresses the ODBC "Username" and "Password" login dialog boxes when interacting with your ODBC DSN from within an ODBC compliant application.
      
    • Row Buffer Size — This attribute specifies the number of records to be delivered from the driver to the client application in a single batch. Values can range from 1 to 999.
      
    • Max Rows Override — Allows you to set a limit for the maximum number of rows to be returned from a query. The default value of 0 means no limit.
      
    • Initial SQL — Lets you specify a file containing SQL statements that will be run automatically against the database upon connection.
      
    • Dynamic 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.
      
    • Enable logging to the log file — Check the checkbox and use the associated textbox to provide the full path to a file in which to log diagnostic information.
      
13. Click Next to continue.
    
14. The fifth dialog enables you to set additional parameters to enhance compatibility with applications.
    
    
    • Enable Microsoft Jet engine options — Facilitates translation of certain data types for the Microsoft Jet Engine. If you notice that money and other datatypes are mishandled with Microsoft or other applications, test with Jet fix enabled.
      
    • Disable Autocommit — Changes the commit behavior of the OpenLink driver. The default mode is 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 when a resultset (typically generated by an accidental query) is very large. The limit is not normally reached.
      
    • Multiple Active Statements Emulation — Enables use of Multiple Active statements in an ODBC application even if the underlying database does not allow this,, by emulation within the driver.
      
    • 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 value should be "SQL Server".
      
15. Click Next to continue.
    
16. The final dialog enables you to test your Data Source. Click the Test Data Source button.
    
    
17. A connection has been established.
    
    

Next...

• Test your DSNs with our sample program.
  
  
• If anything isn't working as you expect, including errors resulting from the test above, see our Troubleshooting Resources.
  
  
• 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: License Technology & Application.
  

Additional Reading

Create File DSNs

This format of ODBC DSN enables the creation of centralized ODBC DSNs on a designated NT or Windows 95 Server machine, thereby reducing the administrative overhead of ODBC DSN configuration for every single machine within your infrastructure.

The steps for creating an ODBC File DSN are as follows:

1. Select the File DSN Tab from the ODBC Driver Manger. Press the Add button.

Figure: 1. File Data Sources

2. Pick the ODBC Driver to be used to create your ODBC DSN, in the case of the OpenLink Universal Data Access Driver Suite 5.0, this would be the Driver identified below as "OpenLink Generic ODBC Driver".

Figure: 2. Data Source Configuration

3. Enter a name that describes your File DSN (e.g. "Sales by Region" as depicted below) for future use when interacting with it from ODBC compliant application and environments. At present to get full compatability within the Admin Assistant, you must end your dsn name with the extension ".dsn". So for this example the DSN name would be "Sales by Region.dsn".

Figure: 3. File Data Sources

4. Verify the displayed paramters are correct, and confirm by hitting Finish button.

Figure: 4. File Data Sources

5. Enter a Description and define the location of the server either by selection, or enter it manually.

Note the name is not defined here as the filename defines the DSN.

Figure: 5. File Data Sources

6. Complete the fields of the ODBC File DSN. Enter Domain, Database, Server. See above for details of each.

The File DSN must be verified immediately, so the Login ID and password are required. The Next button will be disabled until login details are provided.

Figure: 6. File Data Sources

7. Complete the fields for additional connection parameters.

Figure: 7. Data Source Configuration

8. This concludes the File DSN generation. The DSN will appear in the list under the File DSN Tab of the ODBC Driver Manger.

Figure: 8. File Data Sources

Bench Testing ODBC Drivers

ODBC Bench Test is a 32 Bit C++ program based on the industry standard TPC-A benchmark (we will be extending this program to include the TPC-C and TPC-D benchmarks also). This program helps you compare the performance of Virtuoso against other backend database engines as well as compare the performance of various ODBC Drivers connecting to any ODBC compliant backend database.

1. Go to the OpenLink Data Access Drivers "Start Menu" item, then click on the "ODBC Bench Test 32 Bit" menu item. You will be presented with the "Bench Test" interface.

Figure: 1

2. Follow the File->Connect menu path which initializes the ODBC Driver Manager, which in turn presents you with a list of ODBC DSNs installed on your machine. Select the DSN that you want to benchmark, remember that by benchmarking a DSN you are benchmarking the ODBC Driver that serves the DSN in question and the backend database engine that serves the ODBC Driver. Choose the name of the datasource you want to benchmark.

Figure: 2

3. You will then be presented with a Login Dialog by the OpenLink Generic Driver for ODBC, enter a valid user name and password into the appropriate fields.

Figure: 3

4. Now follow the Bench-->Load Tables menu path and you will be presented with a dialog that enables you to configure key elements of your benchmark. Click the "Execute" button to commence the process of setting up your database for the benchmark tests. Please make sure you select the appropriate schema for the DBMS that you are connecting to so that the benchmark tables are created properly.

Figure: 4

5. As the process of loading data occurs, all the way up to completion, the benchmark program will provide status information into the benchmark output pane as shown below:

Figure: 5

6. Now that all the benchmark data has been loaded into your database, follow the Bench-->Run Benchmark menu path and then configure your actual benchmark session parameters:

These benchmark parameters fall into 3 categories, Timing Options, SQL Options, and Execution Options.

Figure: 6

Timing Options:

These setting allow you to configure the duration related aspects of this benchmark program

Minutes

this is the duration of each benchmark run

Runs

this controls how many iterations of the benchmarks you actually run (the default is one benchmark iteration with a duration of 5 minutes)

SQL Options:

These settings allow you to configure how your benchmark's SQL instructions are actually handled.

ExecDirect with SQL Text

this means that no form of repetitive SQL execution optimization is being applied (SQL statements are prepared and executed repetitively)

Prepare/Execute Bound Params

this means that the Parameter Binding SQL execution optimization is being applied (SQL is prepared once but executed many times without the overhead of re-preparing statements prior to execution)

Use Stored Procedures

this means that the Stored Procedure SQL optimization is being applied (benchmark instructions are stored within database being benchmarked)

Execution Options:

These settings allow you to configure the tone of your benchmark, for instance it could have Transaction scoping and a mix of record retrieval queries, or it could simply be input and update intensive with a minimal amount of record retrieval queries (the case when the 100 row query checkbox is unchecked a typical OLTP scenario)

Asynchronous

execute the benchmark instructions asynchronously

Use Transactions

make the benchmark use transaction control (instructions are scoped to transaction blocks)

Do 100 row Query

perform a simulation of a 100 record retrieval as part of the benchmark activity.

7. Click on the "Run All" button if you would like all the different benchmark type combinations to be performed.

8. When benchmark run complete benchmark data is written to the benchmark program's output pane.

Figure: 7

The key pieces of benchmark data that you need to look out for are:

Total Transactions

total number of transactions completed during the benchmark run

Transactions Per Second

number of transaction completed per second for the benchmark run

Information from this benchmark is automatically written to an Excel format CSV (the file c:\odbcbnch.csv) which makes it easy for you to graph and pivot data collated from several benchmark runs. A later version of this demo will actually write the benchmark data into an ODBC DSN that you provide thereby offering even more flexibility and accessibility to benchmark data.

C++ Demo is a simple ODBC-based Interactive SQL processor written, as may be obvious from its name, in C++. The binary executable may be found at --

<OPENLINK_INSTALLATION_DIRECTORY>\samples\odbc

As with other sample applications we ship, when source code is available, it may be found alongside the executable.

Be sure to launch the tool appropriate to the Driver and DSN you are testing --

1. The tool will launch.
   
   
2. Select menu item Environment >> Open Connection. The ODBC Driver Manager will present a list of available ODBC DSNs. Select the DSN to which you wish to connect ("Informix 7 on Local" has been selected, below) --
   
   
3. You will be presented with a Login Dialog. Enter the user name and password for the target database, and click Connect --
   
   
4. You should now be connected to the chosen data source. Use the SQL >> Execute SQL menu item to get the SQL input dialog. Enter any valid SQL statement (see example in screen shot), and click OK.
   
   
5. You will be presented with the results of your query.
   
   
6. Close the connection by selecting the Environment >> Close Connection menu item. Exiting the application through any normal Windows pattern will also close the connection.

Configure Microsoft SQL Server Auto Discovery

Use the following steps to configure Microsoft SQL Server Auto Discovery.

Single-Tier Drivers

1. Log in to the machine that hosts OpenLink's Single-Tier (Lite Drivers).

2. Launch your ODBC or iODBC Data Sources Administrator.

3. Locate your OpenLink DSN.

4. Click the Configure button.

5. Scroll through the configuration screens until you find the Server Name drop-down menu.

6. Use the drop-down menu to invoke the driver's Dynamic discovery feature.

7. Select from the available Microsoft SQL Server instances.

Configure Microsoft SQL Server Database Mirroring

Use the following steps to configure Microsoft SQL Server Database Mirroring.

Single-Tier (Lite) Drivers on Windows and Mac OS X

1. Log in to the machine that hosts OpenLink's Single-Tier (Lite Drivers).

2. Launch your ODBC or iODBC Data Sources Administrator.

3. Locate your OpenLink DSN.

4. Click the Configure button.

5. Scroll through the configuration screens until you find the Mirror Host drop-down menu.

6. Select the name of the Failover Server hosting the mirrored database.

Single-Tier (Lite) on Unix/Linux or Multi-Tier Drivers

1. Log in to the machine that hosts OpenLink's Driver.

2. Edit the odbc.ini file and location the OpenLink DSN.

3. Set the connection option (-O) to -F <fail-over server name> to specify the Fail over server name for Database Mirroring.

Configure Microsoft SQL Server Express Support

No special configuration is needed to connect to Microsoft SQL Server Express. Use OpenLink's standard DSN configuration instructions.

Configure Microsoft SQL Server Multiple Active Result Sets

Use the following steps to configure Microsoft SQL Server Database Mirroring.

Single-Tier (Lite) Drivers - Mac & Windows

1. Log in to the machine that hosts OpenLink's Single-Tier (Lite Drivers).

2. Launch your ODBC or iODBC Data Sources Administrator.

3. Locate your OpenLink DSN.

4. Click the Configure button.

5. Scroll through the configuration screens until you find the MARS checkbox.

6. Check the MARS checkbox.

Single-Tier (Lite) Drivers - Unix

1. Login to the machine that hosts OpenLink's Single-Tier client drivers.

2. Use the Web-based iODBC Data Sources Administrator to access your DSN.

3. Locate the Connection Options field of your DSN.

4. Locate the MARS checkbox.

5. Check the MARS checkbox.

Multi-Tier Drivers

1. Login to the machine that hosts OpenLink's Multi-Tier client drivers.

2. Use the relevant Data Sources Administrator or Web-Based Admin Assistant to access your DSN.

3. Locate the Connection Options field of your DSN.

4. Locate the MARS checkbox.

5. Check the MARS checkbox.

Configure MS SQL Server Named Instance Support

Use the following steps to configure Microsoft SQL Server Named Instance support.

Single-Tier (Lite) Drivers - Mac & Windows

1. Log in to the machine that hosts OpenLink's Single-Tier (Lite Drivers).

2. Launch your ODBC or iODBC Data Sources Administrator.

3. Locate your OpenLink DSN.

4. Click the Configure button.

5. Scroll through the configuration screens until you find the Server Name field.

6. Click the Advanced button that appears under the Server Name field.

7. Locate the Server Name field that appears on the Advanced dialog.

8. Pass ServerName\InstanceName in this field. For example:

NKHATAM\SQLSERVER

Single-Tier (Lite) Drivers - Unix

1. Login to the machine that hosts OpenLink's Single-Tier client drivers.

2. Use the Web-based iODBC Data Sources Administrator to access your DSN.

3. Locate the Connection Options field of your DSN.

4. Locate the Connection Options field.

5. Pass -S ServerName\InstanceName in this field. For example:

-S NKHATAM\SQLSERVER

Multi-Tier Drivers

1. Login to the machine that hosts OpenLink's Multi-Tier client drivers.

2. Use the relevant Data Sources Administrator or Web-Based Admin Assistant to access your DSN.

3. Locate the Connection Options field of your DSN.

4. Pass -S ServerName\InstanceName in this field. For example:

-S NKHATAM\SQLSERVER

Single Driver Connectivity to Multiple Instances

• Single-Tier Drivers on Unix Client to SQL Server 2005+
  
• Single-Tier Drivers on Unix Client to SQL Server 2000
  
• Multi-Tier Drivers (All) to SQL Server 2005+
  

Single Driver Connectivity to Multiple Instances

Single-Tier Drivers on Unix Client to SQL Server 2005

Use the following instructions to connect one client to multiple SQL Server instances:

1. Identify your Microsoft SQL Server instance names
   
2. Log in to the machine that hosts your OpenLink Single-Tier driver.
   
3. cd into the root of the OpenLink installation.
   
4. Use the bash or sh command to open a bash or bourne shell.
   
5. Execute this command:
   
   

   . ./openlink.sh

   
   
6. cd into the bin sub-directory of OpenLink.
   
7. vi the openlink.ini file.
   
8. Locate the [Server Types] section.
   
9. Create a meaningful label for each of your SQL Server instances. For example:
   
   

   [Server Types]
   DB2             =
   Informix 5      =
   Informix 6      =
   .
   .
   .
   Instance1        =
   Instance2        =

   
   
10. Locate this stanza in the file --
    
    

    [Environment SQLServer 2005]
    FREETDSCONF        = /usr/openlink/bin/freetds.conf
    DSQUERY            = SQLSERVER  ; Load this section from freetds.conf
    TDSHOST            = host.domain        ; Point this to your SQLServer machine
    TDSPORT            = 1433
    TDSVER             = 8.0
    SQLSERVER_CATALOG  = Y
    CURSOR_SENSITIVITY = LOW        ; Set to HIGH after loading oplrvc.sql

    
    
11. Copy and paste this stanza once for each new SQL Server instance that you want to add.
    
12. Make the following modifications to the new stanzas --
    
    1. Modify [Environment SQLServer 2005] so that "SQL Server 2005" is replaced with one of the labels you created above;e.g., [Environment Instance1].
       
    2. Pass the hostname or IP address of the SQL Server instance to TDSHOST.
       
    3. Pass the tcp port associated with the instance to TDSPORT.
       
    4. Set TDSVER to 9.0 for SQL Server 2005.
       
    5. Ensure you have an end result similar to this --
       
       

       [Environment Server 1]
       FREETDSCONF        = /usr/openlink/bin/freetds.conf
       DSQUERY            = SQLSERVER  ; Load this section from freetds.conf
       TDSHOST            = 192.158.12.121
       TDSPORT            = 1433
       TDSVER             = 9.0
       SQLSERVER_CATALOG  = Y
       CURSOR_SENSITIVITY = LOW        ; Set to HIGH after loading oplrvc.sql
       [Environment Server 2]
       FREETDSCONF        = /usr/openlink/bin/freetds.conf
       DSQUERY            = SQLSERVER
       TDSHOST            = 192.158.12.121
       TDSPORT            = 1434
       TDSVER             = 9.0
       SQLSERVER_CATALOG  = Y
       CURSOR_SENSITIVITY = LOW        ; Set to HIGH after loading oplrvc.sql

       
       
13. Save your changes and exit the file.
    
14. vi odbc.ini.
    
15. Proceed to create your DSNs as per usual. However, pass the appropriate label from the [Server Types] section of openlink.ini. For example --
    
    

    [Development DSN]
    Driver          = /usr/openlink/lib/sql_mt_lt.so
    ServerType      = Instance1
    Username        = sa
    ;Password        =
    Database        = Northwind
    Options         = -H 192.158.12.121 -P 1433 -V 9.0
    FetchBufferSize = 99
    ReadOnly        = no
    DeferLongFetch  = no
    JetFix          = no
    Description     = connection to Instance1
    [Production DSN]
    Driver          = /usr/openlink/lib/sql_mt_lt.so
    ServerType      = Instance2
    Username        = sa
    ;Password        =
    Database        = pubs
    Options         = -H 192.158.12.121 -P 1434 -V 9.0
    FetchBufferSize = 99
    ReadOnly        = no
    DeferLongFetch  = no
    JetFix          = no
    Description     = connection to Instance2

    
    
16. Save your changes and exit the file.
    
17. Test.
    

Single Driver Connectivity to Multiple Instances

Single-Tier Drivers on Unix Client to SQL Server 2000

Use the following instructions to connect to SQL Server DBMSs that host multiple SQL Server instances:

1. Use the following steps to identify your instance names --

• Microsoft SQL Server instance name

Microsoft SQL Server instance names should be immediately visible. Example: SQLSERV1, SQLSERV2.

2. Login to the machine that hosts your OpenLink Single-Tier driver.

3. cd into the root of the OpenLink installation.

4. Use the bash or sh command to open a bash or bourne shell.

5. Execute this command:

. ./openlink.sh

6. cd into the bin sub-directory of OpenLink.

7. vi the openlink.ini file.

8. Locate the [Server Types] section.

9. Create a meaningful label for each of your SQL Server instances. For example:

[Server Types]
DB2             =
Informix 5      =
Informix 6      =
.
.
.
Server 1        =
Server 2        =

10. Locate this stanza in the file --

[Environment SQLServer 2000]
FREETDSCONF        = /usr/openlink/bin/freetds.conf
DSQUERY            = SQLSERVER  ; Load this section from freetds.conf
TDSHOST            = host.domain        ; Point this to your SQLServer machine
TDSPORT            = 1433
TDSVER             = 8.0
SQLSERVER_CATALOG  = Y
CURSOR_SENSITIVITY = LOW        ; Set to HIGH after loading oplrvc.sql

11. Copy and paste this stanza once for each new SQL Server instance that you want to add.

12. Make the following modifications to the new stanzas --

a) Modify [Environment SQLServer 2000] so that "SQL Server 2000" is replaced with one of the labels you created above;e.g., [Environment Server 1].

b) Pass the desired instance name to DSQUERY. For example DSQUERY=SQLSERV1.

c) Pass the hostname or IP address of the SQL Server instance to TDSHOST.

d) Pass the tcp port associated with the instance to TDSPORT.

e) Set TDSVER to 8.0, if any other value appears.

f) Ensure you have an end result similar to this --

[Environment Server 1]
FREETDSCONF        = /usr/openlink/bin/freetds.conf
DSQUERY            = SQLSERV1  ; Load this section from freetds.conf
TDSHOST            = 192.158.12.121
TDSPORT            = 1433
TDSVER             = 8.0
SQLSERVER_CATALOG  = Y
CURSOR_SENSITIVITY = LOW        ; Set to HIGH after loading oplrvc.sql
[Environment Server 2]
FREETDSCONF        = /usr/openlink/bin/freetds.conf
DSQUERY            = SQLSERV2
TDSHOST            = 192.158.12.121
TDSPORT            = 1434
TDSVER             = 8.0
SQLSERVER_CATALOG  = Y
CURSOR_SENSITIVITY = LOW        ; Set to HIGH after loading oplrvc.sql

13. Save your changes and exit the file.

14. vi freetds.conf.

15. Make one new entry per each SQL Server instance using these conventions --

[<Instance Name>]
host                    = <ntmachine.domain.com>
port                    = <port>
tds version             = 8.0
try server logins       = yes

For example --

[SQLSERVER1]
host                    = 192.158.12.121
port                    = 1433
tds version             = 8.0
try server logins       = yes
[SQLSERV2]
host                    = 192.158.12.121
port                    = 1434
tds version             = 8.0
try server logins       = yes

16. Save your changes and exit the file.

17. vi odbc.ini.

18. Proceed to create your DSNs as per usual. However, pass the appropriate label from the [Server Types] section of openlink.ini. For example --

[Development DSN]
Driver          = /usr/openlink/lib/sql_mt_lt.so
ServerType      = Server 1
Username        = sa
Password        = sa
Database        = Northwind
Options         = -H 192.158.12.121 -P 1433 -V 8.0
FetchBufferSize = 99
ReadOnly        = no
DeferLongFetch  = no
JetFix          = no
Description     = Sample SQLServer 2000 Lite Connection
[Production DSN]
Driver          = /usr/openlink/lib/sql_mt_lt.so
ServerType      = Server 2
Username        = sa
Password        = sa
Database        = pubs
Options         = -H 192.158.12.121 -P 1434 -V 8.0
FetchBufferSize = 99
ReadOnly        = no
DeferLongFetch  = no
JetFix          = no
Description     = Sample SQLServer 2000 Lite Connection

19 Save your changes and exit the file.

20. Test.

Configure SQL Server Single Sign On

Microsoft SQL Server Single Sign On is easy to configure. Simply leave the username and password fields blank. This feature is only applicable when connection requests are initiated from Windows clients.

This setup is not necessary for connections to Microsoft SQL Server instances which are configured to demand SSL connections from clients; such demands are handled automatically by the drivers.Note that SSL connections are never supported by Microsoft SQL Server 7 or earlier, nor when using TDS Version 7.0 or 4.2.

Single-Tier (Express Edition) ODBC Drivers (Mac & Windows)

1. Log in to the machine that hosts OpenLink's Single-Tier (Express) Drivers.
   
2. Launch your ODBC or iODBC Data Sources Administrator.
   
3. Locate your OpenLink DSN.
   
4. Click the Configure button.
   
5. Scroll through the configuration screens until you find the Advanced button.
   
6. Click the Advanced button.
   
7. Locate the SSL parameter.
   
8. Set the SSL parameter to one of the following options:
   
   • off ­ - SSL is not request or used. This is the default.
     
   • request ­- SSL is requested; if the server does not support it then a plain connection is used.
     
   • require ­ - SSL is requested; if the server does not support it then an exception is thrown.
     
   • authenticate - ­ Same as require except the server's certificate must be signed by a trusted CA.

Single-Tier (Lite Edition) ODBC Drivers

Single-Tier (Lite Edition) ODBC Drivers - Mac & Windows

1. Log in to the machine that hosts OpenLink's Single-Tier (Lite Drivers).
   
2. Launch your ODBC or iODBC Data Sources Administrator.
   
3. Locate your OpenLink DSN.
   
4. Click the Configure button.
   
5. Scroll through the configuration screens until you find the "Use strong encryption of data" checkbox.
   
6. Tick the Encryption checkbox to make the driver demand an SSL encrypted connection to the Microsoft SQL Server instance. If the target instance is not configured for or capable of SSL connections, the connection will fail.
   
7. Tick the "Verify Server Certificate" to verify the SSL Certificate presented by the database server against a local certificate. You must also specify the location of a Valid SSL Certificate for this verification.

Single-Tier (Lite Edition) ODBC Drivers - Unix

1. Login to the machine that hosts OpenLink's Single-Tier client drivers.
   
2. Use the Web-based iODBC Data Sources Administrator to access your DSN.
   
3. Locate the Connection Options field of your DSN.
   
4. Pass the following flags and applicable attributes in the Connection Options field:
   
   • -E - The driver will demand an SSL encrypted connection to the Microsoft SQL Server instance. If the target instance is not configured for or capable of SSL connections, the connection will fail.
     
   • -R - Verify the SSL Certificate presented by the database server against the one specified with the -D flag.
     
   • -D </path/to/file> - Specify the location of a Valid SSL Certificate to be used for the verification triggered by the -R flag

Multi-Tier Drivers (all data access mechanisms)

1. Login to the machine that hosts OpenLink's Multi-Tier Generic Client ODBC Driver, JDBC Driver, or ADO.NET Provider.
   
2. Use the relevant Data Sources Administrator or Web-Based Admin Assistant to access your ODBC DSN, JDBC URL, or connect string.
   
3. Locate the Connection Options field of your connect string.
   
4. Pass the following flags and applicable attributes in the Connection Options field:
   
   • -E - The driver will demand an SSL encrypted connection to the Microsoft SQL Server instance. If the target instance is not configured for or capable of SSL connections, the connection will fail.
     
   • -R - Verify the SSL Certificate presented by the database server against the one specified with the -D flag.
     
   • -D </path/to/file> - Specify the location of a Valid SSL Certificate to be used for the verification triggered by the -R flag
     

Configure Microsoft SQL Server Snapshot Isolation Levels

Use the following instructions to enable snapshot isolation levels.

Single-Tier (Lite) Drivers - Mac & Windows

1. Log in to the machine that hosts OpenLink's Single-Tier (Lite Drivers).

2. Launch your ODBC or iODBC Data Sources Administrator.

3. Locate your OpenLink DSN.

4. Click the Configure button.

5. Scroll through the configuration screens until you find the "Map Serializable to Snapshot isolation level" checkbox.

6. Check the checkbox.

Single-Tier (Lite) Drivers - Unix

1. Login to the machine that hosts OpenLink's Single-Tier client drivers.

2. Use the Web-based iODBC Data Sources Administrator to access your DSN.

3. Locate the Connection Options field of your DSN.

4. Pass the following flag in the Connection Options field: -Z

Multi-Tier Drivers

1. Login to the machine that hosts OpenLink's Multi-Tier client drivers.

2. Use the relevant Data Sources Administrator or Web-Based Admin Assistant to access your DSN.

3. Locate the Connection Options field of your DSN.

4. Pass the following flag in the Connection Options field: -Z

Configure Microsoft SQL Server Unicode Support

No special configuration is needed.

See Also: Microsoft SQL Server Unicode Configuration

Upgrades & Pre-Existing Installations

Identifying Pre-existing Installations

Use the following instructions to search for pre-existing OpenLink components on partner-supplied machines and other hardware:

1. Open Windows ODBC Data Sources Administrators or Mac iODBC Data Sources Administrators. Click on the Drivers tab. Look for OpenLink driver entries.

2. Open Windows registries. Expand the HKEY_ LOCAL_ MACHINE\SOFTWARE\ODBC\ODBCINST.INI tree structure. Look for OpenLink driver entries.

3. Use the Windows explorer to search for oplrqb.exe, olod*.dll, or lite32.

4. Open the Windows Services utility and look for an OpenLink Request Broker or License Manager service.

5. Log in to Mac OS X machines and open the Applications folder. Look for an OpenLink=>Universal Data Access Drivers folder structure.

6. Log in to Unix machines and use the find / -name file -print command to search for the following files: oplrqb, oplodbc.s*, openlink.ini

Discovery of one or more of these files confirms the presence of OpenLink's Multi-Tier, Single-Tier or Express Edition drivers. If you want to install new software, you have two options:

7. Remove the old software and start fresh.

8. Obtain version information from the existing software and obtain new components from the same build.

Upgrades & Pre-Existing Installations

Mixing & Matching Components from Different Versions

OpenLink Software does not support mixed-version installations. Mismatched client and server software may not hinder your ability to connect and query. However, version incompatibility issues will arise over time. In fact, if you mix OpenLink 3.x and OpenLink 4.x software, you can expect specific problems with stability, transactions, and threading. These problems may only be resolved by upgrading the older component.

Be advised: Under rare circumstances, you may be forced to deploy a mixed installation. As stated previously, 3.x and 4.x components tend to generate problems. However, 4.x client components appear to work well with 5.x server components.

Upgrades & Pre-Existing Installations

Detecting Sofware Versions

You may employ a variety of methods to obtain your product version information. Windows and Mac Single-Tier users should open their ODBC Administrator. The Single-Tier driver version appears on the Drivers tab of this Administrator. Users simple scroll through the Driver list box, locate their driver, and record the version string, which appears to the right of the driver name.

Windows & Mac Client Drivers (Express Edition/Single-Tier/Multi-Tier)

1. Open your ODBC Data Sources Administrator or iODBC Data Sources Administrator.
2. Click the Drivers tab.
3. Scroll through the list box until you locate the OpenLink driver.
4. View the driver version information that appears to the right of the driver name.

Unix Client Drivers (Single-Tier/Multi-Tier)

1. Login to the client machine.
2. cd into the root of the OpenLink installation.
3. Execute the openlink.sh or openlink.csh shell script.
4. cd into the /samples/ODBC (MT) or /bin (ST) sub-directory of the installation.
5. Use odbctest or iodbctest to connect to your Data Source.
6. View the driver version information that appears above the SQL> prompt.
7. Alternatively, run one of the following commands from the /lib sub-directory:

Multi-Tier Server Components (All Platforms)

1. Open a DOS Command Prompt, Unix console terminal, or similar command line utility.
2. cd into the /bin sub-directory of the OpenLink server components installation.
3. Type the broker or agent name and append -? or ?v to the end of the name. For example:

oplrqb -?
ingii_mv -?
sql_mv -?

4. Record the version information that is returned by the broker or agent.

Upgrades & Pre-Existing Installations

Running Multiple Versions Simultaneously

You can run multiple driver versions for comparative and diagnostic purposes. Take the following action to proceed:

Single-Tier & Express Edition Drivers

1. Shutdown your License Manager, if you have OpenLink 6.0 drivers installed.
2. Install your new drivers in a separate directory.
3. Place your new license files in the /bin sub-directory of the new installation.
4. Restart your License Manager, if you have OpenLink 6.0 drivers installed.

Multi-Tier Drivers

1. Shutdown your License Manager, if you have OpenLink 6.0 drivers installed.
2. Install your new drivers in a separate directory.
3. Place your new license files in the /bin sub-directory of the new installation.
4. Restart your License Manager, if you have OpenLink 6.0 drivers installed.
5. Use a text editor to open the oplrqb.ini files that appear in the /bin sub-directories of both Multi-Tier server component installations.
6. Locate the [Protocol TCP] section. For example:

  [Protocol TCP]
PingWatchdog = No
PingInterval = 600
Listen     = 5000
PortLow    = 5000
PortHigh    = 5025
;IPAddress    = 127.0.0.1

7. Insure that each Listen port references a different, unused TCP/IP port. (Use PortLow for OpenLink 1.x-3.x.)

8. Save any changes to the oplrqb.ini files.

9. Start your Request Brokers.

BE ADVISED: The above instructions may not bring success in all scenarios. The following issues could present challenges that warrant attention from OpenLink Product Support:

1. Differing Windows driver versions may share the same .dll name. This could provide configuration challenges.

2. Some Windows installers may force you to remove an older installation.

3. OpenLink's 1.x and 3.x use UDP ports to broadcast license information. You need to contact Product Support for specialized configuration in this instance.

Upgrades & Pre-Existing Installations

Installing New Software on Top of Old Software

You can install new software on top of existing software. However, this is not the preferred course of action, in many circumstances. You should install new software to new directories, if you are attempting to compare software performance or troubleshoot problems.

Removing installations of our components takes different steps for different platforms.

Windows

You may use the uninstall utility to remove existing Windows software. You may also use the Add/Remove Programs utility, which appears in the Control Panel.

Mac OS X

The following sequence will cleanly remove all iODBC and Data Access components added by our installers.

1. Double-click the Uninstall.command script (/Applications/OpenLink/Universal Data Access Drivers (* Tier Edition)). If the script is not present, skip ahead to #3.
   
   
2. Answer the questions posed by the script. Please note that you must answer with the mixed-case, full-word answers. Anything other than `Yes`, `All`, or `Quit`, will be interpreted as `No`, including `y`, `Y`, and `yes`.
   
   
3. Verify that all of the following directories (including contents), and specified individual files, have been removed --
   
   

   /Applications/iODBC
   /Applications/OpenLink*
   /Library/Application Support/iodbc
   /Library/Application Support/openlink
   /Library/Frameworks/iODBC*
   /Library/Java/Extensions/libopljodbc*.jnilib
   /Library/Java/Extensions/opljdbc*.jar
   /Library/Java/Extensions/virtjdbc*.jar
   /Library/LaunchDaemons/com.openlinksw.*
   /Library/ODBC/OpenLink*
   /Library/Receipts/iODBC*
   /Library/Receipts/Opl*
   /Library/Receipts/UDA*
   /Library/Receipts/VIRT*
   /Library/Receipts/Virt*
   /Library/StartupItems/Oplmgr
   /Users/*/Library/Preferences/com.openlinksw*
   /Users/*/Library/Saved Application State/com.openlinksw*
   /private/var/db/receipts/com.openlinksw.*

   
   
4. You can copy and paste the following command into Terminal.app to remove all of the above --
   
   

   sudo rm -rf /Applications/iODBC /Applications/OpenLink* "/Library/Application Support/iodbc" "/Library/Application Support/openlink" /Library/Frameworks/iODBC* /Library/LaunchDaemons/com.openlinksw.* /Library/ODBC/OpenLink* /Library/Receipts/iODBC* /Library/Receipts/Opl* /Library/Receipts/UDA* /Library/Receipts/VIRT* /Library/Receipts/Virt* /Library/StartupItems/Oplmgr /Library/Java/Extensions/libopljodbc* /Library/Java/Extensions/opljdbc* /Library/Java/Extensions/virtjdbc* /Users/*/Library/Preferences/com.openlinksw* /Users/*/Library/Saved\ Application\ State/com.openlinksw* /private/var/db/receipts/com.openlinksw.*

   
   
   

Unix-like OS -- AIX, HP-UX, Linux, Solaris, etc.

We do not provide an uninstall utility for Unix-like platforms. rm and rmdir should be used to remove existing deployments.

Upgrades & Pre-Existing Installations

Performing Upgrades

1. Terminate active ODBC connections.
2. Back up your license file.
3. Make sure you have the appropriate version JDK/JRE installed.
4. Perform your upgrade.

Single-Tier Upgrades

1. Terminate active ODBC connections, which use OpenLink's drivers.
2. Back up license files.
3. Back-up existing odbc.ini and openlink.ini files. (Unix Only)
4. Terminate the License Manager service if you use OpenLink 6.0 or newer drivers.
5. Proceed with the upgrade.

Multi-Tier Upgrades
1. Terminate active ODBC connections, which use OpenLink's drivers.
2. Stop your Request Broker and License Manager services. (License Managers are an OpenLink 6.0 and higher feature.)
3. Back-up your license and oplrqb.ini files.
4. Back-up odbc.ini files. (Unix Client Installs Only.)
5. Proceed with their upgrades.

BE ADVISED: Some installers present two options: 1) Upgrade Driver Name, 2) Install New Driver. The first option should overwrite older drivers. DSNs that use those drivers will be affected. They should be migrated to the new driver. However, to insure the integrity of existing DSNs, choose the second option. This option installs the new driver alongside the old driver. Pre-existing DSNs should not be affected in any way.

Upgrades & Pre-Existing Installations

Reasons to Upgrade

Consultants should encourage end-users to upgrade to the latest software version. The latest software contains desirable new features and fixes for bugs. Additionally, support options are limited, when legacy software is involved. Development does not back-patch legacy bugs, and Support staff may have difficulties recreating legacy problems.

The following table lists new features for recent software builds: