Consume Oracle Eloqua Reporting OData Feeds in SAP Lumira
You can use the CData API Server to create data visualizations based on Oracle Eloqua Reporting data in SAP Lumira. The API Server enables connectivity to live data: dashboards and reports can be refreshed on demand. This article shows how to create a chart that is always up to date.
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 SAP Lumira, 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:
- First, navigate to the Connections page.
-
Click Add Connection and then search for and select the Oracle Eloqua Reporting connection.
-
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.
- 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:
- On the Users page, click Add User to open the Add User dialog.
-
Next, set the Role, Username, and Privileges properties and then click Add User.
-
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:
-
First, navigate to the API page and then click
Add Table
.
-
Select the connection you wish to access and click Next.
-
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:
Connect to Oracle Eloqua Reporting from SAP Lumira
Follow the steps below to retrieve Oracle Eloqua Reporting data into SAP Lumira. You can execute an SQL query or use the UI.
- In SAP Lumira, click File -> New -> Query with SQL. The Add New Dataset dialog is displayed.
- Expand the Generic section and click the Generic OData 2.0 Connector option.
-
In the Service Root URI box, enter the OData endpoint of the API Server. This URL will resemble the following:
https://your-server:8080/api.rsc
-
In the User Name and Password boxes, enter the username and authtoken of an API user. These credentials will be used in HTTP Basic authentication.
Select entities in the tree or enter an SQL query. This article imports Oracle Eloqua Reporting entities.
-
When you click Connect, SAP Lumira will generate the corresponding OData request and load the results into memory. You can then use any of the data processing tools available in SAP Lumira, such as filters, aggregates, and summary functions.
Create Data Visualizations
After you have imported the data, you can create data visualizations in the Visualize room. Follow the steps below to create a basic chart.
In the Measures and Dimensions pane, drag measures and dimensions onto the x-axis and y-axis fields in the Visualization Tools pane. SAP Lumira automatically detects dimensions and measures from the metadata service of the API Server.
By default, the SUM function is applied to all measures. Click the gear icon next to a measure to change the default summary.
- In the Visualization Tools pane, select the chart type.
- In the Chart Canvas pane, apply filters, sort by measures, add rankings, and update the chart with the current Oracle Eloqua Reporting data.