Visualize Oracle Eloqua Reporting 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 Oracle Eloqua Reporting 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 Oracle Eloqua Reporting 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 Oracle Eloqua Reporting OData services:

Connect to Oracle Eloqua Reporting

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

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

   Oracle Eloqua Reporting supports the following authentication methods:

   • Basic authentication (User and Password)
   • OAuth 2.0 code grant flow
   • OAuth 2.0 password grant flow

   Basic Authentication (User and Password)

   To perform authentication with a user and password, specify these properties:

   • AuthScheme: Basic.
   • Company: The company name associated with your Oracle Eloqua Reporting account.
   • User: Your login account name.
   • Password: Your login password.

   OAuth Authentication (Code Grant Flow)

   To authenticate with the OAuth code grant flow, you must set AuthScheme to OAuth and create a custom OAuth application. For information about how to create a custom OAuth application, see the Help documentation.

   Then set the following properties:

   • InitiateOAuth: GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
   • OAuthClientId: The client Id assigned when you registered your application.
   • OAuthClientSecret: The client secret that was assigned when you registered your application.
   • CallbackURL: The redirect URI that was defined when you registered your application.

   When you connect, the driver opens Oracle Eloqua Reporting's OAuth endpoint in your default browser. Log in and grant permissions to the application. When the access token expires, the driver refreshes it automatically.

   OAuth Authentication (Password Grant Flow)

   With the OAuth password grant flow, you can use your OAuth application's credentials alongside your user credentials to authenticate without the need to grant permission manually via a browser prompt. You must create an OAuth app (see the Help documentation) to use this authentication method.

   Set the following properties:

   • AuthScheme: OAuthPassword
   • Company: The company's unique identifier.
   • User: Your login account name.
   • Password: Your login password.
   • OAuthClientId: The client Id assigned when you registered your custom OAuth application.
   • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.
   
4. After configuring the connection, click Save & Test to confirm a successful connection.

Configure API Server Users

Next, create a user to access your Oracle Eloqua Reporting 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 Oracle Eloqua Reporting

Having created a user, you are ready to create API endpoints for the Oracle Eloqua Reporting 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 Oracle Eloqua Reporting 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 Oracle Eloqua Reporting 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 .
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 in the Numbers section and 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.