Excel Add-In for Oracle Eloqua

Build 24.0.9060

Establishing a Connection

Configure a Connection Profile

From the CData ribbon, click Get Data and select From Oracle Eloqua connection/s to launch the CData Query window. To setup a new connection, you will have to click the New Oracle Eloqua Connection button. Here you can set the connection settings, test the connection, and save the connection profile.

Authenticating to Oracle Eloqua

Oracle Eloqua supports both Basic (login) and OAuth authschemes.

Basic Authentication

Basic authentication runs over HTTP via SSL to enable users to connect via login.

To use Basic authentication, specify these properties:

  • AuthScheme: Basic.
  • Company: The company's unique identifier.
  • User: Your login account name.
  • Password: Your login password.

OAuth Authentication

To enable OAuth authentication from all OAuth flows, you must set AuthScheme to OAuth and create a custom OAuth application.

The following subsections describe how to authenticate to Oracle Eloqua from the three most common authentication flows. For information about how to create a custom OAuth application, see Creating a Custom OAuth Application. For a complete list of connection string properties available in Oracle Eloqua, see Connection.

Desktop Applications

To authenticate with the credentials for a custom OAuth application, you must get and refresh the OAuth access token. After you do that, you are ready to connect.

Get and refresh the OAuth access token:

  • 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 add-in opens Oracle Eloqua's OAuth endpoint in your default browser. Log in and grant permissions to the application.

When the access token expires, the add-in refreshes it automatically.

Automatic refresh of the OAuth access token:

To have the add-in automatically refresh the OAuth access token:

  1. Before connecting to data for the first time, set these connection parameters:
    • InitiateOAuth: REFRESH.
    • OAuthClientId: The client Id in your application settings.
    • OAuthClientSecret: The client secret in your application settings.
    • OAuthAccessToken: The access token returned by GetOAuthAccessToken.
    • OAuthSettingsLocation: The path where you want the add-in to save the OAuth values, which persist across connections.
  2. On subsequent data connections, set:
    • InitiateOAuth
    • OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAuth access token is the OAuth refresh token.

  1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
  2. Set these connection properties:

    • OAuthClientId: The Client Id in your application settings.
    • OAuthClientSecret: The Client Secret in your application settings.

  3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
  4. After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Using PASSWORD Grant

If you set OAuthGrantType to password, it may trigger an OAuth flow that passes credentials. In this case, there will be no browser window to authorize.

To ensure that you are authenticated properly, set these connection properties:

  • User: The user name.
  • Company: The company's unique identifier.
  • OAuthClientId The Client ID returned in your custom OAuth application settings. (See Creating a Custom OAuth Application.)
  • OAuthClientSecret: The Client Secret returned in your custom OAuth application settings (See Creating a Custom OAuth Application.)
  • OAuthGrantType: password.
  • InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.

Connection Properties

The Connection properties describe the various options that can be used to establish a connection.

Managing Connections

After successfully authenticating to Oracle Eloqua you will be able to customize the data you are importing. To learn more about this, see Managing Connections.

See Also

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060