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:
| OS | Min. Version |
| Ubuntu | 11.04 |
| Debian | 7 |
| RHEL | 6.9 |
| CentOS | 6.9 |
| Fedora | 13 |
| SUSE | 12.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 Package | RHEL/CentOS/Fedora Package | File |
| libc6 | glibc | linux-vdso.1 |
| libc6 | glibc | libm.so.6 |
| libc6 | glibc | librt.so.1 |
| libc6 | glibc | libdl.so.2 |
| libc6 | glibc | libpthread.so.0 |
| libc6 | glibc | libc.so.6 |
| libc6 | glibc | ld-linux-x86-64.so.2 |
| libstdc++6 | libstdc++ | libstdc++.so.6 |
| zlib1g | zlib | libz.so.1 |
| libgcc1 | libgcc | libgcc_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/BullhornCRMODBCDriverforUnix.deb
On systems that support the RPM package format, run the following command with root or sudo:
rpm -ivh /path/to/driver/BullhornCRMODBCDriverforUnix.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-bullhorncrm/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.
Connecting to Bullhorn CRM
Begin by providing your Bullhorn CRM account credentials. Set DataCenterCode to the data center code that responds to your data center. Refer to the list here.
If you are uncertain about your data center code, codes like CLS2, CLS21, etc. are cluster IDs that are contained in a user's browser URL (address bar) once they are logged in.
Example: https://cls21.bullhornstaffing.com/BullhornSTAFFING/MainFrame.jsp?#no-ba... indicates that the logged in user is on CLS21.
Note: If you specify callback URL value that contains "/" character at the end, e.g., http://localhost:33333/ you must specify exactly the same value. It must match the callback URL you specify in your application settings.
Adding or removing any character of this parameter results in an error.
Authenticating to Bullhorn CRM (OAuth)
Bullhorn CRM uses the OAuth 2.0 authentication standard.
In all scenarios, to authenticate using OAuth, you must create and configure a custom OAuth application. See Creating a Custom OAuth App for more information.
Desktop Applications
Follow the steps below to authenticate with the credentials for a custom OAuth application.
Scenario 1: Verifier Code
Making any changes to your OAuth application (such as the CallbackURL) requires reaching out to Bullhorn CRM directly, which can be a time-consuming process. So, we highly recommended that you instead use an OAuthVerifier to connect. To obtain a verifier, you also need an OAuth Authorization URL.
Retrieving an OAuth Verifier Code
Construct your authorization URL as follows:
https://<authurl for your data center>/oauth/authorize?client_id=<your OAuth client id>&response_type=code
For example, if you had data center "CLS5", the authentication URL is https://auth.bullhornstaffing.com/oauth/authorize?client_id=your_client_id&response_type=code.
Please refer to the list here to determine the authentication URL for your data center.
Next, retrieve the OAuth verifier code:
- Open your authorization URL in a browser. Log in and grant permissions to the driver. You are then redirected to the callback URL, which contains the verifier code.
- Save the value of the verifier code.
Get and Refresh the OAuth Access Token
After setting the following, you are ready to connect:
- OAuthVerifier: Set this to the OAuth Verifier code obtained previously.
- DataCenterCode: Set this to the respective data center your account is connected with. Find the list of the data centers here. For example, CLS33.
- OAuthClientId: Set this to the client Id assigned when you registered your application.
- OAuthClientSecret: Set this to the client secret assigned when you registered your application.
When you connect the driver opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. Scenario 2: Custom CallbackURL
You also have the option of requesting a custom callback URL (for example, http://localhost:33333) from Bullhorn CRM. If you have been provided with a custom CallbackURL, you can set the following to connect to data:
- CallbackURL: Set this to the custom callback URL provided by Bullhorn CRM.
- DataCenterCode: Set this to the respective data center your account is connected with. Find the list of the data centers here. For example, CLS33.
- OAuthClientId: Set this to the client Id assigned when you registered your application.
- OAuthClientSecret: Set this to the client secret assigned when you registered your application.
Headless Machines
To configure the driver to use OAuth with a user account on a headless machine, you need to authenticate on another device that has an internet browser.- Choose one of these two options:
- Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
- Option 2: Install the driver on another machine and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings" below.
- Then configure the driver to automatically refresh the access token from the headless machine.
Option 1: Obtain and Exchange a Verifier Code
Set the following properties on the headless machine:
- DataCenterCode: Set this to the data center code which responds to your data center. Refer to the list here.
- InitiateOAuth: Set this to OFF.
- OAuthClientId: Set this to the client Id provided by Bullhorn CRM.
- OAuthClientSecret: Set this to the client secret provided by Bullhorn CRM.
You can then follow the steps below to authenticate from another machine and obtain the OAuthVerifier connection property.
- Call the GetOAuthAuthorizationURL stored procedure with the CallbackURL input parameter set to the exact Redirect URI.
- Open the returned URL in a browser. Log in and grant permissions to the driver. You are then redirected to the callback URL, which contains the verifier code.
- Save the value of the verifier code. You will set this in the OAuthVerifier connection property.
- Save the REST URL. You will set this in the RestUrl property.
On the headless machine, set the following connection properties to obtain the OAuth authentication values:
- OAuthClientId: Set this to the consumer key provided by Bullhorn CRM.
- OAuthClientSecret: Set this to the consumer secret provided by Bullhorn CRM.
- DataCenterCode: Set this to the data center code which responds to your data center.
- RestUrl: Set this to the URL returned by the GetOAuthAccessToken stored procedure.
- OAuthVerifier: Set this to the verifier code.
- OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified file.
- InitiateOAuth: Set this to REFRESH.
After the OAuth settings file is generated, set the following properties to connect to data:
- OAuthClientId: Set this to the consumer key provided by Bullhorn CRM.
- OAuthClientSecret: Set this to the consumer secret provided by Bullhorn CRM.
- DataCenterCode: Set this to the data center code which responds to your data center.
- RestUrl: Set this to the URL returned by the GetOAuthAccessToken stored procedure.
- OAuthSettingsLocation: Set this to the file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the provider to enable the automatic refreshing of the access token.
- InitiateOAuth: Set this to REFRESH.
Option 2: Transfer OAuth Settings
Follow the steps below to install the driver on another machine, authenticate, and then transfer the resulting OAuth values.
On a second machine, install the driver and connect with the following properties set:
- DataCenterCode: Set this to the data center code which responds to your data center.
- RestUrl: Set this to the URL returned by the GetOAuthAccessToken stored procedure.
- OAuthSettingsLocation: Set this to a writable text file.
- OAuthClientId: Set this to the client Id assigned when you registered your application.
- OAuthClientSecret: Set this to the client secret assigned when you registered your application.
- CallbackURL: Set this to the Redirect URI. Note: A different callback url must be explicitly requested from the Bullhorn CRM staff. For example, http://localhost:33333/.
Test the connection to authenticate. The resulting authentication values are written, encrypted, to the path specified by OAuthSettingsLocation. After you have successfully tested the connection, copy the OAuth settings file to your headless machine. On the headless machine, set the following connection properties to connect to data:
- RestUrl: Set this to the URL returned by the GetOAuthAccessToken stored procedure.
- DataCenterCode: Set this to the data center code which responds to your data center.
- InitiateOAuth: Set this to REFRESH.
- OAuthClientId: Set this to the consumer key provided by Bullhorn CRM.
- OAuthClientSecret: Set this to the consumer secret provided by Bullhorn CRM.
- OAuthSettingsLocation: Set this to the path to your OAuth settings file. Make sure this file gives read and write permissions to the driver to enable the automatic refreshing of the access token.
Refreshing OAuth Values
The driver can refresh the temporary OAuth access tokens obtained during the browser-based OAuth authentication exchange. By default, the driver saves the encrypted tokens in the odbc.ini file corresponding to the DSN. Access to this odbc.ini file can be restricted in the case of System DSNs.
To enable the automatic token exchange, you can give the driver write access to the system odbc.ini.
Installing Dependencies for OAuth Authentication
The OAuth authentication standard requires the authenticating user to interact with Bullhorn CRM, using a web-browser. If the first OAuth interaction is to be done on the same machine the driver is installed on, for example, a desktop application, the driver needs access to the xdg-open program, which opens the default browser.
To satisfy this dependency, install the corresponding package with your package manager:
| Debian/Ubuntu Package | RHEL/CentOS/Fedora Package | File |
| xdg-utils | xdg-utils | xdg-open |
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-bullhorncrm/lib/cdata.odbc.bullhorncrm.ini':
[Driver]
AnsiCodePage = 932