Oracle Eloqua Connection Details¶
Introduction¶
Connector Version
This documentation is based on version 23.0.8852 of the connector.
Get Started¶
Oracle Eloqua Version Support
The connector models the Oracle Eloqua REST API as bidirectional tables. Bulk operations are supported through version 2.0 of the Bulk API.
Establish a Connection¶
Authenticate 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 theOAuthAccessToken
.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 connector opens Oracle Eloqua's OAuth endpoint in your default browser. Log in and grant permissions to the application.
After you grant permissions to the application, the connector completes the OAuth process:
- The connector obtains an access token from Oracle Eloqua and uses it to request data.
- The OAuth values are saved in the path specified in
OAuthSettingsLocation
. These values persist across connections.
When the access token expires, the connector refreshes it automatically.
Automatic refresh of the OAuth access token:
To have the connector automatically refresh the OAuth access token:
- 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 connector to save the OAuth values, which persist across connections.
- 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.
- To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
- Set these connection properties:
OAuthClientId
: The Client ID in your application settings.OAuthClientSecret
: The Client Secret in your application settings.
- Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
- 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.
Use 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.
Create a Custom OAuth Application¶
Create a Custom OAuth Application¶
In order to obtain the OAuth credentials needed to authenticate to Oracle Eloqua, you must
create and register an custom OAuth application linked linked to your Oracle Eloqua account.
-
Log in to Oracle Eloqua.
-
Navigate to
Settings > Platform Extensions > AppCloud Developer
. -
Click
Create New App
. -
Enter a name, icon, and description for the new application, to be displayed
to users when they connect to Oracle Eloqua.
The console displays theOAuthClientId
andOAuthClientSecret
. Record these values for future use. -
Specify a
CallbackURL
:- If this is a Desktop application, set the
CallbackURL
tohttp://localhost:3000
, or another port of your choice. - If this is a Web application, set the Callback URL to a page where you would like the user to be returned after they authorize your application. to after the user has authorized your application. Note that Eloqua requires that the Callback URL begin with
https://
, and that you specify a port.
- If this is a Desktop application, set the
When you connect, the add-in opens the OAuth endpoint in your default browser. Log in and grant permissions to the application.
Fine-Tuning Data Access¶
Fine Tuning Data Access¶
You can use the following properties to gain more granular control over how the connector surfaces the functionality of the underlying Oracle Eloqua APIs.
The connector uses the bulk API when possible; you can fine-tune the connectivity to the bulk API with the following connection properties:
UseBulkAPI
BulkPollingInterval
BulkQueryTimeout
DataRetentionDuration
Additionally, the following properties are useful to circumvent failed bulk API requests:
RetryCount
RetryInterval
Oracle Eloqua accepts characters for table and column names that must be escaped in SQL. You can set UseSimpleNames
to true to report nonalphanumeric characters as underscores.
Important Notes¶
Configuration Files and Their Paths¶
- All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.
Advanced Features¶
This section details a selection of advanced features of the Oracle Eloqua connector.
User Defined Views
The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.
SSL Configuration
Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert
property under "Connection String Options" for more information.
Proxy
To configure the connector using private agent proxy settings, select the Use Proxy Settings
checkbox on the connection configuration screen.
Query Processing
The connector offloads as much of the SELECT statement processing as possible to Oracle Eloqua and then processes the rest of the query in memory (client-side).
See Query Processing for more information.
User Defined Views¶
The Oracle Eloqua connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.
There are two ways to create user defined views:
- Create a JSON-formatted configuration file defining the views you want.
- DDL statements.
Define Views Using a Configuration File¶
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json
. The connector automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews
connection property. When you use this property, only the specified views are seen by the connector.
This User Defined View configuration file is formatted as follows:
- Each root element defines the name of a view.
- Each root element contains a child element, called
query
, which contains the custom SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Contact WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews
connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"
Define Views Using DDL Statements¶
The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.
Create a View¶
To create a new view using DDL statements, provide the view name and query as follows:
CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;
If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews
connection property.
Alter a View¶
To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:
ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';
The view is then updated in the JSON configuration file.
Drop a View¶
To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.
DROP LOCAL VIEW [MyViewName]
This removes the view from the JSON configuration file. It can no longer be queried.
Schema for User Defined Views¶
User Defined Views are exposed in the UserViews
schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName
property.
Work with User Defined Views¶
For example, a SQL statement with a User Defined View called UserViews.RCustomers
only lists customers in Raleigh:
SELECT * FROM Customers WHERE City = 'Raleigh';
An example of a query to the driver:
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';
Resulting in the effective query to the source:
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';
That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.
SSL Configuration¶
Customize the SSL Configuration¶
By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.
To specify another certificate, see the SSLServerCert
property for the available formats to do so.
Data Model¶
The Oracle Eloqua connector models the Bulk API and the REST API as relational tables, views, and stored procedures. For example, Oracle Eloqua activity types are represented by the corresponding views. Views are tables that cannot be modified.
Working with Oracle Eloqua APIs as Tables
All tables are accessible with the REST API, including custom tables. A limited number of tables and views can be used with the Bulk API. The connector supports version 2.0 of the Bulk API and version 2.0 of the REST API.
Custom Tables and Columns¶
The connector can expose custom tables, views, and columns from Oracle Eloqua that are not mentioned in the Tables and Views. The data model illustrates a sample of what your Oracle Eloqua data model might look like. The actual data model will be obtained dynamically based on your user credentials and Oracle Eloqua account. For example, the Account, Campaign, and Contact tables are dynamic: These tables contain the columns described and your custom columns.
Tables Available in the Bulk API¶
The following tables and views, including custom tables, are supported with the Bulk API:
- Account
- Activity_Bounceback
- Activity_EmailClickThrough
- Activity_EmailOpen
- Activity_EmailSend
- Activity_EmailSubscribe
- Activity_EmailUnsubscribe
- Activity_FormSubmit
- Activity_PageView
- Activity_WebVisit
- Contact
- Custom tables
- CampaignResponses
Stored Procedures
Stored Procedures are function-like interfaces to Oracle Eloqua that complement the data available from Oracle Eloqua tables. Stored procedures implement actions available in the Bulk API and other API functionality that cannot be expressed as SELECT, INSERT, UPDATE, or DELETE statements.
API SQL Limitations
Table-specific API limitations and requirements are documented in Tables and Views; you can use the SupportEnhancedSQL
feature, set by default, to circumvent most of these limitations. For both the Bulk and REST APIs, the following limitation exists for filtering on datetime columns: The "=" operator cannot be used with datetime columns in the WHERE clause. However, the "<", ">", ">=", and "<=" operators can be used to filter on datetime columns.
Additionally, the UpdatedAt column only supports filtering with the ">" operator.
Oracle Eloqua also has limited support on multiple conditions. In many tables the AND condition between filters is not supported. If AND is included the server might not return any results, nor will it return an error.
Bulk API Limitations¶
DELETE and UPDATE are not supported by the Bulk API. Additionally, the column count must be <250 for SELECT and must be <= 100 for INSERT.
REST API Limitations¶
Bulk updates are only supported in the Bulk API.
Custom Table Limitations¶
Custom tables are read-only in the REST API. In the Bulk API, SELECT and INSERT are supported.
Tables¶
The connector models the data in Oracle Eloqua as a list of tables in a relational database that can be queried using standard SQL statements.
Oracle Eloqua Connector Tables¶
Name | Description |
---|---|
Account | Create, update, delete, and query Accounts. This table is supported in bulk mode. |
AccountGroup | Retrieve Account group. |
Campaign | Create, update, delete, and query Campaigns. |
CampaignResponses | Create, delete, and query Campaign Responses. This table is only supported in bulk mode. |
Contact | Create, update, delete, and query Contacts. This table is supported in bulk mode. |
ContactEmailSubscription | Retrieve all email group subscription status for the specific contact. |
ContactSegment | Create, update, delete, and query Contact Segments. |
ContentSection | Create, update, delete, and query Content Sections. |
Custom | Create and delete custom. |
Email | Create, update, delete, and query Emails. |
EmailFooter | Create, update, delete, and query Email Footers. |
EmailGroup | Create, update, delete, and query Email Groups. |
EmailHeader | Create, update, delete, and query Email Headers. |
Event | Create and delete Event. |
ExternalActivity | Create and query External Activities. |
ExternalAsset | Create, update, delete, and query External Assets. |
Folder | Create, update, delete, and query Folders. |
Form | Create, update, delete, and query Forms. |
Hyperlink | Create, update, delete, and query Hyperlinks. |
LandingPage | Create, update, delete, and query Landing Pages. |
Microsite | Create, update, delete, and query Microsites. |
OptionList | Create, update, delete, and query Option Lists. |
OptionListElement | Create, update, delete, and query Option List Elements. |
The connector can expose custom tables, views, and columns from Oracle Eloqua that are not mentioned in the Tables and Views. The data model illustrates a sample of what your Oracle Eloqua data model might look like. The actual data model will be obtained dynamically based on your user credentials and Oracle Eloqua account.
Account¶
Create, update, delete, and query Accounts. This table is supported in bulk mode.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
ID [KEY] | Long | True | The unique identifier of the account. |
Company Name | String | False | The Name of the account. |
Country | String | False | The country of the account. |
Address | String | False | The address of the account. |
City | String | False | The city of the address for the account. |
State or Province | String | False | The state or province of the address for the account. |
Zip or Postal Code | String | False | The zip or postal code of the address for the account. |
Business Phone | String | False | The business phone number of the account. |
Eloqua Company ID | String | True | The Eloqua company ID of the account |
Date Created | Datetime | True | Date and time the account was created. |
Date Modified | Datetime | True | Date and time the account was last updated. |
Company Category | Double | False | The category of the company |
SFDC Account ID | String | False | The Salesforce ID of the account |
Last Modified by CRM System | Datetime | True | Date and time the account was last updated by the CRM system. |
Address 2 | String | False | The second address of the account. |
Address 3 | String | False | The third address of the account. |
Industry | String | False | The industry of the account. |
PURL Name (Default Hypersite) | String | True | The URL of the account. |
Annual Revenue | String | False | The annual revenue of the account. |
Fax | String | False | The fax number of the account. |
Employees | Double | False | The number of employees of the account |
Website | String | False | The website of the account. |
Account Rating | String | False | The account rating of the account. |
AccountGroup¶
Retrieve Account group.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
ID [KEY] | Long | True | The unique identifier for the account group. |
Name | String | False | The name of the account group. |
Type | String | False | The type of the account group. |
Permissions | String | False | The permissions of the account group. |
CreatedAt | Datetime | True | Date the account group was created. |
IsArchived | String | False | The ID of the user who created the account group. |
FolderId | String | True | The folderId of the account group. |
UpdatedAt | Datetime | True | Date the account group was updated. |
Description | String | True | The description of the accountgroup. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
Campaign¶
Create, update, delete, and query Campaigns.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
ID [KEY] | Long | True | The unique identifier of the campaign. |
Name | String | False | The name of the campaign. |
ActualCost | Double | False | The actual cost of the campaign. |
BudgetedCost | Double | False | The budgeted cost for the Campaign. |
CrmId | String | False | The unique ID of the campaign in your CRM. |
EndAt | Datetime | False | The campaign's end date. |
EndValues | String | False | The end values of the campaign. |
IsMemberAllowedReEntry | Boolean | False | Determines whether a member can reenter the campaign. |
IsReadOnly | Boolean | False | Whether the campaign is read-only. |
StartAt | Datetime | False | The campaign's start date. |
CreatedAt | Datetime | False | The date and time the campaign was created. |
CreatedBy | String | False | The ID of the user who created the Campaign. |
AccessedAt | Datetime | False | Date the campaign was accessed. |
CurrentStatus | String | False | The current status of the campaign. |
Depth | String | False | The depth of the campaign. |
UpdatedAt | Datetime | False | Date the campaign was updated. |
UpdatedBy | String | False | The ID of the user who last updated the Campaign. |
Permissions | String | False | The permissions of the campaign. |
ScheduledFor | Datetime | False | The date and time scheduled for the campaign. |
SourceTemplatedId | String | False | The ID of the source template for the campaign. |
FolderId | Long | False | The ID of the folder for the campaign. |
Campaign Type | String | False | The type of campaign. |
Product | String | False | The product of the campaign. |
Region | String | False | The region of the campaign. |
Five | String | False | The fifth value for the campagin. |
Four | String | False | The fourth value for the campagin. |
Three | String | False | The third value for the campagin. |
Two | String | False | The second value for the campagin. |
CLR End Date | Datetime | False | The CLR end date. |
CampaignResponses¶
Create, delete, and query Campaign Responses. This table is only supported in bulk mode.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
ID | Long | False | The unique identifier for the campaign responses. |
Member Status | String | False | The status of the campaign member. |
Integration Return Value | String | False | The return value of the campaign responses. |
Created At | Long | False | The created time of the campaign responses. |
Add At | String | False | The added time of the campaign responses. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
ServiceInstanceId | String | The AppCloud action service instance ID. It is necessary to insert or select this table |
ExecutionId | String | The execution ID of service instance.It is necessary to select this table |
Contact¶
Create, update, delete, and query Contacts. This table is supported in bulk mode.
Table Specific Information¶
The EmailAddress column is required for INSERTs and updates.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
ID [KEY] | Long | True | The unique identifier of the contact. |
Email Address [KEY] | String | False | The Email Address of the contact. |
First Name | String | False | The First Name of the contact. |
Last Name | String | False | The Last Name of the contact. |
Company | String | False | The Company of the contact. |
Email Display Name | String | False | The Email Display Name of the contact. |
Address 1 | String | False | The Address 1 of the contact. |
Address 2 | String | False | The Address 2 of the contact. |
Address 3 | String | False | The Address 3 of the contact. |
City | String | False | The City of the contact. |
State or Province | String | False | The State or Province of the contact. |
Zip or Postal Code | String | False | The Zip or Postal Code of the contact. |
Country | String | False | The Country of the contact. |
Business Phone | String | False | The Business Phone of the contact. |
Mobile Phone | String | False | The Mobile Phone of the contact. |
Fax | String | False | The Fax of the contact. |
Title | String | False | The Title of the contact. |
Salutation | String | False | The Salutation of the contact. |
Salesperson | String | False | The Salesperson of the contact. |
SFDC Contact ID | String | False | The SFDC Contact ID of the contact. |
SFDC Lead ID | String | False | The SFDC Lead ID of the contact. |
Date Created | Date | True | The Date Created of the contact. |
Date Modified | Date | True | The Date Modified of the contact. |
Eloqua Contact ID | String | True | The Eloqua Contact ID of the contact. |
SFDC Account ID | String | False | The SFDC Account ID of the contact. |
Last Modified by CRM System | Date | True | The Last Modified by CRM System of the contact. |
Last SFDC Campaign ID | String | False | The Last SFDC Campaign ID of the contact. |
Last SFDC Campaign Status | String | False | The Last SFDC Campaign Status of the contact. |
Company Revenue | String | False | The Company Revenue of the contact. |
SFDC Email Opt Out | String | False | The SFDC Email Opt Out of the contact. |
Lead Source - Most Recent | String | False | The Lead Source - Most Recent of the contact. |
Lead Source - Original | String | False | The Lead Source - Original of the contact. |
Industry | String | False | The Industry of the contact. |
Annual Revenue | String | False | The Annual Revenue of the contact. |
Lead Status | String | False | The Lead Status of the contact. |
Job Role | String | False | The Job Role of the contact. |
Lead Score - High Value Website Content | Double | False | The Lead Score - High Value Website Content of the contact. |
Lead Score Date - Engagement - Most Recent | Date | False | The Lead Score Date - Engagement - Most Recent of the contact. |
Integrated Marketing and Sales Funnel Stage | String | False | The Integrated Marketing and Sales Funnel Stage of the contact. |
Product/Solution of Interest | String | False | The Product/Solution of Interest of the contact. |
Region | String | False | The Region of the contact. |
PURL Name (Default Hypersite) | String | True | The PURL Name (Default Hypersite) of the contact. |
Lead Rating - Combined | String | False | The Lead Rating - Combined of the contact. |
Email Address Domain | String | True | The Email Address Domain of the contact. |
First and Last Name | String | True | The First and Last Name of the contact. |
Company Size | String | False | The Company Size of the contact. |
Lead Score - Last High Touch Event Date | Date | False | The Lead Score - Last High Touch Event Date of the contact. |
Lead Rating - Profile (Explicit) | String | False | The Lead Rating - Profile (Explicit) of the contact. |
Lead Rating - Engagement (Implicit) | String | False | The Lead Rating - Engagement (Implicit) of the contact. |
Lead Score - Profile (Explicit) | Double | False | The Lead Score - Profile (Explicit) of the contact. |
Lead Score - Engagement (Implicit) | Double | False | The Lead Score - Engagement (Implicit) of the contact. |
Lead Score Date - Profile - Most Recent | Date | False | The Lead Score Date - Profile - Most Recent of the contact. |
Employees | Double | False | The Employees of the contact. |
Territory | String | False | The Territory of the contact. |
Lead Score | String | False | The Lead Score of the contact. |
PURL Name | String | True | The PURL Name of the contact. |
MD5 Hashed Email Address | String | True | The MD5 Hashed Email Address of the contact. |
SHA256 Hashed Email Address | String | True | The SHA256 Hashed Email Address of the contact. |
MD5 Hashed Business Phone | String | True | The MD5 Hashed Business Phone of the contact. |
SHA256 Hashed Business Phone | String | True | The SHA256 Hashed Business Phone of the contact. |
MD5 Hashed Mobile Phone | String | True | The MD5 Hashed Mobile Phone of the contact. |
SHA256 Hashed Mobile Phone | String | True | The SHA256 Hashed Mobile Phone of the contact of the contact. |
ContactEmailSubscription¶
Retrieve all email group subscription status for the specific contact.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
ID [KEY] | Long | True | The unique identifier for Email Group. |
ContactID [KEY] | Long | False | The unique identifier for the contact. |
Name | String | True | The name of the email group. |
Description | String | True | The description of the email group. |
IsSubScribed | Boolean | False | The subscribed status. The default value is false. |
Permissions | String | True | The permissions of the email group. |
ContactSegment¶
Create, update, delete, and query Contact Segments.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
ID [KEY] | Long | True | The unique identifier for the contact segment. |
Name | String | False | The name of the contact segment. |
Description | String | False | The description of the contact segment. |
FolderId | Long | False | The ID of the folder for the contact segment. |
ScheduledFor | Datetime | False | The date and time scheduled for the contact segment. |
SourceTemplatedId | Long | False | The ID of the source template of the contact segment. |
Permissions | String | False | The permissions of the contact segment. |
CreatedAt | Datetime | True | Date the contact segment was created. |
CreatedBy | String | True | The ID of the user who created the contact segment. |
AccessedAt | Datetime | False | Date the contact segment was accessed. |
CurrentStatus | String | False | The current status of the contact segment. |
UpdatedAt | Datetime | True | Date the contact segment was last updated. |
UpdatedBy | String | True | The ID of the user who last updated the contact segment. |
LastCalculatedAt | Datetime | False | Date the contact segment was last calculated. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
ContentSection¶
Create, update, delete, and query Content Sections.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
ID [KEY] | Long | True | The unique identifier for the content section. |
Name | String | False | The name of the content section. |
Description | String | False | The description of the content section. |
FolderId | Long | False | The ID of the folder for the content section. |
ScheduledFor | Datetime | False | The date and time scheduled for the content section. |
SourceTemplatedId | Long | False | The ID of the source template of the content section. |
Permissions | String | False | The permissions of the content section. |
CreatedAt | Datetime | True | Date the content section was created. |
CreatedBy | String | True | The ID of the user who created the content section. |
AccessedAt | Datetime | False | Date the content section was accessed. |
CurrentStatus | String | False | The current status of the content section. |
UpdatedAt | Datetime | True | Date the content section was updated. |
UpdatedBy | String | True | The ID of the user who last updated the content section. |
ContentHtml | String | False | The content HTML of the content section. |
ContentText | String | False | The content text of the data lookup for the content section. |
Scope | String | False | A list of contact Ids to be removed from the content section. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
Custom¶
Create and delete custom.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
Id [KEY] | String | False | The ID of the custom. |
Name | String | False | The name of the custom. |
EmailAddressFieldId | String | False | The field ID that contains the Email Address. Use the desired custom object field's negative ID as the value for this parameter. |
EventGroupByFieldId | String | False | The ID of the field used to organize multiple sessions. Use the desired custom object field's negative ID as the value for this parameter. |
FolderId | String | True | The folder ID of the folder which contains the custom. |
Fields | String | False | Array consisting of custom field properties |
Description | String | False | The description of the custom. |
RecordCount | Integer | True | The amount of records within the custom. |
CreatedAt | Datetime | True | Date the custom was created. |
CreatedBy | String | True | The ID of the user who created the custom. |
UpdatedAt | Datetime | True | Date the custom was last updated. |
UpdatedBy | String | True | The ID of the user who last updated the custom. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
Email¶
Create, update, delete, and query Emails.
Table Specific Information¶
Select¶
The following limitation exists for filtering on datetime columns: The "=" operator cannot be used with datetime columns in the WHERE clause. However, the "<", ">", ">=", and "<=" operators can be used to filter on datetime columns.
Additionally, the UpdatedAt column only supports filtering with the '>' operator.
Oracle Eloqua also has limited support on multiple conditions. In many tables the AND condition between filters is not supported. If AND is included the server might not return any results, nor will it return an error.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
ID [KEY] | Long | True | The unique identifier of the email. |
Name | String | False | The name of the email. |
EmailGroupId | Long | False | The ID of the email group. |
HtmlContent_ContentSource | String | False | The raw HTML contentSorce for the content of the email. |
HtmlContent_CssHeader | String | False | The raw HTML cssHeader for the content of the email. |
HtmlContent_DocType | String | False | The raw HTML docType for the content of the email. |
HtmlContent_DocumentDescription | String | False | The raw HTML documentDescription for the content of the email. |
HtmlContent_HtmlBody | String | False | The raw HTML Body for the content of the email. |
HtmlContent_MetaTags | String | True | The raw HTML metaTags for the content of the email. |
HtmlContent_Root | String | False | The raw HTML root for the content of the email. |
HtmlContent_SystemHeader | String | False | The raw HTML systemHeader for the content of the email. |
HtmlContent_Type | String | False | The raw HTML type for the content of the email. |
IsPlainTextEditable | Boolean | False | Identifies whether the email is plaintext editable. |
IsTracked | Boolean | False | Identifies whether the email is tracked. |
PlainText | String | False | The plaintext version of the email. |
BouncebackEmail | String | False | The bounce-back email address. |
ReplyToEmail | String | False | The email address in the reply-to line of the email. |
ReplyToName | String | False | The name in the reply-to line of the email. |
SenderEmail | String | False | The email address of the sender. |
SenderName | String | False | The name of the sender. |
SenderPlainTextOnly | Boolean | False | Identifies whether the plaintext version should be sent. |
Subject | String | False | The subject of the email. |
Description | String | False | The description of the email. |
FolderId | Long | False | The ID of the folder for the email. |
EmailHeaderId | Long | False | The ID of the email header. |
EmailFooterId | Long | False | The ID of the email footer. |
Permissions | String | False | The permissions of the email. |
CreatedAt | Datetime | True | Date the email was created. |
CreatedBy | String | True | The ID of the user who created the email. |
AccessedAt | Datetime | False | Date the email was accessed. |
CurrentStatus | String | False | The current status of the email. |
Depth | String | False | The depth of the email. |
UpdatedAt | Datetime | True | Date the email was updated. |
UpdatedBy | String | True | The ID of the user who last updated the email. |
EmailFooter¶
Create, update, delete, and query Email Footers.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
ID [KEY] | Long | True | The unique identifier for the email footer. |
Name | String | False | The name of the email footer. |
Body | String | False | The body of the email footer. |
Hyperlinks | String | True | A list of hyperlinks. |
FieldMerges | String | True | A list of field merges. |
Text | String | False | The text of the email footer. |
Permissions | String | False | The permissions of the email footer. |
Description | String | False | The description of the email footer. |
FolderId | Long | False | The ID of the folder for the email footer. |
CreatedAt | Datetime | True | Date the email footer was created. |
CreatedBy | String | True | The ID of the user who created the email footer. |
AccessedAt | Datetime | False | Date the email footer was accessed. |
CurrentStatus | String | False | The current status of the email footer. |
Depth | String | False | The depth of the email footer. |
UpdatedAt | Datetime | True | Date the email footer was updated. |
UpdatedBy | String | True | The ID of the user who last updated the email footer. |
PlainText | String | True | The plain text of the email footer. |
EmailGroup¶
Create, update, delete, and query Email Groups.
Table Specific Information¶
Select¶
The following limitation exists for filtering on datetime columns: The "=" operator cannot be used with datetime columns in the WHERE clause. However, the "<", ">", ">=", and "<=" operators can be used to filter on datetime columns.
Additionally, the UpdatedAt column only supports filtering with the '>' operator.
Oracle Eloqua also has limited support on multiple conditions. In many tables the AND condition between filters is not supported. If AND is included the server might not return any results, nor will it return an error.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
ID [KEY] | Long | True | The unique identifier of the email group. |
Name | String | False | The name of the email. |
DisplayName | String | False | The display name of the email group. |
EmailFooterId | Long | False | The ID of the email footer of the email group. |
EmailIds | String | False | The Ids of the emails in the email group. |
IsVisibleInOutlookPlugin | Boolean | False | Identifies whether the email group is visible in the Outlook plugin. |
IsVisibleInPublicSubscriptionList | Boolean | False | Identifies whether the email group is visible in public subscription list. |
SubscriptionLandingPageId | Long | False | The ID of the landing page used to subscribe to the email group. |
SubscriptionListId | Long | False | The ID of the subscription list for the email group. |
UnsubscriptionLandingPageId | Long | False | The ID of the landing page used to unsubscribe for the email group. |
UnsubscriptionListId | Long | False | The ID of the unsubscription list for the email group. |
UnsubscriptionListDataLookupId | String | False | The ID of the data lookup for the unsubscription list for the email group. |
Description | String | False | The description of the email group. |
FolderId | Long | False | The folder ID for the email group. |
Permissions | String | False | The permissions list of the email group. |
CreatedAt | Datetime | True | Date the email group was created. |
CreatedBy | String | True | The ID of the user who created the email group. |
AccessedAt | Datetime | False | Date the email group was accessed. |
CurrentStatus | String | False | The current status of the email group. |
Depth | String | False | The depth of the email group. |
UpdatedAt | Datetime | True | Date the email group was updated. |
UpdatedBy | String | True | The ID of the user who last updated the email group. |
EmailHeader¶
Create, update, delete, and query Email Headers.
Table Specific Information¶
Select¶
The following limitation exists for filtering on datetime columns: The "=" operator cannot be used with datetime columns in the WHERE clause. However, the "<", ">", ">=", and "<=" operators can be used to filter on datetime columns.
Additionally, the UpdatedAt column only supports filtering with the '>' operator.
Oracle Eloqua also has limited support on multiple conditions. In many tables the AND condition between filters is not supported. If AND is included the server might not return any results, nor will it return an error.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
ID [KEY] | Long | True | The unique identifier for the email header. |
Name | String | False | The name of the email header. |
Body | String | False | The body of the email header. |
Hyperlinks | String | True | A list of hyperlinks. |
FieldMerges | String | True | A list of field merges. |
Text | String | False | The text of the email header. |
Permissions | String | False | The permissions of the email header. |
Description | String | False | The description of the email header. |
FolderId | Long | False | The ID of the folder for the email header. |
CreatedAt | Datetime | True | Date the email header was created. |
CreatedBy | String | True | The ID of the user who created the email header. |
AccessedAt | Datetime | False | Date the email header was accessed. |
CurrentStatus | String | False | The current status of the email header. |
Depth | String | False | The depth of the email header. |
UpdatedAt | Datetime | True | Date the email header was updated. |
UpdatedBy | String | True | The ID of the user who last updated the email header. |
Event¶
Create and delete Event.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
Id [KEY] | String | False | The ID of the event. |
Name | String | False | The name of the event. |
EmailAddressFieldId | String | False | The field ID that contains the Email Address. Use the negative ID of the desired custom object field as the value for this parameter. |
EventGroupByFieldId | String | False | The ID of the field used to organize multiple sessions. Use the negative ID of the desired custom object field as the value for this parameter. |
FolderId | String | True | The folder ID of the folder which contains the event. |
Fields | String | False | Array consisting of event field properties. |
Description | String | False | The description of the event. |
RecordCount | Integer | True | The amount of records within the event. |
CreatedAt | Datetime | True | Date the event was created. |
CreatedBy | String | True | The ID of the user who created the event. |
UpdatedAt | Datetime | True | Date the event was last updated. |
UpdatedBy | String | True | The ID of the user who last updated the event. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
ExternalActivity¶
Create and query External Activities.
Table Specific Information¶
Select¶
This table requires that either Id
or ContactId
be specified to retrieve data:
SELECT * FROM ExternalActivity WHERE Id = '1111'
SELECT * FROM ExternalActivity WHERE ContactId = '11'
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
ID [KEY] | Long | True | The unique identifier of the external activity. |
Type | String | False | The type of the external activity. |
Name | String | False | The Name of the external activity. |
ActivityType | String | False | The Type of external activity. |
ContactId | Long | False | The ID of the contact who performed the external activity |
CampaignId | Long | False | The ID of the campaign associated with this external activity. |
AssetName | String | False | The AssetName of the external activity. |
AssetType | String | False | The AssetType of the external activity. |
AssetId | Long | False | The AssetId of the external activity. |
ActivityDate | Datetime | False | The Date of the external activity. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
ExternalAsset¶
Create, update, delete, and query External Assets.
Table Specific Information¶
Select¶
The following limitation exists for filtering on datetime columns: The "=" operator cannot be used with datetime columns in the WHERE clause. However, the "<", ">", ">=", and "<=" operators can be used to filter on datetime columns.
Additionally, the UpdatedAt column only supports filtering with the '>' operator.
Oracle Eloqua also has limited support on multiple conditions. In many tables the AND condition between filters is not supported. If AND is included the server might not return any results, nor will it return an error.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
ID [KEY] | Long | True | The unique identifier of the external asset. |
Name | String | False | The name of the external asset. |
CreatedAt | Datetime | True | Date the external asset was created. |
CreatedBy | String | True | The ID of the user who created the external asset. |
Depth | String | False | The depth of the external asset. |
UpdatedAt | Datetime | True | Date the external asset was updated. |
UpdatedBy | String | True | The ID of the user who last updated the external asset. |
Folder¶
Create, update, delete, and query Folders.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
ID [KEY] | Long | True | The unique identifier for the folder. |
Name | String | False | The name of the folder. |
IsSystem | Boolean | False | Identifies a system-generated folder. |
Description | String | False | The description of the folder. |
CreatedAt | Datetime | True | Date the folder was created. |
UpdatedAt | Datetime | True | Date the folder was last updated. |
UpdatedBy | String | True | The ID of the user who last updated the folder. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
Form¶
Create, update, delete, and query Forms.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
ID [KEY] | Long | True | The unique identifier for the form. |
Name | String | False | The name of the form. |
FolderId | Long | False | The ID of the folder for the form. |
SourceTemplatedId | Long | False | The ID of the source template of the form. |
Permissions | String | False | The permissions of the form. |
CreatedAt | Datetime | True | Date the form was created. |
CreatedBy | String | True | The ID of the user who created the form. |
CurrentStatus | String | False | The current status of the form. |
UpdatedAt | Datetime | True | Date the form was last updated. |
UpdatedBy | String | True | The ID of the user who last updated the form. |
HtmlName | String | False | The HTML name of the form. |
ProcessingType | String | False | The processing type of the data lookup for the form. |
SubmitFailedLandingPageId | Long | False | The submit failed landing page ID of the form. |
Html | String | False | The HTML of the form. |
Style | String | False | The style of the form. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
Hyperlink¶
Create, update, delete, and query Hyperlinks.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
ID [KEY] | Long | True | The unique identifier for the hyperlink. |
Name | String | False | The name of the hyperlink. |
IsSystem | Boolean | False | Identifies a system-generated hyperlink. |
UpdatedAt | Datetime | True | Date the hyperlink was updated. |
UpdatedBy | String | True | The ID of the user who last updated the hyperlink. |
FolderId | Long | False | The folder ID of the hyperlink. |
CreatedAt | Datetime | True | Date the hyperlink was created. |
CreatedBy | String | True | The ID of the user who created the hyperlink. |
Href | String | False | The href of the hyperlink. |
HyperlinkType | String | False | The type of the hyperlink. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
LandingPage¶
Create, update, delete, and query Landing Pages.
Table Specific Information¶
Select¶
The following limitation exists for filtering on datetime columns: The "=" operator cannot be used with datetime columns in the WHERE clause. However, the "<", ">", ">=", and "<=" operators can be used to filter on datetime columns.
Additionally, the UpdatedAt column only supports filtering with the '>' operator.
Oracle Eloqua also has limited support on multiple conditions. In many tables the AND condition between filters is not supported. If AND is included the server might not return any results, nor will it return an error.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
ID [KEY] | Long | True | The unique identifier for the landing page. |
Name | String | False | The name of the landing page. |
DeployedAt | Datetime | False | Date the landing page was deployed. |
HtmlContent | String | False | The raw HTML for the content of the landing page. |
MicrositeId | Long | False | The unique identifier for this page's microsite. |
RefreshedAt | Datetime | False | Date the landing page was refreshed. |
RelativePath | String | False | The relative path to the landing page. |
Style | String | False | The style of the landing page. |
Description | String | False | The description of the landing page. |
FolderId | Long | False | The ID of the folder for the landing page |
Permissions | String | False | The permissions list for the landing page. |
CreatedAt | Datetime | True | Date the landing page was created. |
CreatedBy | String | True | The ID of the user who created the landing page. |
AccessedAt | Datetime | False | Date the landing page was accessed. |
CurrentStatus | String | False | The current status of the landing page. |
AutoRedirectUrl | String | False | The URL to redirect window used with autoRedirectWaitFor. |
Depth | String | False | The depth of the landing page. |
UpdatedAt | Datetime | True | Date the landing page was updated. |
UpdatedBy | String | True | The ID of the user who last updated the landing page. |
Microsite¶
Create, update, delete, and query Microsites.
Table Specific Information¶
Select¶
The following limitation exists for filtering on datetime columns: The "=" operator cannot be used with datetime columns in the WHERE clause. However, the "<", ">", ">=", and "<=" operators can be used to filter on datetime columns.
Additionally, the UpdatedAt column only supports filtering with the '>' operator.
Oracle Eloqua also has limited support on multiple conditions. In many tables the AND condition between filters is not supported. If AND is included the server might not return any results, nor will it return an error.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
ID [KEY] | Long | True | The unique identifier of the microsite. |
Name | String | False | The name of the microsite. |
Domains | String | False | A list of domains for this micosite. |
ScheduledFor | Datetime | False | The date and time scheduled for the microsite. |
SourceTemplatedId | Long | False | The ID of the source template for the microsite. |
DefaultLandingPageId | Long | False | The ID of the default landing page for the microsite. |
Description | String | False | The description of the microsite. |
FolderId | Long | False | The ID of the folder for the microsite |
Permissions | String | False | The permissions of the microsite. |
CreatedAt | Datetime | True | Date the microsite was created. |
CreatedBy | String | True | The ID of the user who created the microsite. |
AccessedAt | Datetime | False | Date the microsite was accessed. |
CurrentStatus | String | False | The current status of the microsite. |
Depth | String | False | The depth of the microsite. |
UpdatedAt | Datetime | True | Date the microsite was updated. |
UpdatedBy | String | True | The ID of the user who last updated the microsite. |
OptionList¶
Create, update, delete, and query Option Lists.
Table Specific Information¶
Select¶
The following limitation exists for filtering on datetime columns: The "=" operator cannot be used with datetime columns in the WHERE clause. However, the "<", ">", ">=", and "<=" operators can be used to filter on datetime columns.
Additionally, the UpdatedAt column only supports filtering with the '>' operator.
Oracle Eloqua also has limited support on multiple conditions. In many tables the AND condition between filters is not supported. If AND is included the server might not return any results, nor will it return an error.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
ID [KEY] | Long | True | The unique ID of the option list. |
Name | String | False | The name of the option list item. |
Depth | String | False | The depth of the option list item. |
Permissions | String | False | The permissions of the option list item. |
OptionListElement¶
Create, update, delete, and query Option List Elements.
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
ID [KEY] | Long | True | The unique ID of the option list. |
Name | String | False | The name of the option list item. |
type | String | False | The type of the option list element item. |
displayName | String | False | The displayName of the option list element item. |
value | String | False | The value of the option list element item. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
Views¶
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
Oracle Eloqua Connector Views¶
Name | Description |
---|---|
AccountField | Retrieve Account Fields. |
AccountView | Retrieve Account Views. |
Activity_Bounceback | Retrieve Bounceback Activities. This table is only supported in bulk mode. |
Activity_CampaignMembership | Retrieve Campaign Membership Activities. |
Activity_EmailClickThrough | Retrieve Email Click Through Activities. |
Activity_EmailOpen | Retrieve Email Open Activities. |
Activity_EmailSend | Retrieve Email Send Activities. |
Activity_EmailSubscribe | Retrieve Email Subscribe Activities. |
Activity_EmailUnsubscribe | Retrieve Email Unsubscribe Activities. |
Activity_FormSubmit | Retrieve Form Submit Activities. |
Activity_PageView | Retrieve Page View Activities. This table is only supported in bulk mode. |
Activity_WebVisit | Retrieve Web Visit Activities. |
CampaignElement | Retrieve Campaign Elements. |
CampaignField | Retrieve Campaign Fields. |
CampaignFolder | Retrieve Campaign Folders. |
ContactField | Retrieve Contact Fields. |
ContactFilter | Retrieve Contact Filters. |
ContactFilterFolder | Retrieve Contact Filter Folders. |
ContactList | Create, update, delete, and query Contact Lists. |
ContactListFolder | Retrieve Contact List Folders. |
ContactScoringModelFolder | Retrieve Contact Scoring Model Folders. |
ContactSegmentData | Retrieve Contact Segment Data. Note: The pseudo column SegmentID must be specified to retrieve the data of this table. This SegmentID can be retrieved from the ContactSegment table's ID column. |
ContactSegmentFolder | Retrieve Contact Segment Folders. |
ContactView | Retrieve Contact Views. |
ContentSectionFolder | Retrieve Content Section Folders. |
Dependencies | Retrieve Dependencies. |
DynamicContent | Retrieve Dynamic Contents. |
DynamicContentFolder | Retrieve Dynamic Content Folders. |
EmailDeployment | Retrieve email deployments. |
EmailFolder | Retrieve Email Folders. |
EmailFooterFolder | Retrieve Email Footer Folders. |
EmailHeaderFolder | Retrieve Email Header Folders. |
ExternalType | Retrieve External Types. |
FieldMerge | Retrieve Field Merges. |
FieldMergeFolder | Retrieve Field Merge Folders. |
FormElement | Retrieve Form Elements. |
FormFolder | Retrieve Form Folders. |
FormProcessingStep | Retrieve Form Processing Steps. |
HyperlinkFolder | Retrieve Hyperlink Folders. |
Image | Retrieve Image. |
ImageFolder | Retrieve Image Folders. |
ImportedFile | Retrieve Imported Files. |
ImportedFileFolder | Retrieve Imported File Folders. |
LandingPageFolder | Retrieve Landing Page Folders. |
LeadScoringModel | Query Lead Scoring Models. |
PageTag | Retrieve Page Tags. |
PageTagGroup | Retrieve Page Tag Groups. |
Program | Retrieve Programs. |
Style | Retrieve Styles. |
Template | Retrieve Templates. |
TemplateCategory | Retrieve Template Categories. |
TrackedUrl | Retrieve Tracked Urls. |
User | Retrieve Users. |
Visitor | Retrieve Visitors. |
VisitorProfileField | Retrieve all of the visitor profile fields. |
AccountField¶
Retrieve Account Fields.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the account field. |
Name | String | The name of the account field. |
DataType | String | The data type of the account field. |
DisplayType | String | The display type of the account field. |
InternalName | String | The country of the account field. |
IsReadOnly | Boolean | Identifies whether the account field is read-only. |
IsRequired | Boolean | Identifies whether the account field is required. |
IsStandard | Boolean | Identifies whether the account field is standard. |
OptionListId | Long | The ID of the option list for the account field. |
OutputFormatId | Long | The ID of the output format for the account field. |
CreatedAt | Datetime | Date the account field was created. |
CreatedBy | String | The ID of the user who created the account field. |
Depth | String | The depth of the account field. |
UpdatedAt | Datetime | Date the account field was updated. |
UpdatedBy | String | The ID of the user who last updated the account field. |
AccountView¶
Retrieve Account Views.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the account view. |
Name | String | The name of the account view. |
Description | String | The description of the account view. |
Permissions | String | The permissions of the account view. |
CreatedAt | Datetime | Date the account view was created. |
CreatedBy | String | The ID of the user who created the account view. |
AccessedAt | Datetime | Date the account view was accessed. |
UpdatedAt | Datetime | Date the account view was updated. |
UpdatedBy | String | The ID of the user who last updated the account view. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
Activity_Bounceback¶
Retrieve Bounceback Activities. This table is only supported in bulk mode.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier of the bounceback activity. |
CreatedAt | Datetime | The date and time the bounceback activity was created. |
Type | String | The type of the activity associated with the bounceback activity. |
AssetName | String | The name of the asset associated with the bounceback activity. |
AssetId | Long | The ID of the asset associated with the bounceback activity. |
AssetType | String | The type of the asset associated with the bounceback activity. |
CampaignId | Long | The ID of the campaign associated with the bounceback activity. |
EmailAddress | String | The address of the email. |
ExternalId | String | The ExternalId associated with the email activity. Only supported in bulk mode. |
EmailRecipientId | String | The Email Recipient ID associated with the email activity. Only supported in bulk mode. |
SmtpErrorCode | String | The Smtp Error Code associated with the email activity. Only supported in bulk mode. |
SmtpStatusCode | String | The Smtp Status Code associated with the email activity. Only supported in bulk mode. |
SmtpMessage | String | The Smtp Message associated with the email activity. Only supported in bulk mode. |
DeploymentId | String | The email deployment ID associated with the email activity. Only supported in bulk mode. |
ContactId | Long | The ID of the contact associated with the bounceback activity. |
FirstName | String | The FirstName of the contact associated with the bounceback activity. |
LastName | String | The LastName of the contact associated with the bounceback activity. |
Company | String | The Company of the contact associated with the bounceback activity. |
City | String | The City of the contact associated with the bounceback activity. |
ContactCreatedAt | Datetime | The date and time the contact associated with the bounceback activity was created. |
ContactModifiedAt | Datetime | The date and time the contact associated with the bounceback activity was created. |
Address1 | String | The first line address of the contact associated with the bounceback activity. |
Address2 | String | The second line address of the contact associated with the bounceback activity. |
Title | String | The Title of the contact associated with the bounceback activity. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
ExportToken | String | The token returned from CreateExportDefinition. If Eloqua has not finished processing the request, the query will wait until the server has finished before returning data. |
Depth | String | The depth of information requested from Eloqua. |
Activity_CampaignMembership¶
Retrieve Campaign Membership Activities.
Table Specific Information¶
This table is the only activity table not available in the Bulk API.
Select¶
ContactId is required to query Activity tables.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier of the campaign membership activity. |
Name | String | The name of the campaign membership activity. |
CreatedAt | Datetime | The date and time the campaign membership activity was created. |
Type | String | The type of campaign membership activity. |
AssetId | Long | The ID of the asset associated with the campaign membership activity. |
AssetType | String | The type of the asset associated with the campaign membership activity. |
AssetName | String | The name of the asset associated with the email campaign membership activity. |
ContactId | Long | The ID of the contact who performed the campaign membership activity. |
Responded | String | Whether the campaign membership activity has been responded to. |
CampaignName | String | The campaign name of the campaign membership activity. |
LeadStage | String | The lead stage of the campaign membership activity. |
CampaignId | Long | The campaignId of the campaign membership activity. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
ExportToken | String | The token returned from CreateExportDefinition. If Eloqua has not finished processing the request, the query will wait until the server has finished before returning data. |
Depth | String | The depth of information requested from Eloqua. |
Activity_EmailClickThrough¶
Retrieve Email Click Through Activities.
Table Specific Information¶
Select¶
If you are not using the Bulk API, ContactId is required to query Activity tables.
Additionally, the COUNT function is supported for this table in bulk mode.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier of the email click-through activity. |
Name | String | The name of the email click-through activity. Not supported in bulk mode. |
CreatedAt | Datetime | The date and time the email click-through activity was created. |
Type | String | The type of the email click-through activity. |
AssetId | Long | The ID of the asset associated with the email click-through activity. |
AssetName | String | The name of the asset associated with the email click-through activity. |
AssetType | String | The type of the asset associated with the email click-through activity. |
ContactId | Long | The ID of the contact who performed the email click-through activity. |
EmailClickedThruLink | String | The click-through link in the email. |
EmailName | String | The name of the email. Not supported in bulk mode. |
EmailWebLink | String | The Web link of the email. |
SubjectLine | String | The subject line of the email. |
EmailRecipientId | String | The ID of the recipient of the email. |
EmailSendType | String | The send type of the email. Only supported in bulk mode. |
EmailAddress | String | The address of the email. Only supported in bulk mode. |
IpAddress | String | The IP address of the email activity. Only supported in bulk mode. |
CampaignId | Long | The ID of the campaign associated with the email click-through activity. Only supported in bulk mode. |
DeploymentId | Long | The deployment ID associated with the email open activity. Only supported in bulk mode. |
VisitorId | Long | The ID of the visitor associated with the email open activity. Only supported in bulk mode. |
VisitorExternalId | String | The ExternalId of the visitor associated with the email open activity. Only supported in bulk mode. |
ExternalId | String | The ExternalId associated with the email open activity. Only supported in bulk mode. |
FirstName | String | The FirstName of the contact associated with the email click-through activity. |
LastName | String | The LastName of the contact associated with the email click-through activity. |
Company | String | The Company of the contact associated with the email click-through activity. |
City | String | The City of the contact associated with the email click-through activity. |
ContactCreatedAt | Datetime | The date and time the contact associated with the email click-through activity was created. |
ContactModifiedAt | Datetime | The date and time the contact associated with the email click-through activity was created. |
Address1 | String | The first line address of the contact associated with the email click-through activity. |
Address2 | String | The second line address of the contact associated with the email click-through activity. |
Title | String | The Title of the contact associated with the email click-through activity. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
ExportToken | String | The token returned from CreateExportDefinition. If Eloqua has not finished processing the request, the query will wait until the server has finished before returning data. |
Depth | String | The depth of information requested from Eloqua. |
Activity_EmailOpen¶
Retrieve Email Open Activities.
Table Specific Information¶
Select¶
If you are not using the Bulk API, ContactId is required to query Activity tables.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier of the email open activity. |
Name | String | The name of the email open activity. Not supported in bulk mode. |
EmailAddress | String | The email address of the contact. |
CreatedAt | Datetime | The date and time the email open activity was created. |
Type | String | The type of the activity associated with the email open activity. |
AssetName | String | The name of the asset associated with the email open activity. |
AssetId | Long | The ID of the asset associated with the email open activity. |
AssetType | String | The type of the asset associated with the email open activity. |
ContactId | Long | The ID of the contact who performed the email open activity. |
EmailName | String | The name of the email. Not supported in bulk mode. |
EmailWebLink | String | The Web link of the email. |
EmailRecipientId | String | The ID of the recipient of the email. |
EmailSendType | String | The send type of the email. Only supported in bulk mode. |
IPAddress | String | The IP address of the sender. |
SubjectLine | String | The subject line of the email. |
CampaignId | Long | The ID of the campaign associated with the email open activity. Only supported in bulk mode. |
DeploymentId | Long | The deployment ID associated with the email open activity. Only supported in bulk mode. |
VisitorId | Long | The ID of the visitor associated with the email open activity. Only supported in bulk mode. |
VisitorExternalId | String | The ExternalId of the visitor associated with the email open activity. Only supported in bulk mode. |
ExternalId | String | The ExternalId associated with the email open activity. Only supported in bulk mode. |
FirstName | String | The FirstName of the contact associated with the email open activity. |
LastName | String | The LastName of the contact associated with the email open activity. |
Company | String | The Company of the contact associated with the email open activity. |
City | String | The City of the contact associated with the email open activity. |
ContactCreatedAt | Datetime | The date and time the contact associated with the email open activity was created. |
ContactModifiedAt | Datetime | The date and time the contact associated with the email open activity was created. |
Address1 | String | The first line address of the contact associated with the email open activity. |
Address2 | String | The second line address of the contact associated with the email open activity. |
Title | String | The Title of the contact associated with the email open activity. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
ExportToken | String | The token returned from CreateExportDefinition. If Eloqua has not finished processing the request, the query will wait until the server has finished before returning data. |
Depth | String | The depth of information requested from Eloqua. |
Activity_EmailSend¶
Retrieve Email Send Activities.
Table Specific Information¶
Select¶
If you are not using the Bulk API, ContactId is required to query Activity tables.
Additionally, the COUNT function is supported for this table in bulk mode.
Columns¶
Name | Type | Description |
---|---|---|
ExternalId [KEY] | String | The ExternalId associated with the email send activity. Only supported in bulk mode. |
ID | Long | The identifier of the email send activity. This is not unique. |
Name | String | The name of the email send activity. Not supported in bulk mode. |
CreatedAt | Datetime | The date and time when the email send activity was created. |
Type | String | The activity type of the email send activity. |
AssetName | String | The name of the asset associated with the email send activity. |
AssetId | Long | The ID of the asset associated with the email send activity. |
AssetType | String | The type of the asset associated with the email send activity. |
ContactId | Long | The ID of the contact who performed the email send activity. |
EmailName | String | The name of the email. Not supported in bulk mode. |
EmailWebLink | String | The Web link of the email. |
EmailRecipientId | String | The ID of the recipient of the email. |
SubjectLine | String | The subject line of the email. |
EmailAddress | String | The address of the email. Only supported in bulk mode. |
EmailSendType | String | The send type of the email. Only supported in bulk mode. |
CampaignId | Long | The ID of the campaign associated with the email send activity. Only supported in bulk mode. |
DeploymentId | Long | The deployment ID associated with the email send activity. Only supported in bulk mode. |
FirstName | String | The FirstName of the contact associated with the email send activity. |
LastName | String | The LastName of the contact associated with the email send activity. |
Company | String | The Company of the contact associated with the email send activity. |
City | String | The City of the contact associated with the email send activity. |
ContactCreatedAt | Datetime | The date and time the contact associated with the email send activity was created. |
ContactModifiedAt | Datetime | The date and time the contact associated with the email send activity was created. |
Address1 | String | The first line address of the contact associated with the email send activity. |
Address2 | String | The second line address of the contact associated with the email send activity. |
Title | String | The Title of the contact associated with the email send activity. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
ExportToken | String | The token returned from CreateExportDefinition. If Eloqua has not finished processing the request, the query will wait until the server has finished before returning data. |
Depth | String | The depth of information requested from Eloqua. |
Activity_EmailSubscribe¶
Retrieve Email Subscribe Activities.
Table Specific Information¶
Select¶
If you are not using the Bulk API, ContactId is required to query Activity tables.
Additionally, the COUNT function is supported for this table in bulk mode.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier of the email subscribe activity. |
Name | String | The name of the email subscribe activity. Not supported in bulk mode. |
CreatedAt | Datetime | The date and time the email subscribe activity was created. |
Type | String | The activity type of the email subscribe activity. |
AssetName | String | The name of the asset associated with the email subscribe activity. |
AssetId | Long | The ID of the asset associated with the email subscribe activity. |
AssetType | String | The type of the asset associated with the email subscribe activity. |
CampaignName | String | The name of the campaign associated with the email subscribe activity. Not supported in bulk mode. |
EmailCampaignId | String | The ID of the email campaign associated with the email subscribe activity. Not supported in bulk mode. |
EmailAddress | String | The address of the email. Only supported in bulk mode. |
EmailRecipientId | String | The ID of the recipient of the email. |
CampaignId | Long | The ID of the campaign associated with the email subscribe activity. Only supported in bulk mode. |
ExternalId | String | The ExternalId associated with the email subscribe activity. Only supported in bulk mode. |
ContactId | Long | The ID of the contact associated with the bounceback activity. |
FirstName | String | The FirstName of the contact associated with the email subscribe activity. |
LastName | String | The LastName of the contact associated with the email subscribe activity. |
Company | String | The Company of the contact associated with the email subscribe activity. |
City | String | The City of the contact associated with the email subscribe activity. |
ContactCreatedAt | Datetime | The date and time the contact associated with the email subscribe activity was created. |
ContactModifiedAt | Datetime | The date and time the contact associated with the email subscribe activity was created. |
Address1 | String | The first line address of the contact associated with the email subscribe activity. |
Address2 | String | The second line address of the contact associated with the email subscribe activity. |
Title | String | The Title of the contact associated with the email subscribe activity. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
ExportToken | String | The token returned from CreateExportDefinition. If Eloqua has not finished processing the request, the query will wait until the server has finished before returning data. |
Depth | String | The depth of information requested from Eloqua. |
Activity_EmailUnsubscribe¶
Retrieve Email Unsubscribe Activities.
Table Specific Information¶
Select¶
If you are not using the Bulk API, ContactId is required to query Activity tables.
Additionally, the COUNT function is supported for this table in bulk mode.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier of the email unsubscribe activity. |
Name | String | The name of the email unsubscribe activity. Not supported in bulk mode. |
CreatedAt | Datetime | The date and time the email unsubscribe activity was created. |
Type | String | The type of email unsubscribe activity. |
AssetName | String | The name of the asset associated with the email unsubscribe activity. |
AssetId | Long | The ID of the asset associated with the email unsubscribe activity. |
AssetType | String | The type of the asset associated with the email unsubscribe activity. |
CampaignName | String | The name of the campaign associated with the email unsubscribe activity. Not supported in bulk mode. |
EmailCampaignId | String | The ID of the email campaign associated with the email unsubscribe activity. Not supported in bulk mode. |
EmailRecipientId | String | The ID of the recipient of the email. |
EmailAddress | String | The address of the email. Only supported in bulk mode. |
CampaignId | Long | The ID of the campaign associated with the email unsubscribe activity. Only supported in bulk mode. |
ExternalId | String | The ExternalId associated with the email unsubscribe activity. Only supported in bulk mode. |
ContactId | Long | The ID of the contact associated with the bounceback activity. |
FirstName | String | The FirstName of the contact associated with the email unsubscribe activity. |
LastName | String | The LastName of the contact associated with the email unsubscribe activity. |
Company | String | The Company of the contact associated with the email unsubscribe activity. |
City | String | The City of the contact associated with the email unsubscribe activity. |
ContactCreatedAt | Datetime | The date and time the contact associated with the email unsubscribe activity was created. |
ContactModifiedAt | Datetime | The date and time the contact associated with the email unsubscribe activity was created. |
Address1 | String | The first line address of the contact associated with the email unsubscribe activity. |
Address2 | String | The second line address of the contact associated with the email unsubscribe activity. |
Title | String | The Title of the contact associated with the email unsubscribe activity. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
ExportToken | String | The token returned from CreateExportDefinition. If Eloqua has not finished processing the request, the query will wait until the server has finished before returning data. |
Depth | String | The depth of information requested from Eloqua. |
Activity_FormSubmit¶
Retrieve Form Submit Activities.
Table Specific Information¶
Select¶
If you are not using the Bulk API, ContactId is required to query Activity tables.
Additionally, the COUNT function is supported for this table in bulk mode.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier of the form submit activity. |
Name | String | The name of the form submit activity. Not supported in bulk mode. |
CreatedAt | Datetime | The date and time the form submit activity was created. |
Type | String | The activity type of the form submit activity. |
AssetName | String | The name of the asset associated with the form submit activity. |
AssetId | Long | The ID of the asset associated with the form submit activity. |
AssetType | String | The type of the asset associated with the form submit activity. |
ContactId | Long | The ID of the contact who performed the form submit activity. |
Collection | String | The collection of the form submit activity. Not supported in bulk mode. |
FormName | String | The name of the form associated with the form submit activity. Not supported in bulk mode. |
FormData | String | The data of the form associated with the form submit activity. Not supported in bulk mode. |
RawData | String | The raw data of the form submit activity. Only supported in bulk mode. |
CampaignId | Long | The ID of the campaign associated with the form submit activity. Only supported in bulk mode. |
VisitorId | Long | The ID of the visitor associated with the form submit activity. Only supported in bulk mode. |
VisitorExternalId | String | The ExternalId of the visitor associated with the form submit activity. Only supported in bulk mode. |
ExternalId | String | The ExternalId associated with the form submit activity. Only supported in bulk mode. |
FirstName | String | The FirstName of the contact associated with the form submit activity. |
LastName | String | The LastName of the contact associated with the form submit activity. |
Company | String | The Company of the contact associated with the form submit activity. |
City | String | The City of the contact associated with the bounceback activity. |
ContactCreatedAt | Datetime | The date and time the contact associated with the form submit activity was created. |
ContactModifiedAt | Datetime | The date and time the contact associated with the form submit activity was created. |
Address1 | String | The first line address of the contact associated with the form submit activity. |
Address2 | String | The second line address of the contact associated with the form submit activity. |
Title | String | The Title of the contact associated with the form submit activity. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
ExportToken | String | The token returned from CreateExportDefinition. If Eloqua has not finished processing the request, the query will wait until the server has finished before returning data. |
Depth | String | The depth of information requested from Eloqua. |
Activity_PageView¶
Retrieve Page View Activities. This table is only supported in bulk mode.
Table Specific Information¶
Select¶
COUNT is supported for this table.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier of the page view activity. |
CreatedAt | Datetime | The date and time the page view activityactivity was created. |
Type | String | The type of the activity associated with the page view activity. |
ContactId | Long | The ID of the contact who performed the page view activity. |
IPAddress | String | The IP address of the sender. |
Url | String | The URL of the page view activity. |
CampaignId | Long | The ID of the campaign associated with the page view activity. |
ReferrerUrl | String | The referrer URL of the page view activity. |
VisitorId | Long | The visitor ID of the page view activity. |
VisitorExternalId | String | The visitor external ID of the page view activity. |
WebVisitId | Long | The Web visit ID of the page view activity. |
IsWebTrackingOptedIn | Boolean | Whether the visitor who performed the page view activity has opted into Web tracking. |
ExternalId | String | The ExternalId associated with the page activity. Only supported in bulk mode. |
FirstName | String | The FirstName of the contact associated with the page view activity. |
LastName | String | The LastName of the contact associated with the page view activity. |
Company | String | The Company of the contact associated with the page view activity. |
City | String | The City of the contact associated with the page view activity. |
ContactCreatedAt | Datetime | The date and time the contact associated with the page view activity was created. |
ContactModifiedAt | Datetime | The date and time the contact associated with the page view activity was created. |
Address1 | String | The first line address of the contact associated with the page view activity. |
Address2 | String | The second line address of the contact associated with the page view activity. |
Title | String | The Title of the contact associated with the page view activity. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
ExportToken | String | The token returned from CreateExportDefinition. If Eloqua has not finished processing the request, the query will wait until the server has finished before returning data. |
Depth | String | The depth of information requested from Eloqua. |
Activity_WebVisit¶
Retrieve Web Visit Activities.
Table Specific Information¶
Select¶
If you are not using the Bulk API, ContactId is required to query Activity tables.
Additionally, the COUNT function is supported for this table in bulk mode.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The ID of the Web visit activity. |
Name | String | The name of the Web visit activity. Not supported in bulk mode. |
CreatedAt | Datetime | The date and time the Web visit activity was created. |
Type | String | The type of Web visit activity. |
AssetId | Long | The ID of the asset associated with the Web visit activity. Not supported in bulk mode. |
AssetType | String | The type of the asset associated with the Web visit activity. Not supported in bulk mode. |
ContactId | Long | The ID of the contact who performed the Web visit activity. Not supported in bulk mode. |
Duration | String | The duration of the Web visit activity. |
QueryString | String | The query string of the Web visit activity. Not supported in bulk mode. |
QueryStringDisplay | String | The query string display of the Web visit activity. Not supported in bulk mode. |
Thread | String | The thread of the Web visit activity. Not supported in bulk mode. |
URL | String | The URL of the Web visit activity. Not supported in bulk mode. |
ReferrerUrl | String | The Referrer URL of the Web visit activity. Only supported in bulk mode. |
VisitorId | Long | The ID of the visitor associated with the Web visit activity. Only supported in bulk mode. |
VisitorExternalId | String | The visitor external ID of the Web visit activity. Only supported in bulk mode. |
ExternalId | String | The ExternalId associated with the Web visit activity. Only supported in bulk mode. |
NumberOfPages | String | The number of pages of the Web visit activity. Only supported in bulk mode. |
IpAddress | String | The IP address of the Web visit activity. Only supported in bulk mode. |
FirstPageViewUrl | String | The first page view URL of the Web visit activity. Only supported in bulk mode. |
FirstName | String | The FirstName of the contact associated with the Web visit activity. |
LastName | String | The LastName of the contact associated with the Web visit activity. |
Company | String | The Company of the contact associated with the Web visit activity. |
City | String | The City of the contact associated with the Web visit activity. |
ContactCreatedAt | Datetime | The date and time the contact associated with the Web visit activity was created. |
ContactModifiedAt | Datetime | The date and time the contact associated with the Web visit activity was created. |
Address1 | String | The first line address of the contact associated with the Web visit activity. |
Address2 | String | The second line address of the contact associated with the Web visit activity. |
Title | String | The Title of the contact associated with the Web visit activity. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
ExportToken | String | The token returned from CreateExportDefinition. If Eloqua has not finished processing the request, the query will wait until the server has finished before returning data. |
Depth | String | The depth of information requested from Eloqua. |
CampaignElement¶
Retrieve Campaign Elements.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the campaign element. |
Name | String | The name of the campaign element. |
Type | String | The type of the campaign element. |
FolderId | Long | The folder ID of the campaign element. |
FormId | String | The form ID of the campaign element. |
EmailId | String | The email ID of the campaign element. |
LandingPageId | String | The landing page ID of the campaign element. |
SegmentId | String | The segment ID of the campaign element. |
ListId | String | The list ID of the campaign element. |
CampaignId | String | The campaign ID of the campaign element. |
memberCount | Integer | The member count of the campaign element. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
CampaignField¶
Retrieve Campaign Fields.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the campaign field. |
Name | String | The name of the campaign field. |
DataType | String | The data type of the campaign field. |
Description | String | The description of the campaign field. |
DisplayType | String | The display type of the campaign field. |
DisplayIndex | String | The display index of the campaign field. |
FolderId | Long | The folder ID of the campaign field. |
IsReadOnly | Boolean | Identifies whether the campaign field is read-only. |
IsRequired | Boolean | Identifies whether the campaign field is required. |
CreatedAt | Datetime | Date the campaign field was created. |
CreatedBy | String | The ID of the user who created the campaign field. |
Depth | String | The depth of the campaign field. |
CampaignFolder¶
Retrieve Campaign Folders.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the folder. |
Name | String | The name of the folder. |
IsSystem | Boolean | Identifies a system-generated folder. |
Description | String | The description of the folder. |
Permissions | String | The permissions of the folder. |
CreatedAt | Datetime | Date the folder was created. |
CreatedBy | String | The ID of the user who created the folder. |
AccessedAt | Datetime | Date the folder was accessed. |
CurrentStatus | String | The current status of the folder. |
UpdatedAt | Datetime | Date the folder was last updated. |
UpdatedBy | String | The ID of the user who last updated the folder. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
ContactField¶
Retrieve Contact Fields.
Table Specific Information¶
The EmailAddress column is required to INSERT INTO or to update the Contact table. For example,
UPDATE [Contact] SET emailAddress = 'example@test.com', firstName = 'test' WHERE ID = ?
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the contact field. |
Name | String | The name of the contact field. |
UpdateType | String | The update rule for when to update this field. |
CheckedValue | String | The checked value of the contact field. |
DataType | String | The data type of the contact field. |
DefaultValue | String | The default value for the contact field. |
Description | String | The description of the contact field. |
DisplayType | String | The display type of the contact field. |
FolderId | Long | The folder ID of the contact field. |
InternalName | String | The country of the contact field. |
IsReadOnly | Boolean | Identifies whether the contact field is read-only. |
IsRequired | Boolean | Identifies whether the contact field is required. |
IsStandard | Boolean | Identifies whether the contact field is standard. |
OptionListId | Long | The ID of the option list for the contact field. |
OutputFormatId | Long | The ID of the output format for the contact field. |
ScheduledFor | String | The date and time scheduled for the contact field. |
SourceTemplatedId | Long | The ID of the source template for the contact field |
UncheckedValue | String | The unchecked value of the contact field. |
Permissions | String | The permissions of the contact field. |
CreatedAt | Datetime | Date the contact field was created. |
CreatedBy | String | The ID of the user who created the contact field. |
AccessedAt | Datetime | Date the contact field was accessed. |
CurrentStatus | String | The current status of the contact field. |
Depth | String | The depth of the contact field. |
UpdatedAt | Datetime | Date the contact field was updated. |
UpdatedBy | String | The ID of the user who last updated the contact field. |
ContactFilter¶
Retrieve Contact Filters.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the contact filter. |
Name | String | The name of the contact filter. |
Type | String | The type of the contact filter. |
FolderId | Long | The folder ID of the contact filter. |
Description | String | The description of the contact filter. |
ScheduledFor | String | The date and time scheduled for the contact filter. |
Scope | String | The scope of the contact filter. |
Statement | String | The statement of the contact filter. |
Permissions | String | The permissions of the contact filter. |
CreatedAt | Datetime | Date the contact filter was created. |
CreatedBy | String | The ID of the user who created the contact filter. |
AccessedAt | Datetime | Date the contact filter field was accessed. |
CurrentStatus | String | The current status of the contact filter. |
Depth | String | The depth of the contact filter. |
UpdatedAt | Datetime | Date the contact filter was updated. |
UpdatedBy | String | The ID of the user who last updated the contact filter. |
ContactFilterFolder¶
Retrieve Contact Filter Folders.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the folder. |
Name | String | The name of the folder. |
IsSystem | Boolean | Identifies a system-generated folder. |
Description | String | The description of the folder. |
Permissions | String | The permissions of the folder. |
CreatedAt | Datetime | Date the folder was created. |
CreatedBy | String | The ID of the user who created the folder. |
AccessedAt | Datetime | Date the folder was accessed. |
CurrentStatus | String | The current status of the folder. |
UpdatedAt | Datetime | Date the folder was last updated. |
UpdatedBy | String | The ID of the user who last updated the folder. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
ContactList¶
Create, update, delete, and query Contact Lists.
Table Specific Information¶
Select¶
The following limitation exists for filtering on datetime columns: The "=" operator cannot be used with datetime columns in the WHERE clause. However, the "<", ">", ">=", and "<=" operators can be used to filter on datetime columns.
Additionally, the UpdatedAt column only supports filtering with the '>' operator.
Oracle Eloqua also has limited support on multiple conditions. In many tables the AND condition between filters is not supported. If AND is included the server might not return any results, nor will it return an error.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the contact list. |
Name | String | The name of the contact list. |
Count | String | The count of the contact list. |
DataLookupId | String | The ID of the data lookup for the contact list. |
MembershipAdditions | String | The number of contact membership additions in the contact list. |
Scope | String | The contact list's scope: either local or global. |
Description | String | The description of the contact list. |
FolderId | Long | The ID of the folder for the contact list. |
ScheduledFor | Datetime | The date and time scheduled for the contact list. |
SourceTemplatedId | Long | The ID of the source template of the contact list. |
Permissions | String | The permissions of the contact list. |
CreatedAt | Datetime | Date the contact list was created. |
CreatedBy | String | The ID of the user who created the contact list. |
AccessedAt | Datetime | Date the contact list was accessed. |
CurrentStatus | String | The current status of the contact list. |
Depth | String | The depth of the contact list. |
UpdatedAt | Datetime | Date the contact list was updated. |
UpdatedBy | String | The ID of the user who created the contact list. |
ContactListFolder¶
Retrieve Contact List Folders.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the folder. |
Name | String | The name of the folder. |
IsSystem | Boolean | Identifies a system-generated folder. |
Description | String | The description of the folder. |
Permissions | String | The permissions of the folder. |
CreatedAt | Datetime | Date the folder was created. |
CreatedBy | String | The ID of the user who created the folder. |
AccessedAt | Datetime | Date the folder was accessed. |
CurrentStatus | String | The current status of the folder. |
UpdatedAt | Datetime | Date the folder was last updated. |
UpdatedBy | String | The ID of the user who last updated the folder. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
ContactScoringModelFolder¶
Retrieve Contact Scoring Model Folders.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the folder. |
Name | String | The name of the folder. |
IsSystem | Boolean | Identifies a system-generated folder. |
Description | String | The description of the folder. |
Permissions | String | The permissions of the folder. |
CreatedAt | Datetime | Date the folder was created. |
CreatedBy | String | The ID of the user who created the folder. |
AccessedAt | Datetime | Date the folder was accessed. |
CurrentStatus | String | The current status of the folder. |
UpdatedAt | Datetime | Date the folder was last updated. |
UpdatedBy | String | The ID of the user who last updated the folder. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
ContactSegmentData¶
Retrieve Contact Segment Data. Note: The pseudo column SegmentID must be specified to retrieve the data of this table. This SegmentID can be retrieved from the ContactSegment table's ID column.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Int64 | The unique identifier of the content segment data. |
AccountName | String | This field is generated dynamically and corresponds to the AccountName field in the API. |
BouncebackDate | String | This field is generated dynamically and corresponds to the BouncebackDate field in the API. |
IsBounceback | Boolean | This field is generated dynamically and corresponds to the IsBounceback field in the API. |
IsSubscribed | Boolean | This field is generated dynamically and corresponds to the IsSubscribed field in the API. |
SubscriptionDate | Datetime | This field is generated dynamically and corresponds to the SubscriptionDate field in the API. |
UnsubscriptionDate | Datetime | This field is generated dynamically and corresponds to the UnsubscriptionDate field in the API. |
CreatedAt | Datetime | This field is generated dynamically and corresponds to the CreatedAt field in the API. |
CreatedBy | String | This field is generated dynamically and corresponds to the CreatedBy field in the API. |
AccessedAt | Datetime | This field is generated dynamically and corresponds to the AccessedAt field in the API. |
CurrentStatus | String | This field is generated dynamically and corresponds to the CurrentStatus field in the API. |
Depth | String | This field is generated dynamically and corresponds to the Depth field in the API. |
UpdatedAt | Datetime | This field is generated dynamically and corresponds to the UpdatedAt field in the API. |
UpdatedBy | String | This field is generated dynamically and corresponds to the UpdatedBy field in the API. |
Email Address | String | This field is generated dynamically and corresponds to the Email Address field in the API. |
First Name | String | This field is generated dynamically and corresponds to the First Name field in the API. |
Last Name | String | This field is generated dynamically and corresponds to the Last Name field in the API. |
Company | String | This field is generated dynamically and corresponds to the Company field in the API. |
Email Display Name | String | This field is generated dynamically and corresponds to the Email Display Name field in the API. |
Address 1 | String | This field is generated dynamically and corresponds to the Address 1 field in the API. |
Address 2 | String | This field is generated dynamically and corresponds to the Address 2 field in the API. |
Address 3 | String | This field is generated dynamically and corresponds to the Address 3 field in the API. |
City | String | This field is generated dynamically and corresponds to the City field in the API. |
State or Province | String | This field is generated dynamically and corresponds to the State or Province field in the API. |
Zip or Postal Code | String | This field is generated dynamically and corresponds to the Zip or Postal Code field in the API. |
Country | String | This field is generated dynamically and corresponds to the Country field in the API. |
Business Phone | String | This field is generated dynamically and corresponds to the Business Phone field in the API. |
Mobile Phone | String | This field is generated dynamically and corresponds to the Mobile Phone field in the API. |
Fax | String | This field is generated dynamically and corresponds to the Fax field in the API. |
Title | String | This field is generated dynamically and corresponds to the Title field in the API. |
Salutation | String | This field is generated dynamically and corresponds to the Salutation field in the API. |
Salesperson | String | This field is generated dynamically and corresponds to the Salesperson field in the API. |
SFDC Contact ID | String | This field is generated dynamically and corresponds to the SFDC Contact ID field in the API. |
SFDC Lead ID | String | This field is generated dynamically and corresponds to the SFDC Lead ID field in the API. |
Date Created | Datetime | This field is generated dynamically and corresponds to the Date Created field in the API. |
Date Modified | Datetime | This field is generated dynamically and corresponds to the Date Modified field in the API. |
Eloqua Contact ID | String | This field is generated dynamically and corresponds to the Eloqua Contact ID field in the API. |
SFDC Account ID | String | This field is generated dynamically and corresponds to the SFDC Account ID field in the API. |
Last Modified by CRM System | Datetime | This field is generated dynamically and corresponds to the Last Modified by CRM System field in the API. |
Last SFDC Campaign ID | String | This field is generated dynamically and corresponds to the Last SFDC Campaign ID field in the API. |
Last SFDC Campaign Status | String | This field is generated dynamically and corresponds to the Last SFDC Campaign Status field in the API. |
Company Revenue | String | This field is generated dynamically and corresponds to the Company Revenue field in the API. |
SFDC Email Opt Out | String | This field is generated dynamically and corresponds to the SFDC Email Opt Out field in the API. |
Lead Source - Most Recent | String | This field is generated dynamically and corresponds to the Lead Source - Most Recent field in the API. |
Lead Source - Original | String | This field is generated dynamically and corresponds to the Lead Source - Original field in the API. |
Industry | String | This field is generated dynamically and corresponds to the Industry field in the API. |
Annual Revenue | String | This field is generated dynamically and corresponds to the Annual Revenue field in the API. |
Lead Status | String | This field is generated dynamically and corresponds to the Lead Status field in the API. |
Job Role | String | This field is generated dynamically and corresponds to the Job Role field in the API. |
Lead Score - High Value Website Content | Double | This field is generated dynamically and corresponds to the Lead Score - High Value Website Content field in the API. |
Lead Score Date - Engagement - Most Recent | Datetime | This field is generated dynamically and corresponds to the Lead Score Date - Engagement - Most Recent field in the API. |
Integrated Marketing and Sales Funnel Stage | String | This field is generated dynamically and corresponds to the Integrated Marketing and Sales Funnel Stage field in the API. |
Product/Solution of Interest | String | This field is generated dynamically and corresponds to the Product/Solution of Interest field in the API. |
Region | String | This field is generated dynamically and corresponds to the Region field in the API. |
PURL Name (Default Hypersite) | String | This field is generated dynamically and corresponds to the PURL Name (Default Hypersite) field in the API. |
Lead Rating - Combined | String | This field is generated dynamically and corresponds to the Lead Rating - Combined field in the API. |
Email Address Domain | String | This field is generated dynamically and corresponds to the Email Address Domain field in the API. |
First and Last Name | String | This field is generated dynamically and corresponds to the First and Last Name field in the API. |
Company Size | String | This field is generated dynamically and corresponds to the Company Size field in the API. |
Lead Score - Last High Touch Event Date | Datetime | This field is generated dynamically and corresponds to the Lead Score - Last High Touch Event Date field in the API. |
Lead Rating - Profile (Explicit) | String | This field is generated dynamically and corresponds to the Lead Rating - Profile (Explicit) field in the API. |
Lead Rating - Engagement (Implicit) | String | This field is generated dynamically and corresponds to the Lead Rating - Engagement (Implicit) field in the API. |
Lead Score - Profile (Explicit) | Double | This field is generated dynamically and corresponds to the Lead Score - Profile (Explicit) field in the API. |
Lead Score - Engagement (Implicit) | Double | This field is generated dynamically and corresponds to the Lead Score - Engagement (Implicit) field in the API. |
Lead Score Date - Profile - Most Recent | Datetime | This field is generated dynamically and corresponds to the Lead Score Date - Profile - Most Recent field in the API. |
Employees | Double | This field is generated dynamically and corresponds to the Employees field in the API. |
Territory | String | This field is generated dynamically and corresponds to the Territory field in the API. |
Lead Score | String | This field is generated dynamically and corresponds to the Lead Score field in the API. |
PURL Name | String | This field is generated dynamically and corresponds to the PURL Name field in the API. |
MD5 Hashed Email Address | String | This field is generated dynamically and corresponds to the MD5 Hashed Email Address field in the API. |
SHA256 Hashed Email Address | String | This field is generated dynamically and corresponds to the SHA256 Hashed Email Address field in the API. |
MD5 Hashed Business Phone | String | This field is generated dynamically and corresponds to the MD5 Hashed Business Phone field in the API. |
SHA256 Hashed Business Phone | String | This field is generated dynamically and corresponds to the SHA256 Hashed Business Phone field in the API. |
MD5 Hashed Mobile Phone | String | This field is generated dynamically and corresponds to the MD5 Hashed Mobile Phone field in the API. |
SHA256 Hashed Mobile Phone | String | This field is generated dynamically and corresponds to the SHA256 Hashed Mobile Phone field in the API. |
onlineInsertTest | String | This field is generated dynamically and corresponds to the onlineInsertTest field in the API. |
Survey Initial Meeting Date & Time | Datetime | This field is generated dynamically and corresponds to the Survey Initial Meeting Date & Time field in the API. |
TestColumn1 | String | This field is generated dynamically and corresponds to the TestColumn1 field in the API. |
TestColumn2 | String | This field is generated dynamically and corresponds to the TestColumn2 field in the API. |
TestColumn3 | String | This field is generated dynamically and corresponds to the TestColumn3 field in the API. |
TestColumn4 | String | This field is generated dynamically and corresponds to the TestColumn4 field in the API. |
TestColumn5 | String | This field is generated dynamically and corresponds to the TestColumn5 field in the API. |
ContactSegmentFolder¶
Retrieve Contact Segment Folders.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the folder. |
Name | String | The name of the folder. |
IsSystem | Boolean | Identifies a system-generated folder. |
Description | String | The description of the folder. |
Permissions | String | The permissions of the folder. |
CreatedAt | Datetime | Date the folder was created. |
CreatedBy | String | The ID of the user who created the folder. |
AccessedAt | Datetime | Date the folder was accessed. |
CurrentStatus | String | The current status of the folder. |
UpdatedAt | Datetime | Date the folder was last updated. |
UpdatedBy | String | The ID of the user who last updated the folder. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
ContactView¶
Retrieve Contact Views.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the contact view. |
Name | String | The name of the contact view. |
Description | String | The description of the contact view. |
Permissions | String | The permissions of the contact view. |
CreatedAt | Datetime | Date the contact view was created. |
CreatedBy | String | The ID of the user who created the contact view. |
AccessedAt | Datetime | Date the contact view was accessed. |
UpdatedAt | Datetime | Date the contact view was updated. |
UpdatedBy | String | The ID of the user who last updated the contact view. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
ContentSectionFolder¶
Retrieve Content Section Folders.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the folder. |
Name | String | The name of the folder. |
IsSystem | Boolean | Identifies a system-generated folder. |
Description | String | The description of the folder. |
Permissions | String | The permissions of the folder. |
CreatedAt | Datetime | Date the folder was created. |
CreatedBy | String | The ID of the user who created the folder. |
AccessedAt | Datetime | Date the folder was accessed. |
CurrentStatus | String | The current status of the folder. |
UpdatedAt | Datetime | Date the folder was last updated. |
UpdatedBy | String | The ID of the user who last updated the folder. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
Dependencies¶
Retrieve Dependencies.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | TBD. |
Name | String | TBD. |
Permissions | String | The permissions of the contact list. |
Depth | String | The depth of the field. |
Type | String | The type of the field. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
ObjectName | String | TDB |
ObjectId | String | TBD |
DynamicContent¶
Retrieve Dynamic Contents.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the dynamic content. |
Name | String | The name of the dynamic content. |
Description | String | The description of the dynamic content. |
FolderId | Long | The ID of the folder for the dynamic content. |
ScheduledFor | Datetime | The date and time scheduled for the dynamic content. |
SourceTemplatedId | Long | The ID of the source template of the dynamic content. |
Permissions | String | The permissions of the dynamic content. |
CreatedAt | Datetime | Date the dynamic content was created. |
CreatedBy | String | The ID of the user who created the dynamic content. |
AccessedAt | Datetime | Date the dynamic content was accessed. |
CurrentStatus | String | The current status of the dynamic content. |
UpdatedAt | Datetime | Date the dynamic content was last updated. |
UpdatedBy | String | The ID of the user who last updated the dynamic content. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
DynamicContentFolder¶
Retrieve Dynamic Content Folders.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the folder. |
Name | String | The name of the folder. |
IsSystem | Boolean | Identifies a system-generated folder. |
Description | String | The description of the folder. |
Permissions | String | The permissions of the folder. |
CreatedAt | Datetime | Date the folder was created. |
CreatedBy | String | The ID of the user who created the folder. |
AccessedAt | Datetime | Date the folder was accessed. |
CurrentStatus | String | The current status of the folder. |
UpdatedAt | Datetime | Date the folder was last updated. |
UpdatedBy | String | The ID of the user who last updated the folder. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
EmailDeployment¶
Retrieve email deployments.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the email deployment. |
Name | String | The name of the email deployment. |
CurrentStatus | String | The current status of the email deployment. |
SuccessfulSendCount | Int | The successful send count of the email deployment. |
FailedSendCount | Int | The failed send count of the email deployment. |
ContactId | String | The contact ID of the email deployment. |
SendFromUserId | String | The sent user ID of the email deployment. |
EndAt | Datetime | Date the email deployment ended. |
Permissions | String | The permissions of the email deployment. |
Email_ID | Long | The unique identifier of the email. |
Email_Name | String | The name of the email. |
Email_EmailGroupId | Long | The ID of the email group. |
Email_IsPlainTextEditable | Boolean | Identifies whether the email is plaintext editable. |
Email_IsTracked | Boolean | Identifies whether the email is tracked. |
Email_PlainText | String | The plaintext version of the email. |
Email_BouncebackEmail | String | The bounce-back email address. |
Email_ReplyToEmail | String | The email address in the reply-to line of the email. |
Email_ReplyToName | String | The name in the reply-to line of the email. |
Email_SenderEmail | String | The email address of the sender. |
Email_SenderName | String | The name of the sender. |
Email_SendPlainTextOnly | Boolean | Identifies whether the plaintext version should be sent. |
Email_Subject | String | The subject of the email. |
Email_Description | String | The description of the email. |
Email_FolderId | Long | The ID of the folder for the email. |
Email_Permissions | String | The permissions of the email. |
Email_CreatedAt | Datetime | Date the email was created. |
Email_CreatedBy | String | The ID of the user who created the email. |
Email_CurrentStatus | String | The current status of the email. |
Email_UpdatedAt | Datetime | Date the email was updated. |
Email_UpdatedBy | String | The ID of the user who last updated the email. |
Email_HtmlContent_Type | String | The type for the content of the email. |
Email_HtmlContent_ContentSource | String | The content source for the content of the email. |
Email_HtmlContent_DocType | String | The doc type for the content of the email. |
Email_HtmlContent_HTMLBody | String | The HTML body for the content of the email. |
Email_HtmlContent_Root | String | The root for the content of the email. |
Email_HtmlContent_MetaTags | String | The meta tags for the content of the email. |
Email_HtmlContent_SystemHeader | String | The system header for the content of the email. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
EmailFolder¶
Retrieve Email Folders.
Table Specific Information¶
Select¶
The following limitation exists for filtering on datetime columns: The "=" operator cannot be used with datetime columns in the WHERE clause. However, the "<", ">", ">=", and "<=" operators can be used to filter on datetime columns.
Additionally, the UpdatedAt column only supports filtering with the '>' operator.
Oracle Eloqua also has limited support on multiple conditions. In many tables the AND condition between filters is not supported. If AND is included the server might not return any results, nor will it return an error.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the folder. |
Name | String | The name of the folder. |
IsSystem | Boolean | Identifies a system-generated folder. |
Description | String | The description of the folder. |
Permissions | String | The permissions of the folder. |
CreatedAt | Datetime | Date the folder was created. |
CreatedBy | String | The ID of the user who created the folder. |
AccessedAt | Datetime | Date the folder was accessed. |
CurrentStatus | String | The current status of the folder. |
UpdatedAt | Datetime | Date the folder was last updated. |
UpdatedBy | String | The ID of the user who last updated the folder. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
EmailFooterFolder¶
Retrieve Email Footer Folders.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the folder. |
Name | String | The name of the folder. |
IsSystem | Boolean | Identifies a system-generated folder. |
Description | String | The description of the folder. |
Permissions | String | The permissions of the folder. |
CreatedAt | Datetime | Date the folder was created. |
CreatedBy | String | The ID of the user who created the folder. |
AccessedAt | Datetime | Date the folder was accessed. |
CurrentStatus | String | The current status of the folder. |
UpdatedAt | Datetime | Date the folder was last updated. |
UpdatedBy | String | The ID of the user who last updated the folder. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
EmailHeaderFolder¶
Retrieve Email Header Folders.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the folder. |
Name | String | The name of the folder. |
IsSystem | Boolean | Identifies a system-generated folder. |
Description | String | The description of the folder. |
Permissions | String | The permissions of the folder. |
CreatedAt | Datetime | Date the folder was created. |
CreatedBy | String | The ID of the user who created the folder. |
AccessedAt | Datetime | Date the folder was accessed. |
CurrentStatus | String | The current status of the folder. |
UpdatedAt | Datetime | Date the folder was last updated. |
UpdatedBy | String | The ID of the user who last updated the folder. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
ExternalType¶
Retrieve External Types.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the external type. |
Name | String | The name of the external type. |
Description | String | The description of the external type. |
FolderId | Long | The ID of the folder for the external type. |
ScheduledFor | Datetime | The date and time scheduled for the external type. |
SourceTemplatedId | Long | The ID of the source template of the external type. |
Permissions | String | The permissions of the external type. |
CreatedAt | Datetime | Date the external type was created. |
CreatedBy | String | The ID of the user who created the external type. |
AccessedAt | Datetime | Date the external type was accessed. |
CurrentStatus | String | The current status of the external type. |
UpdatedAt | Datetime | Date the external type was updated. |
UpdatedBy | String | The ID of the user who last updated the external type. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
FieldMerge¶
Retrieve Field Merges.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the field merge. |
Name | String | The name of the field merge. |
Description | String | The description of the field merge. |
FolderId | Long | The ID of the folder for the field merge. |
ScheduledFor | Datetime | The date and time scheduled for the field merge. |
SourceTemplatedId | Long | The ID of the source template of the field merge. |
Permissions | String | The permissions of the field merge. |
CreatedAt | Datetime | Date the field merge was created. |
CreatedBy | String | The ID of the user who created the field merge. |
AccessedAt | Datetime | Date the field merge was accessed. |
CurrentStatus | String | The current status of the field merge. |
UpdatedAt | Datetime | Date the field merge was updated. |
UpdatedBy | String | The ID of the user who last updated the field merge. |
Syntax | String | The syntax of the field merge. |
DefaultValue | String | The default value of the data lookup for the field merge. |
ContactFieldId | Long | The contact field ID of the field merge. |
AccountFieldId | Long | The account field ID of the field merge. |
EventId | Long | The event ID of the field merge. |
EventFieldId | Long | The event field ID of the field merge. |
EventSessionFieldId | Long | The event session field ID of the field merge. |
MergeType | String | The merge type of the field merge. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
FieldMergeFolder¶
Retrieve Field Merge Folders.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the folder. |
Name | String | The name of the folder. |
IsSystem | Boolean | Identifies a system-generated folder. |
Description | String | The description of the folder. |
Permissions | String | The permissions of the folder. |
CreatedAt | Datetime | Date the folder was created. |
CreatedBy | String | The ID of the user who created the folder. |
AccessedAt | Datetime | Date the folder was accessed. |
CurrentStatus | String | The current status of the folder. |
UpdatedAt | Datetime | Date the folder was last updated. |
UpdatedBy | String | The ID of the user who last updated the folder. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
FormElement¶
Retrieve Form Elements.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the form element. |
CreatedFromContactFieldId | Long | The contact field ID which created the form element. |
Name | String | The name of the form element. |
Type | String | The type of the form element. |
DataType | String | The data type of the form element. |
HTMLName | String | The HTML name of the form element. |
Style | String | The style of the form element. |
Instructions | String | The instructions of the form element. |
Validations | String | The validations of the form element. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
FormId | String | TBD |
Depth | String | The depth of information requested from Eloqua. |
FormFolder¶
Retrieve Form Folders.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the folder. |
Name | String | The name of the folder. |
IsSystem | Boolean | Identifies a system-generated folder. |
Description | String | The description of the folder. |
Permissions | String | The permissions of the folder. |
CreatedAt | Datetime | Date the folder was created. |
CreatedBy | String | The ID of the user who created the folder. |
AccessedAt | Datetime | Date the folder was accessed. |
CurrentStatus | String | The current status of the folder. |
UpdatedAt | Datetime | Date the folder was last updated. |
UpdatedBy | String | The ID of the user who last updated the folder. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
FormProcessingStep¶
Retrieve Form Processing Steps.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the form processing step. |
Name | String | The name of the form processing step. |
Type | String | The type of the form processing step. |
Condition | String | The condition of the form processing step. |
execute | String | The execute of the form processing step. |
Mappings | String | The mappings of the form processing step. |
keyFieldMapping | String | The key field mapping of the form processing step. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
FormId | String | TBD |
Depth | String | The depth of information requested from Eloqua. |
HyperlinkFolder¶
Retrieve Hyperlink Folders.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the folder. |
Name | String | The name of the folder. |
IsSystem | Boolean | Identifies a system-generated folder. |
Description | String | The description of the folder. |
Permissions | String | The permissions of the folder. |
CreatedAt | Datetime | Date the folder was created. |
CreatedBy | String | The ID of the user who created the folder. |
AccessedAt | Datetime | Date the folder was accessed. |
CurrentStatus | String | The current status of the folder. |
UpdatedAt | Datetime | Date the folder was last updated. |
UpdatedBy | String | The ID of the user who last updated the folder. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
Image¶
Retrieve Image.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the image. |
Name | String | The name of the image. |
Permissions | String | The permissions of the image. |
Description | String | The description of the image. |
FolderId | Long | The folder ID of the image. |
CreatedAt | Datetime | Date the image was created. |
CreatedBy | String | The ID of the user who created the image. |
UpdatedAt | Datetime | Date the image was last updated. |
UpdatedBy | String | The ID of the user who last updated the image. |
FullImageUrl | String | The full image URL of the image. |
ThumbNailUrl | String | The thumb nail URL of the image. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
ImageFolder¶
Retrieve Image Folders.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the folder. |
Name | String | The name of the folder. |
IsSystem | Boolean | Identifies a system-generated folder. |
Description | String | The description of the folder. |
Permissions | String | The permissions of the folder. |
CreatedAt | Datetime | Date the folder was created. |
CreatedBy | String | The ID of the user who created the folder. |
AccessedAt | Datetime | Date the folder was accessed. |
CurrentStatus | String | The current status of the folder. |
UpdatedAt | Datetime | Date the folder was last updated. |
UpdatedBy | String | The ID of the user who last updated the folder. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
ImportedFile¶
Retrieve Imported Files.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the imported file. |
Name | String | The name of the imported file. |
Type | String | The type of the imported file. |
FolderId | Long | The folder ID of the imported file. |
FileName | String | The file name of the imported file. |
Link | String | The link of the imported file. |
TrackedLink | String | The tracked link of the imported file. |
Permissions | String | The permissions of the imported file. |
CreatedAt | Datetime | Date the imported file was created. |
CreatedBy | String | The ID of the user who created the imported file. |
AccessedAt | Datetime | Date the imported file was accessed. |
Depth | String | The depth of the imported file. |
UpdatedAt | Datetime | Date the imported file was updated. |
UpdatedBy | String | The ID of the user who last updated the imported file. |
ImportedFileFolder¶
Retrieve Imported File Folders.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the folder. |
Name | String | The name of the folder. |
IsSystem | Boolean | Identifies a system-generated folder. |
Description | String | The description of the folder. |
Permissions | String | The permissions of the folder. |
CreatedAt | Datetime | Date the folder was created. |
CreatedBy | String | The ID of the user who created the folder. |
AccessedAt | Datetime | Date the folder was accessed. |
CurrentStatus | String | The current status of the folder. |
UpdatedAt | Datetime | Date the folder was last updated. |
UpdatedBy | String | The ID of the user who last updated the folder. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
LandingPageFolder¶
Retrieve Landing Page Folders.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the folder. |
Name | String | The name of the folder. |
IsSystem | Boolean | Identifies a system-generated folder. |
Description | String | The description of the folder. |
Permissions | String | The permissions of the folder. |
CreatedAt | Datetime | Date the folder was created. |
CreatedBy | String | The ID of the user who created the folder. |
AccessedAt | Datetime | Date the folder was accessed. |
CurrentStatus | String | The current status of the folder. |
UpdatedAt | Datetime | Date the folder was last updated. |
UpdatedBy | String | The ID of the user who last updated the folder. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
LeadScoringModel¶
Query Lead Scoring Models.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Integer | The unique identifier for the landing page. |
Name | String | The name of the landing page. |
Status | String | The status of the lead scoring model. |
Rating | String | The rating of the lead scoring model. |
ProfileScore | String | The profiles core of the lead scoring model. |
EngagementScore | String | The engagement score of the lead scoring model. |
Uri | String | The URI of the lead scoring model. |
CreatedBy | String | The ID of the user who created the lead scoring model. |
UpdatedBy | String | The ID of the user who updated the lead scoring model. |
CreatedAt | Timestamp | Date the lead scoring model was created. |
UpdatedAt | Timestamp | Date the lead scoring model was updated. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
PageTag¶
Retrieve Page Tags.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the page tag. |
Name | String | The name of the page tag. |
Description | String | The description of the page tag. |
Permissions | String | The permissions of the page tag. |
CreatedAt | Datetime | Date the page tag was created. |
CreatedBy | String | The ID of the user who created the page tag. |
AccessedAt | Datetime | Date the page tag was accessed. |
CurrentStatus | String | The current status of the page tag. |
UpdatedAt | Datetime | Date the page tag was updated. |
UpdatedBy | String | The ID of the user who last updated the page tag. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
PageTagGroup¶
Retrieve Page Tag Groups.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the page tag group. |
Name | String | The name of the page tag group. |
Description | String | The description of the page tag group. |
Permissions | String | The permissions of the page tag group. |
CreatedAt | Datetime | Date the page tag group was created. |
CreatedBy | String | The ID of the user who created the page tag group. |
AccessedAt | Datetime | Date the page tag group was accessed. |
CurrentStatus | String | The current status of the page tag group. |
UpdatedAt | Datetime | Date the page tag group was updated. |
UpdatedBy | String | The ID of the user who last updated the page tag group. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
Program¶
Retrieve Programs.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the program. |
Name | String | The name of the program. |
Description | String | The description of the program. |
FolderId | Long | The ID of the folder for the program. |
ScheduledFor | Datetime | The date and time scheduled for the program. |
SourceTemplatedId | Long | The ID of the source template of the program. |
Permissions | String | The permissions of the program. |
CreatedAt | Datetime | Date the program list was created. |
CreatedBy | String | The ID of the user who created the program. |
AccessedAt | Datetime | Date the program was accessed. |
UpdatedAt | Datetime | Date the program was updated. |
UpdatedBy | String | The ID of the user who last updated the program. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
Style¶
Retrieve Styles.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the style. |
Name | String | The name of the style. |
Description | String | The description of the style. |
UpdatedAt | Datetime | Date the style was last updated. |
CreatedAt | Datetime | Date the style was created. |
Body | String | The body of the style. |
Column1 | String | Column 1 of the style. |
Column2 | String | Column 2 of the style. |
Column3 | String | Column 3 of the style. |
Footer | String | The footer of the style. |
Header | String | The header of the style. |
Headline | String | The headline of the style. |
Icon | String | The icon of the style. |
Page | String | The page of the style. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
Template¶
Retrieve Templates.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the template. |
Name | String | The name of the template. |
Description | String | The description of the template. |
FolderId | Long | The ID of the folder for the template. |
ScheduledFor | Datetime | The date and time scheduled for the template. |
SourceTemplateId | Long | The source template ID of the template. |
Permissions | String | The permissions of the template. |
CreatedAt | Datetime | Date the template was created. |
CreatedBy | String | The ID of the user who created the template. |
AccessedAt | Datetime | Date the template was accessed. |
CurrentStatus | String | The current status of the template. |
UpdatedAt | Datetime | Date the template was last updated. |
UpdatedBy | String | The ID of the user who last updated the template. |
AssetType | String | The asset type of the template. |
AssetId | Long | The asset ID of the template. |
CategoryId | Long | The category ID of the template. |
DocumentAtionTitle | String | The documentation title of the template. |
DocumentAtionUrl | String | The documentation URL of the template. |
IsContentProtected | Boolean | Identifies whether the template is content protected. |
UseThumbnail | Boolean | Identifies whether the template uses a thumbnail. |
IconUrl | String | The icon URL of the template. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
TemplateCategory¶
Retrieve Template Categories.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the template category. |
Name | String | The name of the template. |
Description | String | The description of the template category. |
FolderId | Long | The ID of the folder for the template category. |
ScheduledFor | Datetime | The date and time scheduled for the template category. |
SourceTemplateId | Long | The source template ID of the template category. |
Permissions | String | The permissions of the template category. |
CreatedAt | Datetime | Date the template category was created. |
CreatedBy | String | The ID of the user who created the template category. |
AccessedAt | Datetime | Date the template category was accessed. |
CurrentStatus | String | The current status of the template category. |
UpdatedAt | Datetime | Date the template category was updated. |
UpdatedBy | String | The ID of the user who last updated the template category. |
SiteId | Long | The site ID of the template category. |
DefaultTemplateIconUrl | String | The default template icon URL of the template category. |
IconUrl | String | The icon URL of the template category. |
Publisher | String | The publisher of the template category. |
Campaigns | Int | The campaigns of the template category. |
ContactSegments | Int | The contact segments of the template category. |
Forms | Int | The forms of the template category. |
LandingPages | Int | The landing pages of the template category. |
Emails | Int | The emails of the template category. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
TrackedUrl¶
Retrieve Tracked Urls.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for the tracked URL. |
Name | String | The name of the tracked URL. |
Description | String | The description of the tracked URL. |
FolderId | Long | The ID of the folder for the tracked URL. |
ScheduledFor | Datetime | The date and time scheduled for the tracked URL. |
SourceTemplatedId | Long | The ID of the source template of the tracked URL. |
Permissions | String | The permissions of the tracked URL. |
CreatedAt | Datetime | Date the tracked URL was created. |
CreatedBy | String | The ID of the user who created the tracked URL. |
AccessedAt | Datetime | Date the tracked URL was accessed. |
CurrentStatus | String | The current status of the tracked URL. |
Depth | String | The depth of the tracked URL. |
UpdatedAt | Datetime | Date the tracked URL was last updated. |
UpdatedBy | String | The ID of the user who last updated the tracked URL. |
Url | String | The URL of the tracked URL. |
User¶
Retrieve Users.
Table Specific Information¶
Select¶
The following limitation exists for filtering on datetime columns: The "=" operator cannot be used with datetime columns in the WHERE clause. However, the "<", ">", ">=", and "<=" operators can be used to filter on datetime columns.
Additionally, the UpdatedAt column only supports filtering with the '>' operator.
Oracle Eloqua also has limited support on multiple conditions. In many tables the AND condition between filters is not supported. If AND is included the server might not return any results, nor will it return an error.
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Long | The unique identifier for this user. |
Name | String | The name of the user. |
Company | String | The company of the user. |
Capabilities | String | The capabilities of the user. |
BetaAccess | String | The beta access flag for the user. |
DefaultAccountViewId | Long | The ID of the default account view for the user. |
DefaultContactViewId | Long | The ID of the default contact view for the user. |
EmailAddress | String | The email address of the user. |
LoggedInAt | String | When the user last logged in. |
LoginName | String | The login name of the user. |
Preferences | String | The preferences for the user. |
ProductPermissions | String | The product permissions for the user. |
TypePermissions | String | The type permissions for the user. |
ScheduledFor | Datetime | The date and time scheduled for the user. |
SourceTemplatedId | Long | The ID of the source template for the user. |
Description | String | The description of the user. |
FolderId | Long | The ID of the folder for the user. |
Permissions | String | The permissions of the user. |
CreatedAt | Datetime | Date the user was created. |
CreatedBy | String | The ID of the user that created the user. |
AccessedAt | Datetime | Date the user was accessed. |
CurrentStatus | String | The current status of the user. |
Depth | String | The depth of the user. |
UpdatedAt | Datetime | Date the user was updated. |
UpdatedBy | String | The ID of the user who last updated the user. |
Visitor¶
Retrieve Visitors.
Table Specific Information¶
Select¶
The following limitation exists for filtering on datetime columns: The "=" operator cannot be used with datetime columns in the WHERE clause. However, the "<", ">", ">=", and "<=" operators can be used to filter on datetime columns.
Additionally, the UpdatedAt column only supports filtering with the '>' operator.
Oracle Eloqua also has limited support on multiple conditions. In many tables the AND condition between filters is not supported. If AND is included the server might not return any results, nor will it return an error.
Columns¶
Name | Type | Description |
---|---|---|
VisitorId [KEY] | Long | The ID of the visitor profile. |
CreatedAt | Datetime | Date the visitor profile was created. |
V_IPAddress | String | IP address of the visitor. |
V_LastVisitDateAndTime | Datetime | Date of last visit to an Eloqua asset for this profile. |
ExternalId | String | Customer GUID for this visitor profile. |
ContactId | Long | The ID of the contact associated with this profile, if any. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
VisitorProfileField¶
Retrieve all of the visitor profile fields.
Columns¶
Name | Type | Description |
---|---|---|
Id [KEY] | Long | The ID of the visitor profile field. |
Type | String | The type of the visitor profile field. |
name | String | The name of the visitor profile field. |
DataType | String | The datatype of the visitor profile field. |
InternalName | String | The internal name of the visitor profile field. |
Length | Long | The length of the visitor profile field. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Depth | String | The depth of information requested from Eloqua. |
Stored Procedures¶
Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT/INSERT/UPDATE/DELETE operations with Oracle Eloqua.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Oracle Eloqua, along with an indication of whether the procedure succeeded or failed.
Oracle Eloqua Connector Stored Procedures¶
Name | Description |
---|---|
ClearImportDefinitions | Clears all open import definitions on a given table. |
CreateExportDefinition | Returns the token needed to retrieve data from a bulk export request. |
DeleteExportData | Delete the data stored on the Eloqua server from a bulk query request. |
GetExportDefinition | Retrieves the current state of the bulk export process on the server. |
GetOAuthAccessToken | Gets an authentication token from Eloqua. |
GetOAuthAuthorizationUrl | Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. |
GetSyncLogs | retrieve a sync's logs. |
RefreshOAuthAccessToken | Refreshes the OAuth access token used for authentication with Eloqua. |
SubscribeContacts | Subscribes a list of contacts to Email Groups. |
UnsubscribeContacts | Unsubscribes a list of contacts to Email Groups. |
ClearImportDefinitions¶
Clears all open import definitions on a given table.
Input¶
Name | Type | Description |
---|---|---|
TableName | String | The table to remove the import definitions from. |
CreateExportDefinition¶
Returns the token needed to retrieve data from a bulk export request.
Input¶
Name | Type | Description |
---|---|---|
Query | String | The SQL query used to retrieve data from a bulk table. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
ExportToken | String | The token used to retrieve data from a bulk export request. Supply this value in the WHERE clause when SELECTing data from a bulk API table. In the form 'DefinitionUrl|SyncsUrl'. |
DeleteExportData¶
Delete the data stored on the Eloqua server from a bulk query request.
Input¶
Name | Type | Description |
---|---|---|
ExportToken | String | The token returned from CreateExportDefinition |
Result Set Columns¶
Name | Type | Description |
---|---|---|
State | String | A value of 'success' indicates delete export data sucessfully. Any other state would indicate an error. |
GetExportDefinition¶
Retrieves the current state of the bulk export process on the server.
Input¶
Name | Type | Description |
---|---|---|
ExportToken | String | The token returned from CreateExportDefinition |
GetExportDefinition | String | Specifies whether to return extra metadata information. Set to false to return only the State. The default value is true. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
State | String | The current state of bulk export. A value of 'pending' or 'active' indicate Eloqua is still processing the request. A value of 'success' indicates the results are ready to be retrieved. Any other state would indicate an error. |
ExportDefinitionName | String | The name used to identify this bulk export definition. |
ExportDefinitionFields | String | The fields requested by this bulk export definition. |
ExportDefinitionFilter | String | The data filter for this bulk export definition. |
ExportDefinitionCreateAt | String | The time the bulk export definition was created. |
ExportDefinitionCreateBy | String | The user who created the bulk export definition. |
ExportDefinitionUpdateAt | String | The time the bulk export definition was last updated. |
ExportDefinitionUpdateBy | String | The user who last updated the bulk export definition. |
GetOAuthAccessToken¶
Gets an authentication token from Eloqua.
Input¶
Name | Type | Description |
---|---|---|
AuthMode | String | The type of authentication mode to use. The default value is WEB. |
CallbackUrl | String | The page to return the Exact Online app after authentication has been completed. |
GrantType | String | The type of authorization to be granted for your app. The allowed values are code, password, refresh_token. The default value is code. |
State | String | An optional value that has meaning for your App. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The OAuth access token. |
OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
ExpiresIn | String | The remaining lifetime on the access token. |
GetOAuthAuthorizationUrl¶
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps.
Input¶
Name | Type | Description |
---|---|---|
CallbackUrl | String | The page to return the user after authorization is complete. |
GrantType | String | The type of authorization to be granted for your app. The allowed values are code, password, refresh_token. |
State | String | An optional value that has meaning for your App. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
URL | String | The authorization URL. |
GetSyncLogs¶
retrieve a sync's logs.
Input¶
Name | Type | Description |
---|---|---|
SyncId | String | ID of the sync. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
SyncUri | String | The syncUri of the sync. |
Count | String | The index of the log message. |
Severity | String | The severity of the sync log. |
StatusCode | String | The statusCode of the sync log. |
Message | String | The message of the sync log. |
CreatedAt | String | The created time of the sync log. |
RefreshOAuthAccessToken¶
Refreshes the OAuth access token used for authentication with Eloqua.
Input¶
Name | Type | Description |
---|---|---|
OAuthRefreshToken | String | The refresh token returned from the original authorization code exchange. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The authentication token returned from Eloqua. This can be used in subsequent calls to other operations for this particular service. |
OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
ExpiresIn | String | The remaining lifetime on the access token. |
SubscribeContacts¶
Subscribes a list of contacts to Email Groups.
Input¶
Name | Type | Description |
---|---|---|
EmailGroupID | String | The list of Email Groups to subscribe to. The default is GlobalSubscribe. The default value is GlobalSubscribe. |
ContactIDs | String | The list of Contacts to subscribe to the groups. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
State | String | The current state of bulk export. A value of 'pending' or 'active' indicate Eloqua is still processing the request. A value of 'success' indicates the results are ready to be retrieved. Any other state would indicate an error. |
UnsubscribeContacts¶
Unsubscribes a list of contacts to Email Groups.
Input¶
Name | Type | Description |
---|---|---|
EmailGroupID | String | The list of Email Groups to subscribe to. The default is GlobalSubscribe The default value is GlobalSubscribe. |
ContactIDs | String | The list of Contacts to subscribe to the groups. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
State | String | The current state of bulk export. A value of 'pending' or 'active' indicate Eloqua is still processing the request. A value of 'success' indicates the results are ready to be retrieved. Any other state would indicate an error. |
System Tables¶
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
Schema Tables¶
The following tables return database metadata for Oracle Eloqua:
- sys_catalogs: Lists the available databases.
- sys_schemas: Lists the available schemas.
- sys_tables: Lists the available tables and views.
- sys_tablecolumns: Describes the columns of the available tables and views.
- sys_procedures: Describes the available stored procedures.
- sys_procedureparameters: Describes stored procedure parameters.
- sys_keycolumns: Describes the primary and foreign keys.
- sys_indexes: Describes the available indexes.
Data Source Tables¶
The following tables return information about how to connect to and query the data source:
- sys_connection_props: Returns information on the available connection properties.
- sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.
Query Information Tables¶
The following table returns query statistics for data modification queries:
- sys_identity: Returns information about batch operations or single updates.
sys_catalogs¶
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database name. |
sys_schemas¶
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database name. |
SchemaName | String | The schema name. |
sys_tables¶
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view. |
TableType | String | The table type (table or view). |
Description | String | A description of the table or view. |
IsUpdateable | Boolean | Whether the table can be updated. |
sys_tablecolumns¶
Describes the columns of the available tables and views.
The following query returns the columns and data types for the Contact table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Contact'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view containing the column. |
ColumnName | String | The column name. |
DataTypeName | String | The data type name. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The storage size of the column. |
DisplaySize | Int32 | The designated column's normal maximum width in characters. |
NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
IsNullable | Boolean | Whether the column can contain null. |
Description | String | A brief description of the column. |
Ordinal | Int32 | The sequence number of the column. |
IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
IsGeneratedColumn | String | Whether the column is generated. |
IsHidden | Boolean | Whether the column is hidden. |
IsArray | Boolean | Whether the column is an array. |
IsReadOnly | Boolean | Whether the column is read-only. |
IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
sys_procedures¶
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database containing the stored procedure. |
SchemaName | String | The schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure. |
Description | String | A description of the stored procedure. |
ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
sys_procedureparameters¶
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the SelectEntries stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the stored procedure. |
SchemaName | String | The name of the schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure containing the parameter. |
ColumnName | String | The name of the stored procedure parameter. |
Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
DataTypeName | String | The name of the data type. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
IsNullable | Boolean | Whether the parameter can contain null. |
IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
IsArray | Boolean | Whether the parameter is an array. |
Description | String | The description of the parameter. |
Ordinal | Int32 | The index of the parameter. |
sys_keycolumns¶
Describes the primary and foreign keys.
The following query retrieves the primary key for the Contact table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Contact'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
sys_foreignkeys¶
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
sys_primarykeys¶
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
KeySeq | String | The sequence number of the primary key. |
KeyName | String | The name of the primary key. |
sys_indexes¶
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the index. |
SchemaName | String | The name of the schema containing the index. |
TableName | String | The name of the table containing the index. |
IndexName | String | The index name. |
ColumnName | String | The name of the column associated with the index. |
IsUnique | Boolean | True if the index is unique. False otherwise. |
IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
SortOrder | String | The sort order: A for ascending or D for descending. |
OrdinalPosition | Int16 | The sequence number of the column in the index. |
sys_connection_props¶
Returns information on the available connection properties and those set in the connection string.
When querying this table, the config connection string should be used:
jdbc:cdata:oracleeloqua:config:
This connection string enables you to query this table without a valid connection.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
Columns¶
Name | Type | Description |
---|---|---|
Name | String | The name of the connection property. |
ShortDescription | String | A brief description. |
Type | String | The data type of the connection property. |
Default | String | The default value if one is not explicitly set. |
Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
Value | String | The value you set or a preconfigured default. |
Required | Boolean | Whether the property is required to connect. |
Category | String | The category of the connection property. |
IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
PropertyName | String | A camel-cased truncated form of the connection property name. |
Ordinal | Int32 | The index of the parameter. |
CatOrdinal | Int32 | The index of the parameter category. |
Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
Visible | Boolean | Informs whether the property is visible in the connection UI. |
ETC | String | Various miscellaneous information about the property. |
sys_sqlinfo¶
Describes the SELECT query processing that the connector can offload to the data source.
Discovering the Data Source's SELECT Capabilities¶
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
Name | Description | Possible Values |
---|---|---|
AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG , COUNT , MAX , MIN , SUM , DISTINCT |
COUNT | Whether COUNT function is supported. | YES , NO |
IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
SUPPORTED_OPERATORS | A list of supported SQL operators. | = , > , < , >= , <= , <> , != , LIKE , NOT LIKE , IN , NOT IN , IS NULL , IS NOT NULL , AND , OR |
GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO , NO_RELATION , EQUALS_SELECT , SQL_GB_COLLATE |
STRING_FUNCTIONS | Supported string functions. | LENGTH , CHAR , LOCATE , REPLACE , SUBSTRING , RTRIM , LTRIM , RIGHT , LEFT , UCASE , SPACE , SOUNDEX , LCASE , CONCAT , ASCII , REPEAT , OCTET , BIT , POSITION , INSERT , TRIM , UPPER , REGEXP , LOWER , DIFFERENCE , CHARACTER , SUBSTR , STR , REVERSE , PLAN , UUIDTOSTR , TRANSLATE , TRAILING , TO , STUFF , STRTOUUID , STRING , SPLIT , SORTKEY , SIMILAR , REPLICATE , PATINDEX , LPAD , LEN , LEADING , KEY , INSTR , INSERTSTR , HTML , GRAPHICAL , CONVERT , COLLATION , CHARINDEX , BYTE |
NUMERIC_FUNCTIONS | Supported numeric functions. | ABS , ACOS , ASIN , ATAN , ATAN2 , CEILING , COS , COT , EXP , FLOOR , LOG , MOD , SIGN , SIN , SQRT , TAN , PI , RAND , DEGREES , LOG10 , POWER , RADIANS , ROUND , TRUNCATE |
TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW , CURDATE , DAYOFMONTH , DAYOFWEEK , DAYOFYEAR , MONTH , QUARTER , WEEK , YEAR , CURTIME , HOUR , MINUTE , SECOND , TIMESTAMPADD , TIMESTAMPDIFF , DAYNAME , MONTHNAME , CURRENT_DATE , CURRENT_TIME , CURRENT_TIMESTAMP , EXTRACT |
REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES , NO |
DIALECT | Indicates the SQL dialect to use. | |
KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES , NO |
SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES , NO |
DATASYNCVERSION | The Data Sync version needed to access this driver. | Standard , Starter , Professional , Enterprise |
DATASYNCCATEGORY | The Data Sync category of this driver. | Source , Destination , Cloud Destination |
SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE , FALSE |
SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES , NO |
SQL_CAP | All supported SQL capabilities for this driver. | SELECT , INSERT , DELETE , UPDATE , TRANSACTIONS , ORDERBY , OAUTH , ASSIGNEDID , LIMIT , LIKE , BULKINSERT , COUNT , BULKDELETE , BULKUPDATE , GROUPBY , HAVING , AGGS , OFFSET , REPLICATE , COUNTDISTINCT , JOINS , DROP , CREATE , DISTINCT , INNERJOINS , SUBQUERIES , ALTER , MULTIPLESCHEMAS , GROUPBYNORELATION , OUTERJOINS , UNIONALL , UNION , UPSERT , GETDELETED , CROSSJOINS , GROUPBYCOLLATE , MULTIPLECATS , FULLOUTERJOIN , MERGE , JSONEXTRACT , BULKUPSERT , SUM , SUBQUERIESFULL , MIN , MAX , JOINSFULL , XMLEXTRACT , AVG , MULTISTATEMENTS , FOREIGNKEYS , CASE , LEFTJOINS , COMMAJOINS , WITH , LITERALS , RENAME , NESTEDTABLES , EXECUTE , BATCH , BASIC , INDEX |
PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES , NO |
PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE , FALSE |
REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE , FALSE |
CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
Columns¶
Name | Type | Description |
---|---|---|
NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
VALUE | String | Detail on the supported SQL or SQL syntax. |
sys_identity¶
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
Columns¶
Name | Type | Description |
---|---|---|
Id | String | The database-generated ID returned from a data modification operation. |
Batch | String | An identifier for the batch. 1 for a single operation. |
Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
Message | String | SUCCESS or an error message if the update in the batch failed. |
Advanced Configurations Properties¶
The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.
Property | Description |
---|---|
AuthScheme | The authentication scheme used. Accepted entries are Basic and OAuth. |
Company | The company of the Eloqua account. This field is used to authenticate the user. |
User | The Oracle Eloqua user account used to authenticate. |
Password | The password used to authenticate the user. |
Property | Description |
---|---|
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
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. |
OAuthAccessToken | The access token for connecting using OAuth. |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
Property | Description |
---|---|
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
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. |
Property | Description |
---|---|
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. |
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 display name for columns when using the Oracle Eloqua Bulk API. The possible settings are empty string, '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 when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | The maximum number of results to return per page from Oracle Eloqua. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
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). |
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. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
UseSimpleNames | Boolean determining if simple names should be used for tables and columns. |
Authentication¶
This section provides a complete list of authentication properties you can configure.
Property | Description |
---|---|
AuthScheme | The authentication scheme used. Accepted entries are Basic and OAuth. |
Company | The company of the Eloqua account. This field is used to authenticate the user. |
User | The Oracle Eloqua user account used to authenticate. |
Password | The password used to authenticate the user. |
AuthScheme¶
The authentication scheme used. Accepted entries are Basic and OAuth.
Possible Values¶
Basic
, OAuth
Data Type¶
string
Default Value¶
Basic
Remarks¶
The connector supports the following authentication mechanisms. See the Getting Started chapter for authentication guides.
- Basic: Set this to authenticate with a Oracle Eloqua company, user, password.
- OAuth: Set this to use oauth authentication. Set OAuthClientId, OAuthClientSecret to the Oracle Eloqua OAuth credentials. Additionally, set InitiateOAuth to GETANDREFRESH or REFRESH.
Company¶
The company of the Eloqua account. This field is used to authenticate the user.
Data Type¶
string
Default Value¶
""
Remarks¶
This field is used to provide authentication for the user to the Eloqua servers.
User¶
The Oracle Eloqua user account used to authenticate.
Data Type¶
string
Default Value¶
""
Remarks¶
Together with Password, this field is used to authenticate against the Oracle Eloqua server.
Password¶
The password used to authenticate the user.
Data Type¶
string
Default Value¶
""
Remarks¶
The User and Password
are together used to authenticate with the server.
OAuth¶
This section provides a complete list of OAuth properties you can configure.
Property | Description |
---|---|
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
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. |
OAuthAccessToken | The access token for connecting using OAuth. |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
InitiateOAuth¶
Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
Possible Values¶
OFF
, GETANDREFRESH
, REFRESH
Data Type¶
string
Default Value¶
OFF
Remarks¶
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 connector. 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 connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.
OAuthClientId¶
The client ID assigned when you register your application with an OAuth authorization server.
Data Type¶
string
Default Value¶
""
Remarks¶
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.
OAuthClientSecret¶
The client secret assigned when you register your application with an OAuth authorization server.
Data Type¶
string
Default Value¶
""
Remarks¶
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.
OAuthAccessToken¶
The access token for connecting using OAuth.
Data Type¶
string
Default Value¶
""
Remarks¶
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 user name and password. The access token protects your credentials by keeping them on the server.
CallbackURL¶
The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
Data Type¶
string
Default Value¶
""
Remarks¶
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.
OAuthVerifier¶
The verifier code returned from the OAuth authorization URL.
Data Type¶
string
Default Value¶
""
Remarks¶
The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.
Authentication on Headless Machines¶
See to obtain the OAuthVerifier
value.
Set OAuthSettingsLocation along with OAuthVerifier
. When you connect, the connector exchanges the OAuthVerifier
for the OAuth authentication tokens and saves them, encrypted, to the specified location. Set InitiateOAuth to GETANDREFRESH to automate the exchange.
Once the OAuth settings file has been generated, you can remove OAuthVerifier
from the connection properties and connect with OAuthSettingsLocation set.
To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.
OAuthRefreshToken¶
The OAuth refresh token for the corresponding OAuth access token.
Data Type¶
string
Default Value¶
""
Remarks¶
The OAuthRefreshToken
property is used to refresh the OAuthAccessToken when using OAuth authentication.
OAuthExpiresIn¶
The lifetime in seconds of the OAuth AccessToken.
Data Type¶
string
Default Value¶
""
Remarks¶
Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.
OAuthTokenTimestamp¶
The Unix epoch timestamp in milliseconds when the current Access Token was created.
Data Type¶
string
Default Value¶
""
Remarks¶
Pair with OAuthExpiresIn to determine when the AccessToken will expire.
SSL¶
This section provides a complete list of SSL properties you can configure.
Property | Description |
---|---|
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
SSLServerCert¶
The certificate to be accepted from the server when connecting using TLS/SSL.
Data Type¶
string
Default Value¶
""
Remarks¶
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 is rejected.
This property can take the following forms:
Description | Example |
---|---|
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
Schema¶
This section provides a complete list of schema properties you can configure.
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
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. |
Location¶
A path to the directory that contains the schema files defining tables, views, and stored procedures.
Data Type¶
string
Default Value¶
%APPDATA%\OracleEloqua Data Provider\Schema
Remarks¶
The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location
property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\OracleEloqua Data Provider\Schema" with %APPDATA%
being set to the user's configuration directory:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
BrowsableSchemas¶
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
Tables¶
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Views¶
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Miscellaneous¶
This section provides a complete list of miscellaneous properties you can configure.
Property | Description |
---|---|
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. |
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 display name for columns when using the Oracle Eloqua Bulk API. The possible settings are empty string, '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 when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | The maximum number of results to return per page from Oracle Eloqua. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
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). |
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. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
UseSimpleNames | Boolean determining if simple names should be used for tables and columns. |
BulkPollingInterval¶
The time interval between requests that check the availability of the bulk query response. The default value is 200 ms.
Data Type¶
string
Default Value¶
200
Remarks¶
The time interval between requests that check the availability of the bulk query response. When UseBulkAPI is set, the connector 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.
BulkQueryTimeout¶
The timeout in minutes for which the provider will wait for a bulk query response. The default value is 25 minutes.
Data Type¶
string
Default Value¶
25
Remarks¶
The timeout in minutes for which the connector will wait for a bulk query response. The default value is 25 minutes. When UseBulkAPI is set, the connector 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 connector 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. ;
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.
Data Type¶
string
Default Value¶
24
Remarks¶
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 display name for columns when using the Oracle Eloqua Bulk API. The possible settings are empty string, 'internal', and 'statement'.
Data Type¶
string
Default Value¶
""
Remarks¶
The response data Oracle Eloqua Bulk API Fields contains three kinds of displayName: "name","statement",and "internalName" for the same field.
The display name type chosen is simply a matter of visual preference.
As an example, suppose you have the following JSON response for an EmailAddress item.
{
"items":[
{
"name":"Email Address",
"internalName":"C_EmailAddress",
"dataType":"emailAddress",
"hasReadOnlyConstraint":false,
"hasNotNullConstraint":false,
"hasUniquenessConstraint":true,
"statement":"{{Contact.Field(C_EmailAddress)}}",
"uri":"/contacts/fields/100001",
"createdAt":"1900-01-01T05:00:00.0000000Z",
"updatedAt":"1900-01-01T05:00:00.0000000Z"
},
......
]
}
The column name listed upon metadata discovery from the connector will be one of the following.
- Empty String: The default value is empty string. The means the "name" of the field will be regarded as the display column name:
EmailAddress
. - internal: This means the "internalName" of the field will be regarded as the display column name:
C_EmailAddress
. - statement: It means the "statement" of the field will be regarded as the display column name:
{{Contact.Field(C_EmailAddress)}}
.
MapDataCardsCaseSensitiveMatch¶
Whether or not to use case sensitive match in data card mapping.
Data Type¶
bool
Default Value¶
false
Remarks¶
Whether or not to use case sensitive match in data card mapping. Only has an effect if MapDataCardsRelationship is set.
MapDataCardsRelationship¶
Comma-separated list of the relationships between the Custom Object tables and the Entity tables.
Data Type¶
string
Default Value¶
""
Remarks¶
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
MaxRows¶
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Data Type¶
int
Default Value¶
-1
Remarks¶
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other¶
These hidden properties are used only in specific use cases.
Data Type¶
string
Default Value¶
""
Remarks¶
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
Integration and Formatting¶
Property | Description |
---|---|
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Pagesize¶
The maximum number of results to return per page from Oracle Eloqua.
Data Type¶
int
Default Value¶
500
Remarks¶
The Pagesize
property affects the maximum number of results to return per page from Oracle Eloqua. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.
PseudoColumns¶
This property indicates whether or not to include pseudo columns as columns to the table.
Data Type¶
string
Default Value¶
""
Remarks¶
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
RetryCount¶
The maximum number of times to retry a Bulk API request that fails due to an HTTP 500 status code (Internal Server Error).
Data Type¶
string
Default Value¶
5
Remarks¶
When UseBulkAPI is set to "Auto" or "True", the connector 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 connector will retry a Bulk API request that failed. By default the connector will retry the request 5 times.
RetryInterval¶
The time interval between attempts to retry a Bulk API request that failed with an HTTP 500 status code (Internal Server Error).
Data Type¶
string
Default Value¶
200
Remarks¶
When UseBulkAPI is set to "Auto" or "True", the connector 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.
Timeout¶
The value in seconds until the timeout error is thrown, canceling the operation.
Data Type¶
int
Default Value¶
60
Remarks¶
If Timeout
= 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout
expires and the operation is not yet complete, the connector throws an exception.
UseBulkAPI¶
Whether or not the bulk API is used for retrieving data.
Possible Values¶
Auto
, False
, True
Data Type¶
string
Default Value¶
Auto
Remarks¶
Whether or not the bulk API is used for retrieving data. When UseBulkAPI
is set to "True", the connector 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 connector will use the REST API for all requests. When set to "Auto", the connector will use whichever API is most appropriate for the request. For example, consider the following query:
SELECT * FROM Activity_EmailOpen
In this case, the connector will use the Bulk API (because the ContactId is not specified), whereas the following query will use the REST API:
SELECT * FROM Activity_EmailOpen ContactId='...'
Using the Bulk API starts with the connector 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.
UserDefinedViews¶
A filepath pointing to the JSON configuration file containing your custom views.
Data Type¶
string
Default Value¶
""
Remarks¶
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json
. The connector automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews
connection property. When you use this property, only the specified views are seen by the connector.
This User Defined View configuration file is formatted as follows:
- Each root element defines the name of a view.
- Each root element contains a child element, called
query
, which contains the custom SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Contact WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews
connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json
Note that the specified path is not embedded in quotation marks.
UseSimpleNames¶
Boolean determining if simple names should be used for tables and columns.
Data Type¶
bool
Default Value¶
false
Remarks¶
Oracle Eloqua tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames
makes the connector easier to use with traditional database tools.
Setting UseSimpleNames
to true will simplify the names of tables and columns returned. It will enforce a naming scheme such that only alphanumeric characters and the underscore are valid for the displayed table and column names. Any nonalphanumeric characters will be converted to an underscore.