Connect to Superchat Data in CloverDX (formerly CloverETL)

The CData JDBC Driver for Superchat enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Superchat as sources. In this article, you will use the JDBC Driver for Superchat to set up a simple transfer into a flat file. The CData JDBC Driver for Superchat enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Superchat as sources. In this article, you will use the JDBC Driver for Superchat to set up a simple transfer into a flat file.

Connect to Superchat as a JDBC Data Source

1. Create the connection to Superchat data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.api.jar file.
3. Enter 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.

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

   A typical JDBC URL is below:

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

Query Superchat Data with the DBInputTable Component

1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
2. In the DB connection property, select the Superchat JDBC data source from the drop-down menu.
3. Enter the SQL query. For example:

   SELECT , FROM Channels WHERE = ''

Write the Output of the Query to a UniversalDataWriter

1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
3. Right-click the DBInputTable and then click Extract Metadata.
4. Connect the output port of the DBInputTable to the UniversalDataWriter.
5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the Channels table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
6. Click Run to write to the file.