The time interval between requests that check the availability of the bulk query response. The default value is 200 ms.

string

"200"

The time interval between requests that check the availability of the bulk query response. When UseBulkAPI is set, the adapter requests Eloqua to prepare a response to the query. It then waits for the response to be ready by periodically polling the server to check status. This property controls the frequency of polling.

The timeout in minutes for which the provider will wait for a bulk query response. The default value is 25 minutes.

string

"25"

The timeout in minutes for which the adapter will wait for a bulk query response. The default value is 25 minutes. When UseBulkAPI is set, the adapter requests Eloqua to prepare a response to the query. It then waits for the response to be ready by periodically polling the server to check status. This property controls the total time the adapter will wait for a response.

Note that this property is very different from Timeout. The Timeout is an inactivity timeout that controls the time to wait for any response. This property controls the total length of time to wait for a bulk query to execute. ;

The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.

string

""

During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.

The company of the Eloqua account. This field is used to authenticate the user.

string

""

This field is used to provide authentication for the user to the Eloqua servers.

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.

string

"24"

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.

A password used to authenticate to a proxy-based firewall.

string

""

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

The TCP port for a proxy-based firewall.

string

""

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The name or IP address of a proxy-based firewall.

string

""

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the adapter uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The protocol used by a proxy-based firewall.

string

"NONE"

This property specifies the protocol that the adapter will use to tunnel traffic through the FirewallServer proxy. Note that by default the adapter connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

 

 

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

The user name to use to authenticate with a proxy-based firewall.

string

""

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.

string

"OFF"

The following options are available:

OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.

GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the adapter. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.

REFRESH: Indicates that the adapter will only handle refreshing the OAuthAccessToken. The user will never be prompted by the adapter to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

A path to the directory that contains the schema files defining tables, views, and stored procedures.

string

""

The path to a directory which contains the schema files for the adapter (.rsd files for tables and views, .rsb files for stored procedures). The Location property is only needed if you would like to customize definitions (e.g., change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

The schema files are deployed alongside the adapter assemblies. You must also ensure that Location points to the folder that contains the schema files. The folder location can be a relative path from the location of the executable.

Whether or not to use case sensitive match in data card mapping.

bool

false

Whether or not to use case sensitive match in data card mapping. Only has an effect if MapDataCardsRelationShip is set.

Comma-separated list of the relationships between the Custom Object tables and the Entity tables.

string

""

Comma-separated list of the relationships between the Custom Object tables and the Entity tables. The format of these relationships is '<custom_object>.<source_field>=<entity_type>.<entity_field>'. For example: Custom_MyCustomObject.Email_Address=Contact.C_EmailAddress

The access token for connecting using OAuth.

string

""

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your username and password. The access token protects your credentials by keeping them on the server.

The client Id assigned when you register your application with an OAuth authorization server.

string

""

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

The client secret assigned when you register your application with an OAuth authorization server.

string

""

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

The OAuth refresh token for the corresponding OAuth access token.

string

""

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH.

string

"%APPDATA%\\CData\\Eloqua Data Provider\\OAuthSettings.txt"

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the adapter saves OAuth values to a settings file to avoid requiring the user to manually enter OAuth connection properties. The default OAuthSettingsLocation is a settings file located in the %AppData%\CData folder.

The other parameters necessary to connect to a data source, such as username and password, when applicable.

string

""

The Other property is a semicolon-separated list of name-value pairs used in connection parameters specific to a data source.

The maximum number of results to return per page from Eloqua.

string

"500"

The Pagesize property affects the maximum number of results to return per page from Eloqua when executing a query. A higher value will return more results per page, but may also cause a timeout exception. The maximum page size supported by Eloqua is 1000.

The password of the Eloqua account used to authenticate.

string

""

This field is used to authenticate against the Eloqua servers.

The authentication type to use to authenticate to the ProxyServer proxy.

string

"BASIC"

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the adapter will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

BASIC: The adapter performs HTTP BASIC authentication.

DIGEST: The adapter performs HTTP DIGEST authentication.

NEGOTIATE: The adapter retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.

PROPRIETARY: The adapter does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see Firewall Type.

This indicates whether to use the system proxy settings or not. Set ProxyAutoDetect to FALSE to use custom proxy settings. This takes precedence over other proxy settings.

bool

true

By default, the adapter uses the system HTTP proxy. Set this to false if you want to connect to another proxy.

To connect to an HTTP proxy, see Proxy Server.

For other proxies, such as SOCKS or tunneling, see Firewall Type.

A semicolon separated list of hosts or IPs that will be exempt from connecting through the ProxyServer .

string

""

The ProxyServer will be used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the adapter will use the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you will need to set ProxyAutoDetect to false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

A password to be used to authenticate to the ProxyServer proxy.

string

""

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see Firewall Type.

By default, the adapter uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

string

"80"

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see Firewall Type.

The hostname or IP address of a proxy to route HTTP traffic through.

string

""

The hostname or IP address of a proxy to route HTTP traffic through. The adapter can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see Firewall Type.

By default, the adapter uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

string

"AUTO"

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

 

 

A user name to be used to authenticate to the ProxyServer proxy.

string

""

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the username of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a username in one of the following formats:

You can use this property to enforce read-only access to Eloqua from the provider.

bool

false

If this property is set to true, the adapter will allow only SELECT queries. INSERT, UPDATE, DELETE, and stored procedure queries will cause an error to be thrown.

The maximum number of times to retry a Bulk API request that fails due to an HTTP 500 status code (Internal Server Error).

string

"5"

When UseBulkAPI is set to "Auto" or "True", the adapter will attempt to retry any requests that fail due to an HTTP 500 status code (Internal Server Error). This property defintes maximum number of time the adapter will retry a Bulk API request that failed. By default the adapter will retry the request 5 times.

The time interval between attempts to retry a Bulk API request that failed with an HTTP 500 status code (Internal Server Error).

string

"200"

When UseBulkAPI is set to "Auto" or "True", the adapter will attempt to retry any requests that fail due to an HTTP 500 status code (Internal Server Error). This property defines the time interval between attempts to retry a Bulk API request that failed. The default value is 200 ms.

The certificate to be accepted from the server when connecting using TLS/SSL.

string

""

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine will be rejected.

This property can take the forms:

 

 

If not specified, any certificate trusted by the machine will be accepted. Use '*' to signify to accept all certificates (not recommended for security concerns).

An optional value that has meaning for your App.

string

""

An optional value that has meaning for your App..

The value in seconds until the timeout error is thrown, canceling the operation.

string

"60"

If the Timeout property is set to 0, operations do not time out: They run until they complete successfully or encounter an error condition.

If Timeout expires and the operation is not yet complete, the adapter throws an exception.

Whether or not the bulk API is used for retrieving data.

string

"Auto"

Whether or not the bulk API is used for retrieving data. When UseBulkAPI is set to "True", the adapter will always attempt to use the bulk API. However, there are several restrictions to accessible tables and columns. See Data Model for more information.

When set to "False", the adapter will use the REST API for all requests. When set to "Auto", the adapter will use whichever API is most appropriate for the request. For example, consider the following query:

In this case, the adapter will use the Bulk API (because the ContactId is not specified), whereas the following query will use the REST API:

Using the Bulk API starts with the adapter sending a request to Eloqua to prepare a response to the query. It then waits for the response to be ready by periodically polling the server to check status. BulkPollingInterval and BulkQueryTimeout control the frequency and duration of polling respectively.

The user of the Eloqua account. This field is used to authenticate the user.

string

""

This field is used to provide authentication for the user to the Eloqua servers.

Boolean determining if simple names should be used for tables and columns.

bool

false

Boolean determining if simple names should be used for tables and columns. Eloqua objects can have special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the adapter easier to use with traditional database tools.

Setting UseSimpleNames to true will simplify the names of tables and columns returned making them easier to work with. If set to false, the tables and columns will appear as they do in Eloqua.