Skip to end of metadata
Go to start of metadata

Introduction

Jitterbit provides commonly-used ODBC and JDBC drivers, either bundled with the software, or pulled in from the drivers installed with the operating system. However, you may need to install a driver for a specific database. This page describes the generic steps for installing drivers on a Private Agent.

NOTE: Jitterbit currently supports 32-bit drivers. The use of ODBC drivers is supported only on Private Agents.

General Information

NOTE: Installation of additional drivers can be done only on Private Agents.

Prior to using a newly installed ODBC or JDBC driver within Harmony Studio, it is the responsibility of the user to ensure that the driver has been successfully installed on the Private Agent. Please consult the specific documentation for the proprietary driver as to how this can be achieved. Please ensure connectivity between the driver and the underlying data source by testing within the ODBC or JDBC administration application.

After a new ODBC or JDBC driver has been successfully installed on a Private Agent, you are able to select the new driver from the dropdown list of available drivers in Harmony Studio and are then able to create connections to the underlying data source using the driver. For example, a proprietary ODBC or JDBC driver may be installed on a server that can be used to interact with a SAGE 50 UK 2015 ERP system.

When using a driver that is not available by default, it may be necessary to create a connection string manually as Jitterbit may not be able to anticipate all of the necessary underlying settings and their values. An attempt should be made to supply values for the driver using the available fields. If it is discovered that testing the connection is unsuccessful, then it may be necessary to create a manual connection string that is specific to the newly installed driver. Please consult the driver-specific documentation as to how the connection string should be structured. When completed, test the connection for connectivity.

Driver Installation Instructions

  1. Obtain the JAR file of the driver. In many cases, these are available for download from the manufacturer of the driver.

    EXAMPLE: At https://www.microsoft.com/en-us/download, search for "SQL Server JDBC Driver." Go to the page for the latest version and download the executable file 1033\sqljdbc_3.0.1301.101_enu.exeExtract the files and locate the sqljdbc4.jar file.
  2. Copy the JAR file to the following recommended folder path: <JITTERBIT_HOME>/tomcat/drivers/lib/, replacing <JITTERBIT_HOME> with your Private Agent root directory. Your Private Agent root directory is usually in one of these default locations: 

    • Windows (Harmony):C:\Program Files (x86)\Jitterbit Agent\
    • Windows (v5.x):C:\Program Files (x86)\Jitterbit Integration Server\
    • Linux:/opt/jitterbit
    CAUTION: You may also have JAR files located in <JITTERBIT_HOME>/tomcat/webapps/axis/WEB-INF/lib/; however, this directory may be overwritten if you upgrade your Private Agent. Instead, we recommend placing any drivers you install in <JITTERBIT_HOME>/tomcat/drivers/lib/.
  3. Locate the JdbcDrivers.conf file in the Private Agent root directory. Open the file in administrator mode and add a new <Driver> element in the <Drivers> section with this information, and then save the file:

    ElementDescription
    <Name>

    The name of the driver. Must be a unique name. This name will show up in the driver selection UI. Changing the name will break existing transformations that use this driver; to fix it, all DB sources and targets using this driver must be updated by re-selecting the driver, using the new name, and then re-deploying.

    <Class>The full name of the driver class. See the documentation for the particular driver.
    <Subprotocol>

    The subprotocol to use when constructing the URL for connecting to a database using the driver. The URL is of the form jdbc:subprotocol://.... For example, a PostgreSQL driver might define the subprotocol postgresql. See the driver documentation for details.

    <BeginQuote>Define your own "begin-quote" character (rarely required).
    <EndQuote>Define your own "end-quote" character (rarely required).

    You can find examples in the JdbcDrivers.conf file. For example, the SQL Server JDBC Driver uses this information:

    <Driver>
    <Name>SQL Server</Name>
    <Class>com.microsoft.sqlserver.jdbc.SQLServerDriver</Class>
    <Subprotocol>sqlserver</Subprotocol>
    </Driver>
  4. 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

  5. You should now see your newly installed driver within the list of available drivers in Harmony Studio:

Database-Specific Information

For further reference, see Cloud Studio Database or Design Studio Database.

On This Page

Last updated:  Apr 19, 2019