ODBC Driver for Domino

Build 22.0.8509

Linux DSN Configuration

This section describes how to set up ODBC connectivity and configure DSNs on several Linux distributions: Debian-based systems, like Ubuntu, and Red Hat Linux platforms, like Red Hat Enterprise Linux (RHEL), CentOS, and Fedora.

Minimum Linux Versions

Here are the minimum supported versions for Red Hat-based and Debian-based systems:

OSMin. Version
Ubuntu11.04
Debian7
RHEL6.9
CentOS6.9
Fedora13
SUSE12.1

Installing the Driver Dependencies

Run the following commands as root or with sudo to install the necessary dependencies:

  • Debian/Ubuntu:
    apt-get install libc6 libstdc++6 zlib1g libgcc1
  • RHEL/CentOS/Fedora:
    yum install glibc libstdc++ zlib libgcc

Here are the corresponding libraries required by the driver:

Debian/Ubuntu PackageRHEL/CentOS/Fedora PackageFile
libc6glibclinux-vdso.1
libc6glibclibm.so.6
libc6glibclibrt.so.1
libc6glibclibdl.so.2
libc6glibclibpthread.so.0
libc6glibclibc.so.6
libc6glibcld-linux-x86-64.so.2
libstdc++6libstdc++libstdc++.so.6
zlib1gzliblibz.so.1
libgcc1libgcclibgcc_s.so.1

Installing the Driver

You can use standard package management systems to install the driver.

On Debian-based systems, like Ubuntu, run the following command with root or sudo:

dpkg -i /path/to/driver/setup/DominoODBCDriverforUnix.deb 

On systems that support the RPM package format, run the following command with root or sudo:

rpm -ivh /path/to/driver/DominoODBCDriverforUnix.rpm 

Licensing the Driver

Run the following commands to license the driver. To activate a trial, omit the <key> input.

cd /opt/cdata/cdata-odbc-driver-for-domino/bin/
sudo ./install-license.sh <key>

Connecting through the Driver Manager

The driver manager loads the driver and passes function calls from the application to the driver. You need to register the driver with the driver manager and you define DSNs in the driver manager's configuration files.

The driver installation registers the driver with the unixODBC driver manager and creates a system DSN. The unixODBC driver manager can be used from Python and from many other applications. Your application may embed another driver manager.

Creating the DSN

See Using unixODBC to install unixODBC and configure DSNs. See Using the DataDirect Driver Manager to create a DSN to connect to OBIEE, Informatica, and SAS.

Before You Connect

The driver requires the Proton component to be installed. Normally, Proton is distributed as part of the AppDev pack. See the HCL documentation for instructions on acquiring and installing Proton or the AppDev pack.

The driver can authenticate to Proton using either anonymous access, or by providing a client certificate. Both of these options require specific configuration within Domino.

The following two sections describe the preliminary configuration necessary to make a connection. Refer to the section that corresponds to your intended authentication method.

Configuring Client Certificate Authentication

In client certificate authentication, the driver connects as a dedicated user account. This user must be granted designer or greater access to any database you connect to.

In addition, the user must have an Internet Certificate in order for the driver to use it. You can have Proton create this certificate by running the following command at the server console. APPUSER is the name of the user account you are configuring for access with the driver, while ADMINISTRATOR is the name of the user that will receive the certificate.

load proton --setupclient "APPUSER" --sendto "ADMINISTRATOR"

The new certificate is avialable from the ADMINISTRATOR mail inbox in Notes. Note that the certificate may be sent as two separate files, a client certificate (clientcert) and a key (clientkey). The two files must be combined by copying and pasting the text from the key file onto the end of the certificate file.

Configuring Anonymous Authentication

In anonymous access, the driver connects using a generic user account called Anonymous. Every database you connect to must have these two permissions configured:

  • The Anonymous user must be granted designer or greater access to the database.
  • The database must have the Maximum Internet name and password option set to designer or greater access. This setting is found under the Advanced tab of the database Access Control List options.

Connecting to Domino

Set the following to connect:

  • Server: The name or IP address of the server running Domino with the Proton service.
  • Port: The port number that the Proton service is listening on.
  • Database: The name of the database file, including the .nsf extension.
  • SSLServerCert: Set this to the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected. Alternatively, set "*" to accept all certificates.

Authenticating to Domino

The driver can authenticate to Proton using a client certificate, or via anonymous access.

Client Certificate Authentication

Set the following to authenticate with an certificate authentication:
  • AuthScheme: Set this to SSLCertificate.
  • SSLClientCertType: This must match the format of the certificate file. Typically this will be either PEMKEY_FILE for .pem certificates or PFXFILE for .pfx certificates.
  • SSLClientCert: The path to the certificate file.

Anonymous Authentication

To use anonymous authentication, set AuthScheme to Anonymous.

Set the Driver Encoding

The ODBC drivers need to specify which encoding to use with the ODBC Driver Manager. By default, the CData ODBC Drivers for Unix are configured to use UTF-16 which is compatible with unixODBC, but other Driver Managers may require alternative encoding.

Alternatively, if you are using the ODBC driver from an application that uses the ANSI ODBC API it may be necessary to set the ANSI code page. For example, to import Japanese characters in an ANSI application, you can specify the code page in the config file '/opt/cdata/cdata-odbc-driver-for-domino/lib/cdata.odbc.domino.ini':

[Driver]
AnsiCodePage = 932

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8509