Manage TimeCamp Data in DBArtisan as a JDBC Source

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use wizards in DBArtisan to create a JDBC data source for TimeCamp.

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

Integrate TimeCamp Data into DBArtisan Projects

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

    TimeCamp API Profile Settings

    TimeCamp uses token-based authentication. To obtain an API Token:

    1. Log in to your TimeCamp account at https://app.timecamp.com
    2. Click your profile avatar in the top-right corner
    3. Select Profile Settings
    4. Copy the API token shown at the bottom of the page

    After obtaining your API Token, set the following connection properties:

    • AuthScheme: Set this to APIKey.

    Set the following in the ProfileSettings connection property:

    • APIKey: Set this to your TimeCamp API token.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the TimeCamp 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\TimeCamp.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_token';
  6. Finish the wizard to connect to TimeCamp data. TimeCamp entities are displayed in the Datasource Explorer.

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

The results of a query. (Salesforce is shown.)

Ready to get started?

Connect to live data from TimeCamp with the API Driver

Connect to TimeCamp