Design BIRT Reports on Cvent Data

The CData JDBC Driver for Cvent integrates connectivity to Cvent APIs into your data-driven Java applications. You can use the CData JDBC Driver for Cvent with the BIRT (Business Intelligence Reporting Tools) platform to create BIRT reports that reflect changes to your data in real time.

1. If you have not already done so, install the BIRT Framework plugin and the Database Development plugin for Eclipse.
2. Click File -> New -> Report. The Report Design perspective is opened.
3. In the Data Explorer, right-click Data Sources and click New Data Source.
4. Select the Create from a Data Source Type in the Following List option and select JDBC Data Source.
5. Click Manage Drivers and add the driver JAR, located in the lib subfolder of the installation folder.
6. In the Database URL box, enter the JDBC URL containing the connection string.

   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.

   When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

   A typical JDBC URL is below:

   jdbc:cvent:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;InitiateOAuth=GETANDREFRESH
7. Right-click the Data Sets folder and select the JDBC data source for Cvent.
8. In the resulting dialog, build the SELECT query to be used to retrieve the data for the report. This article uses the following query: SELECT Id, Title FROM Events WHERE Virtual = 'true'
9. In the Palette, drag a Chart onto the editor. The chart wizard is displayed.
10. After selecting the chart type, drag columns onto the chart fields on the Select Data tab.
11. Click Run -> View Report -> In Web Viewer to view the report.

Your BIRT reports can now pick up any updates to Cvent data.

To publish the report to your application server, add the driver JAR to the BIRT Viewer's classpath. For more information, see the CData KB for guides to deploying the JDBC Driver on Java application servers.