How to Connect DBeaver to Cvent via a JDBC Driver

The CData JDBC Driver for Cvent implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to Cvent data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for Cvent Data

Follow the steps below to load the driver JAR in DBeaver.

1. Open the DBeaver application and, in the "Database" menu, select the "Driver Manager" option. Click "New" to open the "Create new driver" form.
2. In the Settings tab:
   • Set Driver Name to a user-friendly name for the driver (e.g. CData JDBC Driver for Cvent).
   • Set Class Name to the class name for the JDBC driver: cdata.jdbc.cvent.CventDriver.
   • Set URL Template to jdbc:cvent:.
3. In the Libraries tab, click "Add File," navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\) and select the JAR file (cdata.jdbc.Cvent.jar).

Create a Connection to Cvent Data

Follow the steps below to add credentials and other required connection properties.

1. In the "Database" menu, click "New Database Connection."
2. In the "Connect to a database" wizard that results, select the driver you just created (e.g. CData JDBC Driver for Cvent) and click "Next >."
3. On the Main tab of the configuration wizard, set the JDBC URL, using the required connection properties:

   Before you can authenticate to Cvent, you must create a workspace and an OAuth application.

   Creating a Workspace

   To create a workspace:

   1. Sign into Cvent and navigate to App Switcher (the blue button in the upper right corner of the page) >> Admin.
   2. In the Admin menu, navigate to Integrations >> REST API.
   3. A new tab launches for Developer Management. Click on Manage API Access in the new tab.
   4. Create a Workspace and name it. Select the scopes you would like your developers to have access to. Scopes control what data domains the developer can access.
      • Choose All to allow developers to choose any scope, and any future scopes added to the REST API.
      • Choose Custom to limit the scopes developers can choose for their OAuth apps to selected scopes. To access all tables exposed by the driver, you need to set the following scopes:

        event/attendees:read	event/attendees:write	event/contacts:read
        event/contacts:write	event/custom-fields:read	event/custom-fields:write
        event/events:read	event/events:write	event/sessions:delete
        event/sessions:read	event/sessions:write	event/speakers:delete
        event/speakers:read	event/speakers:write	budget/budget-items:read
        budget/budget-items:write	exhibitor/exhibitors:read	exhibitor/exhibitors:write
        survey/surveys:read	survey/surveys:write

   Creating an OAuth Application

   After you have set up a Workspace and invited them, developers can sign up and create a custom OAuth app. See the Creating a Custom OAuth Application section in the Help documentation for more information.

   Connecting to Cvent

   After creating an OAuth application, set the following connection properties to connect to Cvent:

   • InitiateOAuth: GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
   • OAuthClientId: The Client ID associated with the OAuth application. You can find this on the Applications page in the Cvent Developer Portal.
   • OAuthClientSecret: The Client secret associated with the OAuth application. You can find this on the Applications page in the Cvent Developer Portal.

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.cvent.jar

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

   Below is a typical connection string:

   jdbc:cvent:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;InitiateOAuth=GETANDREFRESH
4. Click "Test Connection ..." to ensure you have configured the connection properly.
5. Click "Finish."

Query Cvent Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click View Table. The data is available on the Data tab.

More Information & Free Trial