How to Install and Configure the Multi-Tier 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

Our Enterprise Edition (Multi-Tier) server components installers for Windows are distributed as .msi files. You need to download one Enterprise Edition Request Broker installer (ntbrzzzz.msi for all 32-bit processor architectures, wabrzzzz.msi for x86_64, or wibrzzzz.msi for IA_64) and at least one Agent installer (same architecture) for the specific target data source(s). Follow the procedure below for each installer.

1. Double-click the MSI file to start the installation:
   
   
2. This is the Welcome dialog for the OpenLink Enterprise Edition Request Broker:
   
   
3. Read the Software License Agreement before continuing your installation:
   
   
4. The Request Broker installers will specifically prompt for the location of a local license file. (Agent installers do not, as their licensing is handled through the Broker.) Click the Browse button to locate a license file on your Windows machine. Check the "I don't want to install a license file" box, if you do not have one.
   
   
5. Choose to perform a Typical, Complete (recommended), or Custom installation of the driver:
   
   
6. If you chose the Custom option, specify where the components should be installed:
   
   
7. You can choose which options to install, if you chose the custom installation option:
   
   
8. A final confirmation screen is displayed for your review prior to performing the installation:
   
   
9. The installation is complete:
   
   
10. Repeat the above installation process with your agent installer. The agent install process is similar to the Request Broker installation but lacks a prompt for a license.

Configuration

Our server components require minimal configuration. In most instances, the primary configuration file (oplrqb.ini) is automatically configured for basic connectivity during installation. Use the following steps to check and enhance your individual agent settings.

1. Launch the Enterprise Edition Administrative Assistant in a Web browser. The URL convention is:
   
   

   http://hostname_or_ip_address_of_machine_with_mt_server components:mt_admin_port/

   
   e.g.,
   
   

   http://myhost.example.com:8000/

   
   
   
2. Click the Server Components Administration link.
   
   
3. Click the Database Agent Administration link.
   
   
4. Click the Database Settings by Wizard link.
   
   
5. Login with your Administrative username and password. Both default to admin.
   
   
6. Select the configuration section that you want to review. The naming convention for default database agent configuration sections is generic_ followed by an abbreviation for the OpenLink agent, e.g., generic_inf9.
   
   
7. The Agent Details dialog allows you to rename the default agent configuration section and provide an optional comment. This is an advanced feature that should not be pursued for basic connectivity.
   
   
8. Click Edit to continue.
   
9. The first Connection Parameters dialog allows you to hardcode a single username and password for all client connections that are mapped to this agent configuration section. This will over-ride all authentication credentials provided by all clients, so can pose a significant security risk if highly privileged, or a significant limitation on functionality if privileges are too limited; thus, this option is usually not used for simple configurations.
   
   
   • User Name — A valid database user ID.
     
   • Password — A valid database password.
     
10. Click Next to continue.
    
11. The second Connection Parameters dialog allows you to hardcode a single Database, Read/Write access mode, and Connection Options for all client connections that are mapped to this agent configuration section. This will over-ride all such settings provided by all clients, so is often used to ease client-side configuration in both simple and complex environments. It can also be used to enhance database security in any environment.
    
    
    • Database Name — Takes a database name, Oracle SID, or similar, depending on target DBMS.
      
    • Read Only specifier — Specifies whether the connection is Read-only (does not permit execution of stored procedures nor anything that writes ) or Read/Write.
      
    • Connect Options — This field takes arguments that enable users to connect to databases running on different machines than the OpenLink Request Broker and Agent. MySQL, PostgreSQL, Microsoft SQL Server, and Sybase targets are always available in this way. Other DBMS may require additional native components or configuration for such "three-tier" connections to work. Review Complete Settings and Usage for Connect Options
      
12. Click Next to continue.
    
13. The next Connection Parameters dialog allows you to hardcode Server Options, a Domain, and a Host Name for all client connections that are mapped to this agent configuration section. This will over-ride all such options provided by all clients; thus, this option is usually not used for simple configurations.
    
    
    • Server Options — Server Options are typically Progress-specific options which are passed to the database native client at Agent start-up. Ensure that the options used when starting the actual database match the options passed in the Server Options field or ServerOptions Rulebook parameter.
      
    • Domain — Only used for n-tier connections, going through Proxy Agents. If you don't know what that is, you don't need to set this. The value must match a [Domain Alias], which is defined in the next Request Broker's Session Rulebook. This Alias typically represents the name and version of an OpenLink Agent. That agent version may differ from the DBMS version to which it connects. Note that advanced users may create custom domain names that follow their own localized conventions.
      
    • Host Name — Only used for n-tier connections, going through Proxy Agents. If you don't know what that is, you don't need to set this. Host name or IP address of the machine that contains the next Request Broker.
      
14. Click Next to continue.
    
15. The Secure SSL Connection dialog allows you to designate an SSL certificate. It also allows you to force all connections to use SSL (secure sockets layer) communications.
    
    
    • SSL Key File — The location of an SSL certificate, local to this Request Broker instance. If left blank, the Broker will self-sign when SSL-based connections are requested.
      
    • SSL Required — If set, all clients must use SSL-based connections.
      
16. Click Next to continue.
    
17. The first Application & Database Specific Parameters dialog allows you to enable "opsyslogin". Opsyslogin authenticates against the operating system, instead of the database.
    
    
    • Require Operating System Identity — If checked, the Request Broker will test to see that the username and password which are supplied to it are valid for log-in to the Broker host. If the authentication parameters are valid, it will start the database agent under the identity of the specified user. If unchecked, the username and password will be passed to the back-end database for authentication.
      
18. Click Next to continue.
    
19. The second Application & Database Specific Parameters dialog allows you to disable autocommit and enable Jet Engine catalogs.
    
    
    • No auto commit on startup — Default driver behavior is AutoCommit (box unchecked); i.e., each SQL statement is immediately and automatically committed. In rare cases, this causes problems with DBMS or client application transaction management; in such case, check the box, and all SQL will have to be committed by the client application and/or user.
      
    • Jet engine catalogs — Check this box if you intend to use this connection with Microsoft Access, Microsoft Excel, Microsoft SQL Server, or any Jet-based client application. This option causes certain datatypes to be handled better by the Microsoft Jet Engine, as documented elsewhere.
      
20. Click Next to continue.
    
21. The third Application & Database Specific Parameters dialog allows you to limit your rowset size and pass an initial SQL script.
    
    
    • Limit result set to n records — 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.
      
    • Initial SQL script — Lets you specify a file containing SQL statements that will be run automatically against the database upon connection.
      
22. Click Next to continue.
    
23. The Startup parameters screen enables you to identify the OpenLink database agent to use for your ODBC connections. It also allows you to hardcode specific environment variables for the connection. Proper environment variables are essential for ODBC connectivity.
    
    
    • Executable name — Allows you to choose which OpenLink agent should serve all connections associated with this agent configuration section.
      
    • Environment Variables — OpenLink's agents are written using the database native CLI. Consequently, they use the same environment variables that database native clients use to connect to the relevant DBMS. Use this box to set them. Complete List of Variables by Database
      
24. Click Next to continue.
    
    
25. The Process Mapping dialog enables you to set your agent reuse rules. Reuse rules dictate whether or not an agent will be used for subsequent connections. Reuse of agents reduces overhead associated with agent spawning.
    
    
26. Click Next to continue.
    
27. The Save Settings dialog allows you to save your new agent settings. Check the Reinitialize checkbox to reinitialize the OpenLink Request Broker with these settings. Your new settings will not be active unless the Request Broker is reinitialized, or restarted in some cases. Note: Restarting the Broker cannot be done through this interface.
    
    
28. Click Save to complete the agent configuration process.

Proceed to Commercial Licensing Documentation

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

Review Preinstallation Documentation: Enterprise Edition (Multi-Tier) ODBC Client Components

Installation

1. Our Enterprise Edition (Multi-Tier) Generic ODBC client is distributed in a single Windows MSI file. Simply run the appropriate installer for x86, x86_64 (Opteron, Xeon, other families), or IA_64 (Itanium family). You should see the following Welcome message:
   
   
2. The next screen will display the License Agreement for use with our Enterprise Edition (Multi-Tier) Driver product. Please read this. If you agree, check the accept checkbox and continue:
   
   
3. Choose the type of installation to perform, noting that typical and complete will immediately install the default or complete components respectively. Otherwise, select the custom option, which enables you to pick and choose options to install:
   
   
4. Use this dialog to specify the installation directory, if you chose the custom installation option:
   
   
5. You can choose which options to install, if you chose the custom installation option:
   
   
6. A final confirmation screen is displayed for your review prior to performing the installation:
   
   
7. The installer status bar indicates the progress and status of the the installation:
   
   
8. If the installation is successful, a final dialog will be displayed indicating this:
   
   

Configuration

1. Launch the ODBC Administrator appropriate to the bitness (32-bit or 64-bit) of your client application and driver.
   
   
2. Click the Add button that appears on the System DSN tab.
   
   
3. Select the OpenLink Generic ODBC Driver 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:
   
   
4. Click Finish.
   
5. The first DSN configuration dialog takes these values:
   
   
   • Name: A suitable name for your Data Source
     
   • Description: An optional description for your Data Source
     
   • Server: The host name or IP address of the machine containing your OpenLink Request Broker and the Broker's listen port. A colon separates the two. For example: 192.158.12.234:5000.
     
6. Click Next.
   
7. The second DSN configuration dialog takes these values:
   
   
   • Domain - The value must match a [Domain Alias], which is contained in the Server's Session Rules Book. This Alias typically represents the name and version of an OpenLink Agent. That agent version may differ from the DBMS version to which it connects. Note that advanced users may create custom domain names that follow their own, desired conventions.
     
   • Database - Takes a database name or Oracle SID.
     
   • Options - This field passes parameters that enable users to connect to MySQL, PostgreSQL, SQLServer, and Sybase databases anywhere on the network. It also passes parameters that enable users to connect to any DBMS that does not reside on the same machine as the OpenLink Request Broker and Agent. Review Complete Settings and Usage for Connect Options
     
   • Secure Connection - If checked, the client sets up a secure connection to the Request Broker.
     
   • Connect now to verify that all settings are correct - Will attempt to connect to the database, once you click Continue.
     
   • Login ID - A valid database uid.
     
   • Password - A valid database password.
     
   • XA Info - Refer to OpenLink's extensive Distributed Transaction Processing documentation for use of this field.
     
8. Click Next.
   
9. The third tab contains settings that are not required for a basic connection:
   
   
   • Read Only connection - Specifies whether the connection is "Read-only." Make sure the checkbox is unchecked to request a "Read/Write" connection.
     
   • 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.
     
   • Disable interactive login - Suppresses the ODBC "Username" and "Password" login dialog boxes when interacting with your ODBC DSN from within an ODBC compliant application.
     
   • 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.
     
   • Row Buffer Size - Specifies the number of records to be transported over the network in a single network hop. Values can range from 1 to 99.
     
   • 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").
     
10. Click Next.
    
11. Click on the 'Test Data Source' button to make a connection to the database to verify connectivity:
    
    
12. A successful connection to the database has been made:
    
    

Next...

• Test your DSNs with our sample program.

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.

The Multi-Tier Admin Assistant provides an HTTP-based interface to the server settings including those found in the Rulebook. This interface has been extended to support configuration of the ZeroConf settings in the Server Component Administration section, called Zero Config Administration.

The Zero Config Administration pages are very much like Client Data Source configuration pages -- they have the same layout and descriptions as they are essentially data sources stored on the server.

To make a new Zero Configuration entry, follow this sequence:

1. From the Server Components Administration menu, chose the Zero Config Administration sub menu, and then Zero Config Administration by Wizard. A list of current configurations is shown:
   
   
2. Press the Add button. Enter a suitable name for the configuration:
   
   
3. Enter the database details. The parameters are identical to those in the ODBC DSN configuration wizard. For each parameter you wish to configure, you need to enable it by checking the box on the left side. Each field is disabled until the check box is marked.
   
   
4. Enter the additional connection parameters. In same way as previous page, each parameter field needs to be enabled by the check mark on the left side.
   
   
5. The complete configuration parameters are now shown:
   
   
6. The Zero Config entry now appears in the list:
   
   

In the Server Components Administration menu, drill down to Zero Config Administration --> Zero Config Administration by Form. The list of current configurations will be shown. Chose one to edit or delete, or click Add to make a new configuration.

All parameters required in the form are the same as for any other DSN configuration. The Host and Port fields are not available, because this information is supplied by the Request Broker hosting the service.

When configuring a DSN in the Windows ODBC Driver Manager, the Server field will offer a drop-down menu of available Zero Config targets --

When configuring a DSN in the HTTP-based Admin Assistant, the Server field will offer a drop-down menu of available Zero Config targets --

During the configuration of a DSN in the Admin Assistant it is currently not possible to dynamically discover and present the Zero Config entries. However, you can manually put a Zero Config entry in the Server field.

1. Specify the location of your Request Broker and its dependent components. Also set restrictions on number of Agents, and number of connections.
   
   Click the Next button.
   
   
2. Linger Timeout: The number of seconds an OpenLink Agent without connections will linger before being terminated by the OpenLink Request Broker, Specify 0 here to disable lingering. Lingering is a feature for avoiding repetative load/unload overhead of agents that are frequently used for short, quick concurrent open/close connections.
   
   This setting is global to all agents. For specific agent settings, use the LingerTimeout value in the agent environment section.
   
   Set Resolving of IP addresses to hostnames. The logging will show the hostname instead of the IP number if this option is selected. Switch off hostname lookup to avoid possible delays when frequently looking up unknown (new) IP numbers through a distant uncached DNS table. This parameter will have a direct affect on the type of match that is to be used for the StartupBy, ShutdownBy and ShutdownFrom parameters under the Security section.
   
   Click the Next button.
   
   
3. To help with troubleshooting, turn on session logging and extra information. Or run the broker in foreground mode to view the trace. Then click on the Next button.
   
   
4. Enter buffer size values for the inbound and outbound network messages for each OpenLink Agent (it is advisable to take the default values presented). Then click the Next button.
   
   
5. Enter values for Database Agent session initialization, Broker Contact, and initialization failure retry counts by entering values into the respective fields as depicted below (it is advisable take the defaults). Then click on the Next button.
   
   
6. Check the related boxes presented in order to select the Network Transport Protocol to be used by your Request Broker and Database Agents when communicating with your OpenLink Data Access Clients. Then click on the next button.
   
   
7. You can choose to enable the OpenLink Ping WatchDog. All OpenLink components automatically use the keep-alive feature built in to most current implementations of TCP/IP stack. If keep-alive is not available the Ping WatchDog can be enabled in attempt to compensate for this. Click the Next button to continue.
   
   
8. If you have more than one Network Interface Card (NIC) installed on your OpenLink Server machine, then you can enter a value in the Force IP Address field that represents the IP address that you want the Request Broker to listen at.
   
   
9. Enter the port number on which the OpenLink Request Broker will listen for client connections. Each OpenLink Request Broker running on the same host must have a unique port number assigned to it.
   
   You can also designate port number ranges to be used by the Broker to advertise other OpenLink services (e.g., JDBC Agent used by OpenLink Drivers for JDBC). Once completed, click the Next button to continue.
   
   
10. Click on the Save button to save your changes permanently.
    
    
11. Click the Exit button to leave the Broker Settings Wizard.
    
    

You can configure your Request Broker via Forms or Wizards. You select this option from the Admin Assistant and you will be presented with a screen similar to the snapshot below.

Each Broker session settings field contains a description of the values that need to be entered into each of the forms fields. In addition a brief description of the use of each of these values is provided below each field.

Understanding how to maintain Session Aliases is a critical part of understanding how to create session rules. You can create, modify, edit, and delete Session Aliases in two ways: you either use the Admin Assistant's GUI interface, or you manually edit the session rulebook using a text editor (only recommended for advanced users).

The steps that follow guide you through the Session Alias management process using the Admin Assistant's GUI. Before performing any of these steps you may need to start the Admin Assistant, by following the steps below:

1. Start the Request Broker
   
2. Start a Web Browser session
   
3. Enter the appropriate URL into your browser (adjusting the port number, if you changed the Admin Assistant port number during installation):
   
   • If the Request Broker is running on the same machine as your web browser, enter:
     
     

     http://localhost:8000/

     
     
   • If the Request Broker is running on another machine than your web browser, enter:
     
     

     http://<hostname or IP address>:8000

     
     
     

Domain Aliases

The steps that follow show you how to manage Domain Aliases:

1. Follow the "Server Components Administration"->"Session Rules Administration"->"Session Rules Book Aliases"->"Edit Domain Aliases" menu tree which brings you to a screen identical to the one depicted below.
   
   The Admin Assistant presents you with a list of pre-configured Domain Aliases, click on the "Edit" hyperlink to change settings, the "Remove" hyperlink to delete an Alias, and the "Add" button at the bottom of the screen to create a new Domain Alias.
   
   
2. The example below assumes that you are modifying a Domain Alias named "ora8" with the attribute values "Oracle 8". This implies that you want to take note of Domain Connection Attributes from a Multi-Tier Client that start with the value "Oracle 8" evaluation against a mapping rules template. Once you have completed your input click the "Update" button.
   
   
3. You then commit your changes to the rule book by clicking on the "Reinitialize the Multi-Tier Request Broker with these settings" hyperlink. See screen shot below:
   
   
4. Admin Assistant confirms commitment of your changes to the rule book.
   
   

User Aliases

The steps that follow show you how to manage User Aliases using the Admin Assistant:

1. Follow the "Server Components Administration"->"Session Rules Administration"->"Session Rules Book Aliases"->"Edit User Aliases" menu tree which brings you to a screen similar to the one depicted below.
   
   The Admin Assistant presents you with a list of pre-configured User Aliases if any exist, if this is your first time there will be not items listed. Click on the "Add" hyperlink to create a new User Alias.
   
   
2. The example below assumes that you are creating an User Alias named "Sales" with attribute values of "Test" or "Mary", the use of the caret symbol (character "^") and the Dollar symbol indicate the start and end of regular expression evaluation values respectively. The Pipe symbol (character "|") indicates an OR condition. Thus the entry depicted below implies that you want to take note of User Connection Attributes from a Multi-Tier Client that hold the values "Test" or "Mary" for evaluation against a mapping rules template. Once you have completed your input click the "Add" button.
   
   
3. You then commit your changes to the rule book by clicking on the "Reinitialize the Multi-Tier Request Broker with these settings" hyperlink. See screen shot below:
   
   
4. Admin Assistant confirms commitment of your changes to the rule book.
   
   

OpSys (Operating System) Aliases

The steps that follow show you how to manage OpSys Aliases using the Admin Assistant:

1. Follow the "Server Components Administration"->"Session Rules Administration"->"Session Rules Book Aliases"->"Edit Operating System Aliases" menu tree which brings you to a screen identical to the one depicted below.
   
2. The Admin Assistant presents you with a list of pre-configured OpSys Aliases if any exist, if this is your first time no items will be listed. Click on the "Add" hyperlink to create a new OpSys Alias.
   
   
3. The example below assumes that you are creating an OpSys Alias named "ClientOS" with attribute values of "win32" or "unix". The Pipe symbol (character "|") indicates an OR condition. Thus the entry depicted below implies that you want to take note of OpSys Connection Attributes from a Multi-Tier Client that start with the values "win32" or "unix" for evaluation against a mapping rules template. Once you have completed your input click the "Add" button.
   
   
4. Commit your changes to the rule book by clicking on the "Reinitialize the Multi-Tier Request Broker with these settings" hyperlink. See screen shot below:
   
   
5. Admin Assistant confirms commitment of your changes to the rule book.
   
   

Machine Aliases

The steps that follow show you how to manage User Aliases using the Admin Assistant:

1. Follow the "Server Components Administration"->"Session Rules Administration"->"Session Rules Book Aliases"->"Edit Operating Machine Aliases" menu tree which brings you to a screen identical to the one depicted below.
   
2. The Admin Assistant presents you with a list of pre-configured OpSys Aliases if any exist, if this is your first time no items will be listed. Click on the "Add" hyperlink to create a new Machine Alias.
   
   
3. The example below assumes that you are creating an Machine Alias named "MyNetwork" with an attribute value of "123.123.123". This implies that you want to take note of Machine Connection Attributes from a Multi-Tier Client that start with the value "123.123.123" (you would do this to identify the Network portion of the client machines IP address). Once you have completed your input click the "Add" button.
   
   
4. Commit your changes to the rule book by clicking on the "Reinitialize the Multi-Tier Request Broker with these settings" hyperlink. See screen shot below:
   
   
5. Admin Assistant confirms commitment of your changes to the rule book.
   
   

Application Aliases

The steps that follow show you how to manage User Aliases using the Admin Assistant:

1. Follow the "Server Components Administration"->"Session Rules Administration"->"Session Rules Book Aliases"->"Edit Application Aliases" menu tree which brings you to a screen identical to the one depicted below.
   
2. The Admin Assistant presents you with a list of pre-configured Application Aliases, click on the "Edit" hyperlink to change settings, the "Remove" hyperlink to delete an Alias, and the "Add" button at the bottom of the screen to create a new Application Alias.
   
   
3. The example below assumes that you are modifying an Application Alias named "msoffice" with attribute values of "MSACCESS" or "EXCEL" or "MSQRY32". The Pipe symbol (character "|") indicates an OR condition. Thus, the entry depicted below implies that you want to take note of Application Connection Attributes from a Multi-Tier Client that hold the values "MSACCESS" or "EXCEL" or "MSQRY32" for evaluation against a mapping rules template. Once you have completed your input click the "Update" button.
   
   
4. Commit your changes to the rule book by clicking on the "Reinitialize the Multi-Tier Request Broker with these settings" hyperlink.
   
   
5. Admin Assistant confirms commitment of your changes to the rule book.
   
   

Determining The Values of Multi-Tier Client Generated Connection Attributes

To manage Aliases for non-user-configurable Connection Attributes, determine the relevant values with the following steps:

1. Start the Request Broker in Debug Mode
   
2. Then make a connection from your Multi-Tier Client
   
3. Your Request Broker's debug window will contain something similar to the following:
   
   

   oplrqb: client-machine.YourDomain called (123.123.123.100.1510)
   oplrqb: request: domain=Oracle 8 database= serveropts=
   oplrqb: connectopts= user= opsys=win32 readonly=0
   oplrqb: application=OPLSCAN processid=384

   
   
4. Take note of the values assigned to the following Connection Attributes: opsys, readonly, and application. Apply these values to the appropriate Aliases that your are attempting to configure.

Advanced Server Components Configuration (Multi-Tier)

Server-side Configuration for SSL

In order to make use of this functionality, you need to create a certificate on the server running the request broker. On Unix platforms we have provided a bin/mkcert.sh script as part of the installation. On other platforms you may have to run openssl by hand or use another system to generate the PEM file (such as generating it on a unix server and copying the files across).

A sample run of the mkcert.sh script, showing the various questions it asks to identify your organization, follows:

bash$ cd /usr/openlink/bin/
bash$ ./mkcert.sh mykey
Checking OpenSSL: OpenSSL 0.9.7d 17 Mar 2004
Generating a 512 bit RSA private key
.++++++++++++
.......++++++++++++
writing new private key to 'mykey.key'
-----
You are about to be asked to enter information that will be incorporated
into your certificate request.
What you are about to enter is what is called a Distinguished Name or a DN.
There are quite a few fields but you can leave some blank
For some fields there will be a default value,
If you enter '.', the field will be left blank.
-----
Host name (externally visible) [host.example.com]:purple
Organization (eg. company) [OpenLink Software]:
Organizational Unit [Research & Development]:Product Development
State or Province Name (full name) []:Surrey
Locality Name (eg. city) []:Croydon
Country Name (2 letter code) [US]:UK
1024 semi-random bytes loaded
Generating DH parameters, 512 bit long safe prime, generator 2
This is going to take a long time
..+........................+...........................+.......+...........
[]
.+.....++*++*++*++*++*++*
subject= /CN=purple/O=OpenLink Software/OU=Product Development/ST=Surrey/L=Croydon/C=UK
notBefore=Nov 12 10:43:14 2004 GMT
notAfter=Nov 10 10:43:14 2014 GMT
MD5 Fingerprint=E0:DB:53:E7:E7:68:21:53:1C:2B:1E:8E:D9:BF:25:F0
Created private key parameters in mykey.key
Created public key parameters in mykey.cer
bash$

Having created the key-pair, you now need to tell the request broker to use them. This requires the following lines to be present in the rulebook (oplrqb.ini):

[Request Broker]
....
SSLKeyFile = mykey.pem
SSLRequired = No

The SSLKeyFile is the filename of the key you just created; to deny connections without SSL, set SSLRequired

Yes instead.

You can also put these options in the individual database agent sections, such that one key is used for e.g. Ingres, and another for SQL Server, or one for your sales database and another for people coming in from VPN IP#s (by editing the mapping rules to match on a per-IP# basis). For example:

[generic_sqlserver]
.....
SSLKeyFile = mykey-sqlserver.pem
SSLRequired = Yes                  ; All SQLServer connections
MUST use SSL

As an alternative to editing oplrqb.ini by hand, you can use the web-based Administrator GUI, either the form or wizards, to set the SSL Key File and SSL Required fields, thus:

Figure: 1. Server-side SSL Configuration of Request Broker via Web Assistant

Figure: 2. Server-side SSL Configuration at the database agent level via Web Assistant

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

OpenLink Product Support does not provide customized shell scripts to automate Broker startup or any other feature of our software. However, we do provide a sample shell script as a courtesy to those individuals who may want general guidance before creating their own scripts.

>> Begin file
#!/bin/sh
#
# Run the OpenLink Request Broker
# For entry in /etc/rc2.d/SnnOpenLinkBroker, where nn is 90 or higher.
# Typically, nn is 98 so that it precedes the CDE login process which
# does not return.
BIN_DIR=/usr/openlink/bin
if [ "$1" = stop ]
then
echo "Shutting down OpenLink Request Broker ..."
# This code derived from the OpenLink rqbshut script.
#######################################################################
process=oplrqb
set - `ps -e | grep " $process\$" | grep -v grep`
if [ $# -eq 0 ]
then
echo $0: $process is not running
exit 1
fi
kill $1 2>/dev/null
if [ $# -eq 0 ]
then
echo $0: unable to shutdown $process
exit 1
fi
echo $0: $process shutdown complete
exit 0
echo "Shut down process but not exiting script"
fi
# Else, assume start.
# BIN_DIR=/export/home/openlink/sschadt/bin
exe=$BIN_DIR/oplrqb
if [ -x $exe ]
then
# See OpenLink installation guide for alternatives.
if id | grep "uid=0" >/dev/null 2>&1
then
# Start broker under its owner's identity.
#  set - `ls -l $exe`   (this line was clearing out $1)
# See if the file exists and use $? to determine outcome
ls -l $exe >/dev/null 2>&1
if [ $? -eq 0 ]
then
id="$1"
echo "The id being used is '$id'"
echo "Starting OpenLink Request Broker with '"$id"' identity."
su "$id" -c "$exe &"
echo "ps -ef | grep opl ..."
ps -ef | grep opl
exit $?
fi
fi
echo "Starting OpenLink Request Broker."
$exe >/dev/null 2>&1 &
exit $?
else
echo "OpenLink Request Broker not found: $exe"
exit 1
fi
<< end of file

If you use our Multi-Tier components through with a firewall, several ports must be opened to permit requests from Generic Clients to Request Broker and Database Agents (and their responses).

Some ports are user or admin configurable; some are not.

Unconfigurable Ports

TCP and UDP ports 60001 must be open. These ports are used by the Request Broker and the OpenLink License Manager, and cannot be changed.

Configurable Ports

Configurable ports are specified in the [Protocol TCP] section of your Session Rulebook (default, oplrqb.ini). You can use any text editor to open your Rulebook, and edit this section:

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

• The Request Broker listens on the TCP port specified in the Rulebook as Listen. (Release 3.x and earlier listened at PortLow.)
  
• Listen and PortLow are generally best set to the same value.
  
• The Request Broker restricts Database Agents to use only ports in the range between (and including) those specified in the Rulebook as PortLow and PortHigh. Specific Agent ports are requested from and assigned by the operating system when an Agent is instantiated; they are not preemptively reserved.
  
• The span between PortLow and PortHigh is generally best set to twice the licensed number of Database Sessions. At minimum, this span should be the licensed number of Database Sessions plus 5 (and thus, not less than 10).

Related Documentation

• Firewall Considerations for Multi-Tier "Enterprise" Edition Data Access Drivers
  
• Error Message: Unable to contact the OpenLink License Manager
  
• OpenLink License Manager Networking Considerations
  
• Configure Multi-Tier Request Broker for Use on Machines with Multiple Network Cards

• The Request Broker host must accept (and all intervening firewalls must permit) inbound connections from all client hosts (and from the Request Broker host itself) to (and responses from) --
  
  • TCP port 60001, in all Releases;
    
  • UDP port 60001, in all Releases;
    
  • TCP port 5000, in Release 3.x and earlier;
    
  • TCP port specified by Rulebook setting [Protocol TCP]:Listen in Release 4.x and later; default is 5000; and
    
  • TCP ports between Rulebook settings [Protocol TCP]:PortLow (default 5000) and [Protocol TCP]:PortHigh (default 60000) (including the port numbers specified for these settings).

• The Generic Client hosts (and all intervening firewalls) must permit outbound connections to (and responses from) the Broker host on --
  
  • TCP port 5000, in Release 3.x and earlier;
    
  • TCP port specified by Rulebook setting [Protocol TCP]:Listen in Release 4.x and later; default is 5000; and
    
  • TCP ports between Rulebook settings [Protocol TCP]:PortLow (default 5000) and [Protocol TCP]:PortHigh (default 60000) (including the port numbers specified for these settings).

• If the Database Agent makes a network connection to the target DBMS (in a "three-tier" or "gateway" deployment), the database server host must accept (and all intervening firewalls must permit) inbound connections on the DBMS listen port(s) (e.g., 5432/tcp for PostgreSQL; 1433/tcp, 1433/udp, 1434/tcp, and 1434/udp for SQL Server, etc.).

• If you have a stateful firewall, return packets from the Request Broker and Database Agents to the clients should be taken care of automatically. If not, you will also have to address the ephemeral client-side ports.

• The Multi-Tier Admin Assistant listens at TCP port 8000 by default. This is configurable, via the HttpPort setting in the [Startup] stanza of the www_sv.ini file, typically found in the w3config subdirectory of the bin directory containing the Broker executable, oplrqb.

Related Documentation

• Configuring Server-side Firewalls for Multi-Tier Connectivity
  
• Error Message: Unable to contact the OpenLink License Manager
  
• OpenLink License Manager Networking Considerations
  
• Configure Multi-Tier Request Broker for Use on Machines with Multiple Network Cards

Release 6.x (and Release 5.2 on some platforms) and newer drivers ship with the separate OpenLink License Manager, oplmgr.

General Guidance, for Windows, Linux, and other Unix-like OS (except macOS)

If you receive the above error message, check whether the OpenLink License Manager is running on the licensed host -- i.e., the Request Broker host for the Enterprise Edition (Multi-Tier); the client driver host for the Lite or Express Editions (Single-Tier); or the Virtuoso server host.

• on Windows, use the Task Manager or similar.
  
• on Unix-like OS, use a command like this (may vary, depending on your active shell) --
  
  

  ps -ef | grep oplmgr | grep -v grep

  
  

If the License Manager is already running, make sure that networking and firewalls are properly configured.

If networking and firewall are configured properly, and the License Manager is running, but the error persists, then kill the oplmgr process (e.g., kill -9 <PID>), and proceed as below.

If the License Manager is not running, do this:

1. Ensure the proper license file(s) is/are in place, and named as we shipped them (e.g., pro9_lt.lic, oplrqb.lic, ee_inf_lt.lic).
   
2. Remove or rename any expired or otherwise extraneous OpenLink license files.
   
3. Create or modify the OPL_LICENSE_DIR environment variable, and ensure that it includes each and every directory that contains one of your active OpenLink license file(s).
   
4. Start the License Manager --
   
   • On Windows, use the Services or Component Services control panel (often found in the Administrative Tools sub-folder).
     
   • On Unix-like OS, set the OpenLink environment by running the appropriate script for your shell (adjusting the path as appropriate) --
     

     shell	command
     sh, bash, zsh and related	. /path/to/openlink.sh
     ksh and related	source /path/to/openlink.sh
     csh, tcsh and related	source /path/to/openlink.csh

     
     
     • Our recent distributions start the License Manager as part of the above scripts; if you see no message about oplmgr starting, then also execute this command --
       
       

       oplmgr +start

       
       
5. Confirm that the License Manager has started successfully --
   
   • on Windows, use the Task Manager or similar.
     
   • on Unix-like OS, use a command like this (may vary, depending on your active shell) --
     
     

     ps -ef | grep oplmgr | grep -v grep

     
     
6. Test a connection.

Special Guidance for Release 6.x or 7.x on macOS Snow Leopard (10.8.x) and later

Changes in the Gatekeeper in Snow Leopard (10.8.x), Mavericks (10.9.x), Yosemite (10.10.x), El Capitan (10.11.x), Sierra (10.12.x), High Sierra (10.13.x), Mojave (10.14.x), and Catalina (10.15.x) required updated License Manager binaries and startup scripts. Installers produced after 2014-12-04 for Release 6.x and 7.x, and all installers for Release 8.x, include these updates. Updated oplmgr installers are also available for users with drivers installed, or driver installers dated, prior to 2014-12-04.

1. If your Release 6.x or 7.x driver installer .dmg contains an .mpkg dated before 2014-12-04, please download this second installer package for use on macOS Catalina (10.15.x), Mojave (10.14.x), High Sierra (10.13.x), Sierra (10.12.x), El Capitan (10.11.x), Yosemite (10.10.x), Mavericks (10.9), Snow Leopard (10.8.x), or Lion (10.7.x) -- oplmgr.pkg
   
2. Double-click to run the .pkg.
   
   
3. This installer should automatically move any previously installed license files from --
   
   

   /Library/Application Support/openlink/bin/*.lic

   
   -- to --
   
   

   /Library/Application Support/openlink/Licenses/*.lic

   
   -- but some users have reported otherwise, so you may need to do this relocation yourself, with /Applications/Utilities/Terminal.app --
   
   

   cd "/Library/Application Support/openlink/Licenses"
   sudo mv ../bin/*.lic .

   
   
4. Confirm that the oplmgr process is running with this Terminal.app command --
   
   

   ps -ef | grep oplmgr | grep -v grep

   
   If it's running, output should look something like this --
   
   

   0   111     1   0 Wed09AM ??         0:00.57 /Library/Application Support/OpenLink/bin/oplmgr -fd /Library/Application Support/OpenLink/Licenses

   
   If it's not running, try a reboot, or manually execute the following Terminal.app command, and then check for the process again --
   
   

   sudo /Library/Application\ Support/OpenLink/bin/oplmgr -fd /Library/Application\ Support/OpenLink/Licenses &

   
   
5. Once the oplmgr process is running, try testing the driver again.

Related Documentation

• Firewall Considerations for Multi-Tier "Enterprise" Edition Data Access Drivers
  
• Configuring Server-side Firewalls for Multi-Tier Connectivity
  
• OpenLink License Manager Networking Considerations
  
• Configure Multi-Tier Request Broker for Use on Machines with Multiple Network Cards
  
• OpenLink License Manager Usage Notes
  
• Start the License Manager Process
  

If the License Manager discovers another License Manager is using a license with the same serial number, it will stop allocating licenses and report "License already in use".

If the License Manager cannot communicate with the network, it will do the same.

The OpenLink License Manager uses the multicast IP address 224.0.0.24 on ports 60001/udp and 60001/tcp to send and receive communications with other OpenLink components including other License Managers.

It is becoming common for operating systems to have a default firewall enabled that blocks all network traffic, such that specific ports must be explicitly opened and/or applications must be explicitly granted communications permission. In such cases, port 60001 must be opened on both TCP and UDP, for both inbound and outbound communications, and/or oplmgr must be granted similar permissions. If you cannot figure out how to open this port in your local environment, please contact OpenLink Software Support for assistance.

Related Documentation

• Firewall Considerations for Multi-Tier "Enterprise" Edition Data Access Drivers
  
• Configuring Server-side Firewalls for Multi-Tier Connectivity
  
• Error Message: Unable to contact the OpenLink License Manager
  
• Configure Multi-Tier Request Broker for Use on Machines with Multiple Network Cards
  

If the Multi-Tier server components are installed on a machine containing multiple network cards, even if only one is configured for network use, you may experience various issues including timeouts and network communications failures. To avoid or resolve these, take the following action:

1. Use a text editor to open your Broker Rulebook; by default, oplrqb.ini file found in the /bin sub-directory of your OpenLink server components installation.
   
2. Locate the [Protocol TCP] section.
   
3. Remove the semicolon (;) which appears in front of the IPAddress parameter. For example:
   
   

   ;IPAddress      = 192.168.0.1     #Before
   IPAddress      = 192.168.0.1      #After

   
   
4. Set the IPAddress value to the address which is reachable by all client hosts (i.e., if the Broker host has an "internal" and an "external" IP address, set this value to the "external"). For example:
   
   

   IPAddress      = 83.323.137.120

   
   
5. Save your changes and exit the file.
   
6. Restart the Request Broker to activate the changes.
   
7. Client DSNs should now be able to pass either the IP address, or any fully-qualified hostname (e.g., broker-host.example.com) which resolves to that address.
   

Users often need to run two Multi-Tier Request Brokers on a single machine. Development testing, load balancing, and related issues often necessitate this. If you need to intend to test with one Broker running and one Broker down, the only thing that you need to is provide unique Listen and Administrative Assistant tcp ports during installation. If you intend to run both Brokers at the same time, read this --

1. Login to the machine that hosts the OpenLink Request Broker(s).

2. Use the bash command to open a bash shell. Alternatively, use the sh command to open a bourne shell. # This step is optional.

3. cd into the bin sub-directory of the pre-existing installation.

4. vi the oplrqb.ini file.

5. Locate the [Protocol TCP] section.

6. Identify the TCP port passed to Listen. For example:

[Protocol TCP]
PingWatchdog = No  ; Send check-alive packets
PingInterval = 600  ;   every <PingInterval> seconds
;IPAddress      = 127.0.0.1      ; Overrules found interface address
PortLow      = 5020
;PortHigh  = 60000
Listen       = 5020

5. Exit the file.

6. cd into the ~/openlink/bin/w3config directory.

7. vi www_sv.ini.

8. Find [Startup].

9. Identify the TCP port passed to HttpPort. For example:

[Startup]
HttpPort          = 8005
HttpRoot          = html
Timeout           = 60
TclInclude        = include
ScriptDirectories = /scripts
CGIDirectories    = /cgi-bin
IndexPage         = /index.html

10. Exit the file.

11. If you intend to add a 6.x or newer installation to a machine hosting OpenLink's 1.x, 3.x, 4.x, or 5.x builds, it may be necessary to shutdown the existing Request Broker and restart it after the new, 6.x+ Broker is running. Plan and act accordingly.

12. Create a new install directory to host the new Multi-Tier server components.

13. Download the installation files and shell script into this directory.

14. Execute the .profile of the target database or database native client.

15. Run the following command to start the installation:

sh install.sh

16. Provide *unique* TCP ports for use by the new Request Broker and Administrative Assistant.

17. Allow the installation to complete.

18. Execute the following command from the root of the new installation:

. ./openlink.sh

19. cd into the bin sub-directory of the installation.

20. Download the relevant license file into this directory.

21. 6.x+ users execute this command:

./oplmgr +start

22. Execute this command:

./oplrqb +loglevel 7 +logfile oplrqb.log

23. Test a connection to the new Broker. Remember to use this new Broker's Listen port in your DSNs or URLs.

24. Restart your pre-existing Broker, if applicable.

25. Test a connection to your pre-existing Broker.

Can be done for UDA thru 5.2

InstallShield makes it possible

article based on http://support.mobileautomation.com/support/tsarticle.asp?tsid=277

Issue:

Any application can easily be made into an unattended and silent installation if it's setup install program is based on 'InstallShield'. InstallShield is an industry standard installation packaging system for initially installing many programs.

To do this you would use a built in function of <nopInstallshield which allows you to create an answer file (ISS). This file would be create by walking through a real installation on a test PC and literally remembering all the selections you make as you go through the install. These settings would then be saved to an answer file (setup.iss) which is created by default in the WINNT or Windows directory.

You can then re-execute the setup.exe installation by simply pointing to the setup.iss answer file as an option. InstallShield will silently walk through the installation using all of your saved options and settings.

It is also possible to perform a silent uninstall using a similar trick.

Use the following command line options to accomplish this task.

Resolution:

Install shield options

setup.exe -r     will create answer file

setup.exe -s -a /s /f1setup.iss     will execute the silent install

setup.iss will be created in the Winnt directory

To Uninstall

Example:

"C:\WINDOWS\ISUNINST.EXE" -y -a -m -f "C:\Program Files\Path To\DeIsL1.isu"

You will need to adjust the path of the ISU file for your particular application.

"

OpenLink's Multi-Tier Universal Data Access solution permits simplex and duplex encryption, for maximum flexibility according to the user's needs. (Single-Tier does not presently support encrypted communications.)

Simplex is one-way, encrypting all communications sent from the OpenLink Generic Client to the OpenLink Server (Request Broker or Database Agent), or from the Server to the Client. Duplex simply combines these two, resulting in fully secure communications between OpenLink Client and Server.

Data encryption will have some impact on performance because additional work is being performed before the data is presented to the calling application. There is always some trade-off between security and speed. However, we have optimized our encryption algorithms to minimize this overhead.

Client configuration

Client data encryption is configured through the OpenLink Client Configuration Utility, on Windows and Mac OS, or through the HTTP-based OpenLink ODBC Administrator, on Unix. The DataEncryption value in the odbc.ini file's [Communications] stanza may also be manually edited on Mac OS or Unix; on Windows, this setting is found in the Registry at HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\OPENLINK.INI\Communications\DataEncryption.

This section key can be set to Yes or 1 to enable data encryption, and to No or 0 to disable it.

When enabled, this setting will cause all communications from the Client to the Request Broker or Database Agent to be encrypted. This does not cause data returned from the Request Broker or Database Agent to be encrypted.

Server configuration

Request Broker and Database Agent data encryption is configured through the [Communications] stanza of the Rulebook, oplrqb.ini. The HTTP-based OpenLink Admin Assistant may be used for this configuration (Server Components Administration >> Request Broker Administration >> Configure Request Broker's Parameters by Form >> Communications Parameters), or the Rulebook (oplrqb.ini) may be manually edited.

The DataEncryption key should be set to Yes or 1 to enable data encryption. To disable data encryption, use No or 0.

When enabled, this setting will cause all communications from the Request Broker or Database Agent to the Client to be encrypted. This does not cause data returned from the Client to be encrypted.

Configure Intersolv, Merant or DataDirect Driver Managers to Use OpenLink Drivers

You may configure the Intersolv, Merant or DataDirect Driver Manager to use OpenLink drivers. To proceed, take the following action:

1. Locate and open the Driver Manager's odbc.ini file.
2. Locate the [ODBC Data Sources] portion of the file.
3. Add your DSN to the list. For example:

[ODBC Data Sources]
OpenLink = OpenLink Generic ODBC Driver

4. Create a standard OpenLink DSN in this odbc.ini file. For example:

[OpenLink]
Driver          = /home/openlink/lib/oplodbc.so.1
Host            = saturnus
ServerType      = Informix 7.3
FetchBufferSize = 99
UserName        = informix
Password        = ol_informix
Database        = stores7
ReadOnly        = no

5. Save your changes and exit the odbc.ini file.
6. Search for the Driver Manager's odbcinst.ini file.
7. If does not exist, create one.
8. Add the following entry to the odbcinst.ini file:

[OpenLink Generic ODBC Driver]
APILevel=1
ConnectFunctions=YYN
Driver=/usr/openlink/lib/oplodbc.sl.1
DriverODBCVer=02.50
FileUsage=0
SQLLevel=1

9. Save your changes and exit the file.
10. Test.

Customize Your Multi-Tier Security

The following instructions will enable you to provide greater security for your database:

1. List all Domain aliases (aka "ServerTypes") used in your client-side DSNs. For example:
   
   

   Oracle 8.0.x

   
   
2. Use a text editor to open the oplrqb.ini file which resides in the /bin sub-directory of your OpenLink server components installation.
   
3. Locate [Domain Aliases] and determine how those listed above are resolved. For example:
   
   

   [Domain Aliases]
   Oracle 8.0.x = ora80

   
   
4. Locate the resolved names of the Domain Aliases under [Mapping Rules]. For instance:
   
   

   [Mapping Rules]
   ora80:*:*:*:*:*:* = accept generic_ora80.

   
   
5. Determine whether any of these fields need added security. Here is a breakdown:
   
   

   domain_name:database:user:client_os:machine_id:app_name:operation_mode

   
   (Note: "operation_mode" refers to read-only (ro) or read-and-write (rw) access.)
   
6. Build rules to govern whether connection requests will be accepted or rejected by the Broker. For instance:
   
   

   ora80:*:scott:*:*:*:* = reject User "scott" is not allowed to connect to this service.

   
   This rule rejects all connection attempts made by user scott, and tells them so. You can substitute any plain-text rejection message here, and it will be delivered to users who are blocked by this rule.
   
7. Order each rule properly. For example:
   
   

   ora80:*:*:*:*:*:* = accept generic_ora80
   ora80:*:*:*:*:msaccess:* = reject Microsoft Access is not allowed to connect to this service.

   
   The first rule permits access to generic_ora80 in all scenarios. The second rule is never visited, since the preceding rule permits all ora80 requests.
   
   

   ora80:*:*:*:*:msaccess:* = reject Microsoft Access is not allowed to connect to this service.
   ora80:*:*:*:*:*:* = accept generic_ora80

   
   The first rule screens for and rejects connections requested by Microsoft Access. Connections not originating with Microsoft Access are passed on to the second rule, which permits all requests.
   
8. Save your changes and exit the file.
   
9. Restart your Broker.
   

Hide Login Boxes on Windows Clients

You may prevent Data Source login boxes from appearing, on Windows clients. The following instructions assist you with this task:

1. Open your client's ODBC Data Sources utility. (Control Panel)

2. Highlight your DSN. It will appear on the utility's User, System, or File tab.

3. Click on the "Configure" button.

4. Check the "No Login Dialog Box, if you are using OpenLink's Multi-Tier drivers.

5. Search your DSN's tabs for a "Hide Login Dialog" box, if you are using OpenLink's Single-Tier drivers. Then, check the "Hide Login Dialog" box, one you find it.

6. Click OK to save your changes.

7. Test.

It is sometimes necessary to link or re-link your Multi-Tier Database Agents. Typical reasons include:

• The existing Database Agent executable has some incompatibility with database or operating system libraries on your Broker host.
  
• No Database Agent executable was installed on your Broker host.

The files described below should all be part of all current agent installations. If the files discussed below are not found in your installation, you may have an older version of the software. In that case, please contact us for additional assistance.

We provide a relink script for each Database Agent. These scripts are named using the form -- <ld><XXXX><NN>[mv].

• ld - indicates a link script
  
• XXXX - first 3 or 4 letters of database name
  
• NN - database version number, to the same specificity as the corresponding Database Agents
  
• mv - if the agent is multi-threaded.

Examples:

• ldora81mv is for the multi-threaded agent for Oracle 8i.
  
• ldoig2 is for the single-threaded agent for Ingres II.

We have attempted to provide a set of generic link scripts for every version of Progress we support, to enable you to relink most easily. In some cases, you may need to create a custom relink script for Progress Agents. Note: Relinking Progress Agents is typically necessary only if you are running a version of Progress with a different patch level the one originally used for linking the agents shipped and you are connecting a SQL-89 Agent in shared memory mode.

Pre-requisites for relinking Database Agents

Requirements for all Database Agents

• Make a backup copy of your existing Agent(s).
  
• Insure that you have a C compiler and library linker installed on your database server.
  
• Set key OpenLink linking-script environment variables, which themselves reference key database environment variables required for making native connections to your database engine. You may prefer to adjust these values in the "dbpaths" file situated in the same directory as your database agent link script.
  
  • DB2
    
    

    DB2DIR=$DB2INST

    
    
  • Informix
    
    

    INFORMIX5DIR=$INFORMIXDIR
    INFORMIX6DIR=$INFORMIXDIR
    INFORMIX7DIR=$INFORMIXDIR

    
    
  • Ingres
    
    

    INGRES6DIR=$II_SYSTEM/ingres
    INGRES7DIR=$II_SYSTEM/ingres

    
    
  • Oracle
    
    

    ORACLE6DIR=$ORACLE_HOME
    ORACLE7DIR=$ORACLE_HOME
    ORACLE8DIR=$ORACLE_HOME

    
    
  • Progress / OpenEdge
    
    

    export PROGRES8DIR=$DLC
    export PROGRES9DIR=$DLC
    export PROGRES10DIR=$DLC

    
    
  • Solid
    
    

    SOLIDDIR=$SOLID

    
    
  • Sybase
    
    

    SYBASE10DIR=$SYBASE
    SYBASE11DIR=$SYBASE
    SYBASE4DIR=$SYBASE

    
    
  • Unify
    
    

    UNIFYDIR=$UNIFY../lib

    
    
  • Velocis
    
    

    VELOCISDIR=$VELOCIS

    
    
  • Virtuoso
    
    

    VIRTUOSODIR=$VIRTUOSO

    
    
• The ".../openlink/lib" (or similar) subdirectory that you are working with should be included in your system PATH. If it is not already, add this directory to the system PATH now.

Additional Informix-specific requirements

• Informix users must have an $INFORMIXDIR/lib/esql/ directory for successful relinking. This may be obtained and installed as part of the freely downloadable Informix Client SDK, available from IBM, if not already present as part of your installation.

Additional Progress-specific requirements

• All Progress users must have a $DLC/probuild/4gl/ directory, which requires a development license from Progress.
  
• All Progress users must set and export DLC and PROLOAD environment variables. DLC points to the root of the Progress installation. PROLOAD points to the $DLC/probuild/ directory.
  
• Progress 6 users must have an HLI/C license from Progress. For Progress 7, 8, and 9, this is not required

Relinking Database Agents for all DBMS

1. Ensure that all pre-requisites listed above have been addressed.
   
2. Navigate to the "lib" sub-directory of your OpenLink server components installation directory, e.g., "/usr/openlink/lib".
   
3. If relinking a SQL-89 Agent for Progress (proNNN_sv) --
   
   1. Confirm that the Progress environment variable DLC is set correctly.
      
   2. Confirm that the Progress environment variable PROLOAD is set correctly.
      
   3. Run the appropriate mkdlcX script, where X is the major version number of your Progress installation (i.e., 6, 7, 8, or 9). This will produce a file called dlcX.o.
      
   4. If you receive an error stating that any Progress library cannot be found, edit the mkdlcX script and remove the reference(s) to that file; then re-run the mkdlcX script. Repeat this step as needed.
      
4. Run the appropriate link script (ldXXXNN) which will attempt to build a new database agent.
   
5. At the end of the relink process, the new database agent executable will be automatically placed in the "bin" subdirectory directory of your OpenLink server components installation. The new database agent binary will be named according to the typical OpenLink conventions, i.e., XXXNN_sv or XXXNN_mv.
   
6. Navigate to the "lib" sub-directory of your OpenLink server components installation; typically --
   
   

   cd ../bin

   
   
7. Locate your newly linked agent. If it has a different name than the original agent, you can rename both so that the new one takes the place of the old, or you can edit your Broker Rulebook (oplrqb.ini) and change all occurrences of the old database agent name to the new agent name.
   
8. Restart your Broker.
   
9. Test.

Related

• Creating Custom Relink Scripts for Drivers and Agents for Progress/OpenEdge

Custom relink scripts may be needed when our standard scripts are incompatible with your database installation and/or environment. The Progress probuild utility enables you to create such custom scripts.

1. Locate the buildenv script, typically found in the $DLC/probuild/eucapp directory.
   
2. Ensure that the environment variable settings in the buildenv script are accurate for your system.
   
3. Set and export
   
   

   PROLOAD=$DLC/probuild
   export PROLOAD

   
   
4. Type the following command at your command line:
   
   

   $PROLOAD/eucapp/probuild

   
   
5. At the Install Link Script Into prompt, enter the full path to your ~/openlink/bin directory.
   
6. Click Continue.
   
7. Select ESQL/C Large Client Full from the product list.
   
8. Click Continue.
   
9. Give your relink script an appropriate name. For example:
   
   

   ldpro7
   ldpro8
   ldpro9

   
   
10. Give the executable to be produced an OpenLink-style Database Agent name. For example:
    
    

    pro73e_sv
    pro83b_sv
    pro91b_sv

    
    
11. Click Continue.
    
12. Do not specify any special configurable elements.
    
13. Click Continue.
    
14. Locate the database agent object code in the /lib sub-directory of your OpenLink installation. Object code files are named similarly to pro7_sv.o, pro8_sv.o, and pro9_sv.o.
    
15. Enter the full path to the relevant Database Agent object code (proxxx_sv.o) under "Object Files.'
    
16. Click Continue.
    
17. Exit probuild.
    
18. Repeat the relink process with your new relink script.

Changing User Access

1. Load the Admin Assistant in a browser. The default URL is http://broker-hostname-or-ip-address:8000/.
   
2. Drill down to Server Components Administration -> Admin Assistant Settings -> Configure the List of Users Allowed to use the Admin Assistant. When prompted to log in, use the defaults or whatever you've set previously.
   
3. Click Edit, Remove, or Add as appropriate, until the list reflects your intention.
   
4. Optionally, drill down to Server Components Administration -> Admin Assistant Settings -> Configure the Admin Assistant's Remote Access Filters. Here you can restrict the IP addresses which may use Web browsers to access the Admin Assistant.
   
5. When you've finished, stop and restart the Request Broker, which will automatically restart the Admin Assistant.
   
6. Test your new settings.

Resetting to Defaults

The default username and password of the Multi-Tier Admin Assistant are both admin. If you cannot log in with these values, you may have changed them during installation. You can reset these through the following steps:

1. Access the machine which hosts the Multi-Tier server components.
   
2. Open a CMD/DOS or Unix terminal session.
   
3. Navigate to the /bin/w3config sub-directory of the server-side installation.
   
4. Run setup or setup.exe. This program will reset both username and password to the defualt -- i.e., "admin".

Set Isolation Levels

You may use OpenLink's +initsql parameter to change your database isolation level. The following instructions will assist you with this task:

1. Insure that your database supports the operation which you want to implement. Verify the syntax which that database will accept.

2. Create a file in the /bin sub-directory of your OpenLink server components installation. This file should contain only the isolation level syntax. For example:

-Dsrv TXN_ISOLATION, SERIALIZABLE

3. Open the oplrqb.ini file which resides within the same /bin sub-directory.

4. Locate the [generic_XXXXX] section which corresponds to the database agent which you use. For example:

[generic_inf7]
Program     = inf7_mv.exe
Environment = INFORMIX7
OpsysLogin  = Yes
ReUse       = always
;Directory   = c:\temp
;ConnectOptions =
;ReadOnly  =
;CommandLine =

5. Locate the "CommandLine" parameter, and pass the file which you have created. For example:

CommandLine = +initsql yourisolationfile

6. Remove any semicolon (;) which may appear in front of CommandLine.

7. Save your changes and exit the oplrqb.ini file.

8. Restart the OpenLink Request Broker by typing the following commands from the same /bin sub-directory:

./oplshut
./oplrqb +loglevel 7 +logfile oplrqb.log

9. Test.

For connections to DB2

For connections to Informix

For connections to Ingres

For connections to Microsoft SQL Server

For connections to MySQL

For connections to JDBC Data Sources

For connections to ODBC Data Sources

For connections to Oracle

For connections to PostgreSQL

For connections to Progress / OpenEdge

The following options are not required for Shared Memory-mode connections -- which are only possible with SQL-89 drivers, and only when those drivers have been linked to exactly the same Progress library versions as are installed on the current host.

These options are all required for Sockets-mode connections. Any connection may be made in sockets mode if Progress instance has been started with this mode enabled.

Connection must be made in sockets mode when using --

• a Single-Tier Driver (whether SQL-89 or SQL-92),
  
• a SQL-92 Driver (whether Single-Tier or Multi-Tier),
  
• a Multi-Tier Database Agent (whether SQL-89 or SQL-92) that is not located on the same host as the Progress instance, and
  
• a SQL-89 Driver (whether Single-Tier or Multi-Tier) that has not been linked to the exact same Progress library versions as are installed on the current driver host.

For connections to Sybase

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: