Manage Teamgate Data in DBArtisan as a JDBC Source

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

Integrate Teamgate Data into DBArtisan Projects

Follow the steps below to register Teamgate 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.
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 Teamgate Profile on disk (e.g. C:\profiles\Teamgate.apip). Next, set the ProfileSettings connection property to the connection string for Teamgate (see below).

   Teamgate API Profile Settings

   To obtain your API Key, log into Teamgate and navigate to Settings > Additional Features > External Apps > New API Key Request. For your Auth Token, go to My Profile > Integrations > API Access > Auth Token.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Teamgate 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.

   

   Below is a typical connection string:

   jdbc:api:Profile=C:\profiles\Teamgate.apip;ProfileSettings='APIKey=your_api_key;AuthToken=your_auth_token';

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

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