Visualize Cvent Data in TIBCO Spotfire through OData

OData is a major protocol enabling real-time communication among cloud-based, mobile, and other online applications. The CData API Server provides Cvent data to OData consumers like TIBCO Spotfire. This article shows how to use the API Server and Spotfire's built-in support for OData to access Cvent data in real time.

Set Up the API Server

If you have not already done so, download the CData API Server. Once you have installed the API Server, follow the steps below to begin producing secure Cvent OData services:

Connect to Cvent

To work with Cvent data from TIBCO Spotfire, we start by creating and configuring a Cvent connection. Follow the steps below to configure the API Server to connect to Cvent data:

1. First, navigate to the Connections page.
2. Click Add Connection and then search for and select the Cvent connection.
3. Enter the necessary authentication properties to connect to Cvent.

   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.
   
4. After configuring the connection, click Save & Test to confirm a successful connection.

Configure API Server Users

Next, create a user to access your Cvent data through the API Server. You can add and configure users on the Users page. Follow the steps below to configure and create a user:

1. On the Users page, click Add User to open the Add User dialog.
2. Next, set the Role, Username, and Privileges properties and then click Add User.
3. An Authtoken is then generated for the user. You can find the Authtoken and other information for each user on the Users page:

Creating API Endpoints for Cvent

Having created a user, you are ready to create API endpoints for the Cvent tables:

1. First, navigate to the API page and then click Add Table .
2. Select the connection you wish to access and click Next.
3. With the connection selected, create endpoints by selecting each table and then clicking Confirm.

Gather the OData Url

Having configured a connection to Cvent data, created a user, and added resources to the API Server, you now have an easily accessible REST API based on the OData protocol for those resources. From the API page in API Server, you can view and copy the API Endpoints for the API:

Create Data Visualizations on External Cvent Data

1. Open Spotfire and click Add Data Tables -> OData.
2. In the OData Connection dialog, enter the following information:
   • Service URL: Enter the API Server's OData endpoint. For example:

     http://localhost:8080/api.rsc

   • Authentication Method: Select Username and Password.
   • Username: Enter the username of an API Server user. You can create API users on the Security tab of the administration console.
   • Password: Enter the authtoken of an API Server user.
   
3. Select the tables and columns you want to add to the dashboard. This example uses Events.
4. If you want to work with the live data, click the Keep Data Table External option. This option enables your dashboards to reflect changes to the data in real time.

   If you want to load the data into memory and process the data locally, click the Import Data Table option. This option is better for offline use or if a slow network connection is making your dashboard less interactive.

5. After adding tables, the Recommended Visualizations wizard is displayed. When you select a table, Spotfire uses the column data types to detect number, time, and category columns. This example uses Title in the Numbers section and Id in the Categories section.

After adding several visualizations in the Recommended Visualizations wizard, you can make other modifications to the dashboard. For example, you can apply a filter: After clicking the Filter button, the available filters for each query are displayed in the Filters pane.