Manage Superchat Data in DBArtisan as a JDBC Source

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

Integrate Superchat Data into DBArtisan Projects

Follow the steps below to register Superchat 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.

   Superchat uses API Key authentication. The API key is passed via the X-API-KEY request header on every call.

   Authentication

   To authenticate to Superchat, you need to obtain your API key from the Superchat workspace settings.

   Using API Key Authentication

   You can obtain your API key from Settings > Integrations > API Key in your Superchat workspace.

   After setting the following connection properties, you are ready to connect:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Superchat API key.

   Example connection string:

   Profile=C:\profiles\Superchat.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
   

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Superchat 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\Superchat.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

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

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