VOOZH about

URL: https://www.cdata.com/kb/tech/greenhouse-jdbc-jboss.rst

⇱ Connect to Greenhouse Data from a Connection Pool in JBoss

Connect to Greenhouse Data from a Connection Pool in JBoss

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Integrate Greenhouse data into Java servlets: Use the Management Console in JBoss to install the Greenhouse JDBC Driver.

CData JDBC drivers can be configured in JBoss by following the standard procedure for connection pooling. This article details how to access Greenhouse data from a connection pool in JBoss applications. This article details how to use the JBoss Management Interface to configure the CData JDBC Driver for Greenhouse. You will then access Greenhouse data from a connection pool.

Create a JDBC Data Source for Greenhouse from the Management Console

Follow the steps below to add the driver JAR and define required connection properties.

  1. In the Runtime menu, select the Domain or Server menu, depending on whether you are deploying to a managed domain or to a stand-alone server, and click "Manage deployments" to open the Deployments page.
  2. Click Add. In the resulting wizard, add the JAR file and license for the driver, located in the lib subfolder of the installation directory. Finish the wizard with the defaults, select the driver, and click Enable. 👁 The deployed JAR. (Salesforce is shown.)
  3. In the Configuration menu, click Subsystems -> Connector -> Datasources. This opens the JDBC Datasources page.
  4. Click Add and, in the resulting wizard, enter a name for the driver and the JNDI name. For example: 
    java:jboss/root/jdbc/Greenhouse
  5. Select the driver that you added above.

  6. Enter the JDBC URL and the username and password. The syntax of the JDBC URL is jdbc:greenhouse: followed by a semicolon-separated list of connection properties.

    You need an API key to connect to Greenhouse. To create an API key, follow the steps below:

    1. Click the Configure icon in the navigation bar and locate Dev Center on the left.
    2. Select API Credential Management.
    3. Click Create New API Key.
      • Set "API Type" to Harvest.
      • Set "Partner" to custom.
      • Optionally, provide a description.
    4. Proceed to Manage permissions and select the appropriate permissions based on the resources you want to access through the driver.
    5. Copy the created key and set APIKey to that value.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the Greenhouse JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

    java -jar cdata.jdbc.greenhouse.jar

    Fill in the connection properties and copy the connection string to the clipboard.

    👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

    A typical connection string is below:

    jdbc:greenhouse:APIKey=YourAPIKey;
  7. Test the connection and finish the wizard. Select the Greenhouse data source and click Enable.
👁 The enabled data source. (Salesforce is shown.)

More JBoss Integration

The steps above show how to configure the driver in a simple connection pooling scenario. For more information, refer to the Data Source Management chapter in the JBoss EAP documentation.