This file describes the ODBC-ODBC Bridge specific attributes and how
they are used.

You may pass any of the following attributes to the ODBC-ODBC Bridge
or specify them in your odbc.ini file:

DSN
---

The data source name. This should already have been defined in your
ini file (for non-Windows platforms) or the registry (via the ODBC
Administrator in Windows). Any attributes the ODBC-ODBC Bridge
requires but which are not specified in the connection string are
pulled from the named data source definition.

DRIVER
------

This currently only has meaning to OOB in Windows (see the ODBC
specification for further information). If you are using a driver manager
in UNIX (e.g. the unixODBC driver manager) you should include a driver
attribute in your odbc.ini file which tells the driver manager which
ODBC driver the DSN relates to.

TARGETDSN
---------

The name of a datasource on the remote machine. You should set this up
with the Windows ODBC Administrator or define it in the ini file used
by the remote ODBC-ODBC Bridge Server. This MUST be a SYSTEM
datasource as the OOB server can only see SYSTEM data sources in
Windows.

SERVER
------

The fully qualified domain name of the machine where the remote data
source is located, where the ODBC-ODBC Bridge Server process is
installed and where an ODBC driver for the remote database is
available.

PORT
----

This is the port on the SERVER machine where the ODBC-ODBC Bridge
server (or an agent on its behalf such as inetd) is listening for
incoming connections. 

THIS IS NOT THE PORT SQLSERVER OR ANY OTHER DBMS IS LISTENING ON.

TRANSPORT
---------

Currently only TCPIP is supported. You should set this attribute to
"TCPIP".

From OOB 1.0.0.23 you can omit Transport and it is defaulted for you.

LOGONUSER
---------

This is the username used to log in to the remote machine (SERVER).
The ODBC-ODBC Bridge server will check the LOGONUSER user exists and
their password is LOGONAUTH. If this is successful then the server
process will change to become the specified user.

Whether or not you username and password are case-sensitive is up to
the operating system the OOB Server is running on.

LOGONAUTH
---------

See LOGONUSER above.
This is the password of the LOGONUSER on the machine SERVER.

TARGETUSER
----------

The TARGETUSER (if specified) is passed to the server as the ODBC UID
connection attribute used by ODBC drivers to restrict access to a set
of database users. This is NOT necessarily the name of a user who
exists as far as the operating system is concerned.

TARGETAUTH
----------

See TARGETUSER above.
This is passed to the server as the ODBC PWD connection attribute.

BlockFetchSize = n
------------------

0 <= n <= 100
Default: n=0

When set to a number greater than 0 this causes the OOB to use an
optimisation to retrieve rows from a result-set alot faster. This will
only work if you are not binding columns yourself and cannot be used
if you are going to perform positioned updates or deletes.

DisguiseWide = n
----------------

n = 0 (disabled), n = 1 (enabled)

This is a workaround for ODBC applications that do not recognise the
wide column types SQL_WCHAR, SQL_WVARCHAR and SQL_WLONGVARCHAR
(e.g. StarOffice). When set to 1 it converts these types to the normal
SQL_CHAR, SQL_VARCHAR and SQL_LONGVARCHAR. In StarOffice 5.1 and
5.2beta this must be set if you are going to MS SQLServer or you will
not see any tables. This is currently not available in the Windows 
dialogue for OOB.

MetaDataBlockFetch = n
----------------------

n = 0 (disabled) n = 1 (enabled)

By default OOB uses the above blockfetchmode automatically to retrieve
result sets generated by metadata functions. You can turn this off
(say if your ODBC driver does not support SQL_ATTR_ROW_ARRAY_SIZE) by
setting MetaDatBlockFetch to 1. A common symptom of an ODBC driver not
working correctly with metadatablockfetch is when you only see the
first 2 rows in a result set and possibly after that ever 10th row.

UseOOBDBAuth = n
----------------

n = 0 (disabled) n = 1 (enabled)

By default OOB uses the UID/PWD in the connection string (or the
username/authentication parameters in the call to SQLConnect) in
preference to the TargetUser/TargetAuth in the DSN (ini/registry) when
connecting to the ODBC driver. This is the logical thing to do as the
UID/PWD is often prompted for by the application connecting to the OOB
client.

If you set UseOOBDbAuth then the OOB will ignore the UID/PWD and use
TargetUser/TargetAuth (if they exist) in preference for the database
login. This flag was introduced for a problem using Crytal Reports
through OOB to Zortec/Tetra.

Unquote_Catalog_Fns
-------------------

n=0 (disabled) n = 1 (enabled)

Unquote_Catalog_Fns removes the double quotes from around names in the
calls to catalog functions such as SQLColumns. This gets around a
problem in Applixware (reported 16th March 1999 and assigned incident
number 4469466) where it can incorrectly quote arguments to the
catalog functions.

The default is 0.

Set to 1 to remove double-quotes from around arguments to catalog
functions.

MetaData_ID_Identifier
----------------------

n=0 (disabled) n = 1 (enabled)

MetaData_ID_Identfier causes the OOB client to call SQLSetStmtAttr
with the SQL_ATTR_METADATA_ID attribute to set it to SQL_TRUE. This
causes ODBC 3.0 drivers to treat strings in metadata functions as
literals. This attribute is useful if you have an application you
cannot change which assumes all strings in metadata calls are treated
as literal but are going to an ODBC driver containing tables etc with
special characters in them (e.g. _).  Applixware's AXData sometimes
needs this attribute defining.

The default is 0.

Set to 1 to cause the OOB Client to set SQL_ATTR_METADATA_ID to
SQL_TRUE meaning strings are treated as literals.
