Configure an Oracle ODBC database target in Jitterbit Design Studio

This page describes how to configure an Oracle database as a source or target within Jitterbit Studio using an ODBC driver. See Database for information on the types of authentication supported for various systems.

Note

You can also connect to an Oracle database using a JDBC driver. The JDBC driver is recommended for additional features, such as manual creation of SQL scripts, that are not available via an ODBC connection.

Install the Oracle client on the Jitterbit private agent

Before you can establish a connection to Oracle via ODBC, you must have the Oracle Client (including the Oracle ODBC driver) installed on your Jitterbit private agent. If you are using multiple private agents within an agent group, the Oracle Client must be installed on all agents in the group. See Agents for more information.

Configure and test the Oracle client

Once you have installed the Oracle Client, configure the TNSNames.ora file to reference the database you are planning to use. This is part of the standard Oracle Client setup procedure. For additional information see Tnsnames.org - Oracle FAQ or refer to the Oracle documentation for the version you are using.

After the Oracle Client is set up on the Jitterbit agent, you should test the server to ensure that Jitterbit has connectivity to the database. One way to do this is to connect to the server via SQL*Plus. If this is successful, the Oracle Client should operate correctly with Jitterbit.

In addition, some versions of the Oracle driver (not the Microsoft Oracle driver) may require one or more of the following environment variables within the operating system to be set. For example:

ORACLE_HOME=/usr/local/oracle/10.2.0
TNS_ADMIN=/usr/local/oracle/10.2.0/network/admin
TWO_TASK=//dbdpmr:1555/pmrd1

On Linux, you may also need to add the Oracle library directory to your path (e.g. LD_LIBRARY_PATH). Add these to the /etc/sysconfig/jitterbit file. Some examples are shown below, but the exact path will depend on your Oracle Client installation.

LD_LIBRARY_PATH=/usr/local/oracle/lib
export ORACLE_HOME=/usr/local/oracle/10.2.0
export TNS_ADMIN=/usr/local/oracle/10.2.0/network/admin
export TWO_TASK=//dbdpmr:1555/pmrd1

Configure the Oracle connection in Jitterbit Studio

Follow the steps below to configure your Oracle connection as a source or target in Jitterbit Studio.

Go to Jitterbit Studio and set up your source or target as normal, choosing Database as the type.
Select your Driver *by clicking the *Select button to display a prompt to select available drivers. In the prompt, make sure the checkbox for ODBC is checked, then select your driver from the list and click OK. If you do not see your driver in the list, see Add your driver to the Jitterbit agent config file below.
Click on Options to expand additional settings.
1. Check the box for Construct connection string manually, as Oracle references the database based on the setting in TNSNames.ora.
2. Enter a manual connection string for your specific Oracle database. For example:
  Oracle in OraHome92
```
Driver={Oracle in OraHome92};Dbq=myTNSServiceName;Uid=myUsername;Pwd=myPassword;
```
  Oracle in OraClient11g_home1
```
DRIVER={Oracle in OraClient11g_home1};SERVER=[server SID];UID=[userid];
PWD=[password];DBQ=[server SID];
```
  Tip
  
  Additional Oracle connection string examples are available at The Connection Strings Reference.

Add your driver to the Jitterbit agent config file

Because of the many variations on the Oracle driver name, you may need to add your driver information to the Jitterbit configuration file.

Once the driver information is added as described below, within Jitterbit Studio while selecting your driver, click the Refresh button and you should see your driver appear in the list of ODBC drivers. If the below steps are not successful, you can also reference Install additional ODBC or JDBC drivers for more detailed instructions regarding driver installation.

Remote agent configuration

If you have remote agent configuration enabled through the Management Console, you can add your driver information as follows. For more information on remote agent configuration see Agents.

Within the Management Console, go to Agents.
Find your agent group and select Jitterbit configuration.
In the Database Drivers tab, click Edit. Find the following example entry for a specific Oracle version, and replace the provided sample information with that for your specific Oracle ODBC driver. When complete, click Save to save the driver information to the Jitterbit agent configuration file.
```
#Oracle in OraClient10g_home2
'Oracle in OraClient10g_home2 Quote Begin'='\"'
'Oracle in OraClient10g_home2 Quote End'='\"'
```

All Jitterbit services must be restarted in order for the new configuration to take effect.

On the machine where each private agent is installed, first stop the services, then restart them.

Windows Linux

From the Start Menu:

Stop Jitterbit Services
Start Jitterbit Services

From the Jitterbit agent installation directory:

> StopServices.bat
> StartServices.bat

From a prompt:

$ sudo jitterbit stop
$ sudo jitterbit start

Manual agent configuration

If you are using manual agent configuration, you can add your driver information under the [Dbdrivers] section of the jitterbit.conf file located on each private agent. for more information see Edit the configuration file (jitterbit.conf).

Open jitterbit.conf in a text editor and scroll to the [DbDrivers] section.
Find the following example entry for a specific Oracle version, and replace the provided sample information with that for your specific Oracle ODBC driver. When complete, save the jitterbit.conf file.
```
#Oracle in OraClient10g_home2
'Oracle in OraClient10g_home2 Quote Begin'='\"'
'Oracle in OraClient10g_home2 Quote End'='\"'
```