Eloqua

1 Authenticating to Oracle Eloqua

1.1 Connect via Login

To connect via Login, set AuthScheme to Basic. The standard method of authentication to Oracle Eloqua is via the login method. The Login method requires you to set Company and to set User, and Password to the credentials you use to log in. This method uses HTTP Basic authentication over SSL.

1.2 Connect via OAuth

To connect via OAuth, set AuthScheme to OAuth.

You can follow the procedure below to obtain the client credentials, the client Id (app Id) and client secret:

1. Log in to Oracle Eloqua.

2. Click Settings -> AppCloud Developer (under Platform Extensions) -> Create New App.

3. Enter a name, icon, and description for the app to be displayed to users when they connect to Oracle Eloqua. The OAuthClientId and OAuthClientSecret will be displayed.

4. If you are creating a desktop application, set the CallbackURL to http://localhost:3000, or another port of your choice.

Eloqua requires that the Callback URL begins with https://. You must specify a port.

1.2.1 Get an OAuth Access Token

After setting the following, you are ready to connect:

• OAuthClientId: Set this to the Client Id in your app settings.

• OAuthClientSecret: Set this to the Client Secret in your app settings.

• CallbackURL: Set this to the Redirect URL in your app settings.

• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.

When you connect the provider opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The provider then completes the OAuth process:

1. Extracts the access token from the callback URL and authenticates requests.

2. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

1.2.2 The Password GrantType

When setting the OAuthGrantType to password, an OAuth flow may be triggered that passes user credentials. In this case, there will be no browser window to authorize. Instead, the following connection properties will need to be set:

• User - Set this to the user name.

• User - Set this to the password.

• Company - Set the company for the user.

• OAuthClientId: Set this to the Client Id in your app settings.

• OAuthClientSecret: Set this to the Client Secret in your app settings.

• OAuthGrantType: Set this to password.

• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.

2 Connection properties

The following are the connection properties for Oracle Eloqua. Not all properties are required. Enter only property values pertaining to your installation. Several properties will be automatically initialized with the appRules defaults.

Property	Description
Authentication
Company	The company of the Eloqua account. This field is used to authenticate the user.
Password	The password of the Eloqua account used to authenticate.
User	The user of the Eloqua account. This field is used to authenticate the user.
Caching
AutoCache	Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
CacheConnection	The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.
CacheLocation	Specifies the path to the cache when caching to a file.
CacheMetadata	This property determines whether or not to cache the table metadata to a file store.
CacheProvider	The name of the provider to be used to cache data.
CacheTolerance	The tolerance for stale data in the cache specified in seconds when using AutoCache .
Offline	Use offline mode to get the data from the cache instead of the live source.
Firewall
FirewallPassword	A password used to authenticate to a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallType	The protocol used by a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
Logging
Logfile	A path to the log file.
MaxLogFileCount	A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.
MaxLogFileSize	A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end.
Verbosity	The verbosity level that determines the amount of detail included in the log file.
Misc
BulkPollingInterval	The time interval between requests that check the availability of the bulk query response. The default value is 200 ms.
BulkQueryTimeout	The timeout in minutes for which the provider will wait for a bulk query response. The default value is 25 minutes.
ConnectionLifeTime	The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
ConnectionString	***
DataRetentionDuration	The length of time (in hours) that bulk data is stored on the server. Valid values are from 1 hour to 2 weeks. The default value is 24 hours.
DisplayColumnName	Specifies the dispaly name for columns. The possible settings are 'internal' and 'statement'.
MapDataCardsCaseSensitiveMatch	Whether or not to use case sensitive match in data card mapping.
MapDataCardsRelationship	Comma-separated list of the relationships between the Custom Object tables and the Entity tables.
MaxRows	Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	These hidden properties are used only in specific use cases.
Pagesize	The maximum number of results to return per page from Eloqua.
PoolIdleTimeout	The allowed idle time for a connection before it is closed.
PoolMaxSize	The maximum connections in the pool.
PoolMinSize	The minimum number of connections in the pool.
PoolWaitTime	The max seconds to wait for an available connection.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Readonly	You can use this property to enforce read-only access to Oracle Eloqua from the provider.
RetryCount	The maximum number of times to retry a Bulk API request that fails due to an HTTP 500 status code (Internal Server Error).
RetryInterval	The time interval between attempts to retry a Bulk API request that failed with an HTTP 500 status code (Internal Server Error).
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.
SupportEnhancedSQL	This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UseBulkAPI	Whether or not the bulk API is used for retrieving data.
UseConnectionPooling	This property enables connection pooling.
UseSimpleNames	Boolean determining if simple names should be used for tables and columns.
OAuth
CallbackURL	The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
InitiateOAuth	Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthAccessToken	The access token for connecting using OAuth.
OAuthClientId	The client ID assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
OAuthRefreshToken	The OAuth refresh token for the corresponding OAuth access token.
OAuthSettingsLocation	The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.
OAuthVerifier	The verifier code returned from the OAuth authorization URL.
State	An optional value that has meaning for your OAuth App.
Proxy
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyExceptions	A semicolon separated list of hosts or IPs that are exempt from connecting through the ProxyServer .
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
Schema
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.