Manage Intercom Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Intercom seamlessly integrates Intercom data into database management tools like DBArtisan by enabling you to access Intercom data as a database. This article shows how to create a JDBC source for Intercom in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Intercom Data into DBArtisan Projects

Follow the steps below to register Intercom data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory. 👁 The JDBC driver definition in the Register Datasource wizard. (Salesforce is shown.)
   
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   Start by setting the Profile connection property to the location of the Intercom Profile on disk (e.g. C:\profiles\Intercom.apip). Next, set the ProfileSettings connection property to the connection string for Intercom (see below).

   Intercom API Profile Settings

   In the Intercom Developer Hub, go to Configure > Authentication and select your workspace to obtain an Access Token. For OAuth, register an app and retrieve the Client ID and Secret from the app's Basic Information page.

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.api.jar
   

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

   👁 Required JDBC connection properties in the Register Datasource wizard. (Salesforce is shown.)
   

   Below is a typical connection string:

   jdbc:api:Profile=C:\profiles\Intercom.apip;ProfileSettings='APIKey=your_access_token';

6. Finish the wizard to connect to Intercom data. Intercom entities are displayed in the Datasource Explorer.

You can now work with Intercom data as you work with any other database. See the driver help documentation for more information on the queries supported by the Intercom API.