skip to main content
Parameters for all supported Data Store types : Oracle Marketing Cloud connection parameters
 

Try DataDirect Cloud Now

Oracle Marketing Cloud connection parameters

Note: The Oracle Marketing Cloud data store has replaced the Oracle Eloqua data store. For compatibility purposes, the Eloqua data store will remain available for this release. However, you will need to replace your current Eloqua data sources with Oracle Marketing Cloud data sources to take advantage of the latest features and support.
You define the information that DataDirect Cloud needs to connect to the data store in a data source. These default connection values are used each time you or your application connects to a particular data store. In addition to user credentials, the data store may provide other options you can use to tune performance.
The following tables describe parameters available on the General tab of a Oracle® Marketing Cloud Data Source dialog.
*General tab
*OData tab
*Mapping tab
*Advanced tab

General tab

Click the thumbnail to view the screen. Required fields are marked with an asterisk.
General tab of the Oracle Marketing Cloud data source setup dialogGeneral tab of the Oracle Marketing Cloud data source setup dialog
Table 89. General tab connection parameters for Oracle Marketing Cloud
Field
Description
Data Source Name
A unique name for this Data Source definition. Names can contain alphanumeric characters and underscores only, they cannot contain any special characters.
Description
A description of this set of connection parameters.
User Id, Password
The login credentials for your Oracle Marketing Cloud cloud data store account.
Note: By default, the password is encrypted.
By default, the characters in the Password field you type are not shown. If you want the password to be displayed in clear text, click the eye Watchful eye password button button. Click the button again to conceal the password.
In addition to the user ID and password, the company identifier must be set.
Company
The company identifier that Oracle Marketing Cloud issues after registration. For example, if your company name is My Company LLC, Oracle Marketing Cloud might issue the company identifier as mycompany.
Note: If you do not know this value, ask the person who registered the Oracle Marketing Cloud account.

OData tab

The following table describes the controls on the OData tab. For information on using the Configure Schema editor, see Enabling OData and working with Data Source groups. For information on formulating OData requests, see "Formulating queries" under Querying with OData.
Click the thumbnail to view the screen. Required fields are marked with an asterisk.
OData tabOData tab
Table 90. OData tab connection parameters for Oracle Marketing Cloud
Field
Description
Access URI
Specifies the base URI for the OData feed to access your DataDirect Cloud data source, for example, https://service.datadirectcloud.com/api/odata. You can copy the URI and paste it into your application's OData configuration.
The URI contains the case-insensitive name of the data source to connect to, and the query that you want to execute. This URI is the OData Service Root URI for the OData feed. The Service Document for the data source is returned by issuing a GET request to the data source's service root.
The OData Service Document returns the names of the entities exposed by the Data Source OData service. To get details such as the properties of the entities exposed, the data types for those properties and the relationships between entities, the Service Metadata Document can be fetched by adding /$metadata to the service root URI.
Schema Map
Enables OData support. If a schema map is not defined, the OData API cannot be used to access the data store using this Data Source definition. Use the Configure Schema editor to select the tables to expose through OData.
See Using the Configure Schema editor for more information.
Data Source Caching
Specifies whether the connection to the backend data source is cached in a session associated with the data source. Caching the back end connection improves performance when multiple OData queries are submitted to the same data source because the connection does not need to be created on every query.
Caching of the back end connection can get in the way when trying to configure a data source for OData. If a change is made to any of the DataDirect Cloud data source connection parameters, those changes will not be seen because the connection was established using the old data source definition, and was cached. The session that caches the backend connection is discarded if there is no activity to the data source for approximately 5 minutes.
When you configure a data source for OData, it is recommended that the OData session caching be disabled. Once you are satisfied with the OData configuration for the data source, enable the parameter to get the performance improvement provided by caching the connection to the backend data source.
Valid Values:
When set to 1, session caching is enabled. This provides better performance for production.
When set to 0, session caching is disabled. Use this value when you are configuring the data source.
Default: 1
Page Size
Determines the number of entities returned on each page for paging controlled on the server side. On the client side, requests can use the $top and $skip parameters to control paging. In most cases, server side paging works well for large data sets. Client side pagination works best with a smaller data sets where it is not as expensive to fetch subsequent pages.
Valid Values: 0 | n
where n is an integer from 1 to 10000.
When set to 0, the server default of 2000 is used.
Default: 0
Refresh Result
Controls what happens when you fetch the first page of a cached result when using Client Side Paging. Skip must be omitted or set to 0. You can use the cached copy of that first page, or you can re-execute the query to get a new result, discarding the previously cached result. Re-executing the query is useful when the data being fetched may change between two requests for the first page. Using the cached result is useful if you are paging back and forth through results that are not expected to change.
Valid Values:
When set to 0, the OData service caches the first page of results.
When set to 1, the OData service re-executes the query.
Default: 1
Inline Count Mode
Specifies how the connectivity service satisfies requests that include the $inlinecount parameter when it is set to allpages. These requests require the connectivity service to include the total number of entities that are defined by the OData query request. The count must be included in the first page in server-driven paging and must be included in every page when using client-driven paging.
The optimal setting depends on the data store and the size of results. The OData service can run a separate query using the count(*) aggregate to get the count, before running the query used to generate the entities. In very large results, this approach can often lead to the first page being returned faster. Alternatively, the OData service can fetch the entire result before returning the first page. This approach works well for small results and for data stores that cannot optimize the count(*) aggregate; however, it may have a longer initial response time for the first page if the result is large.
Valid Values:
When set to 1, the connectivity service runs a separate count(*) aggregate query to get the count of entities before executing the query to return results. In very large results, this approach can often lead to the first page being returned faster.
When set to 2, the connectivity service fetches all entities before returning the first page. For small results, this approach is always faster. However, the initial response time for the first page may be longer if the result is large.
Default: 2
Top Mode
Indicates how requests typically use $top and $skip for client side pagination, allowing the service to better anticipate how to process queries.
Valid Values:
Set to 0 when the application generally uses $top to limit the size of the result and rarely attempts to get additional entities by combining $top and $skip.
Set to 1 when the application uses $top as part of client-driven paging and generally combines $top and $skip to page through the result.
Default: 0
OData Read Only
Controls whether write operations can be performed on the OData service. Write operations generate a 405 Method Not Allowed response if this option is enabled.
Existing OData-enabled data sources are read only (write operations are disabled). To enable write operations for an existing OData enabled data source, clear the OData Read Only option on the OData tab. Then, on the Data Sources tab, regenerate the OData model for the data source by clicking on the OData model icon Synch completed successfully.
Valid Values:
true | false
When the check box is selected (set to true), OData access is restricted to read-only mode.
When the check box is not selected (set to false), write operations can be performed on the OData service.
Default: false

Mapping tab

To see a larger view of the screenshot of the Mapping tab, click the thumbnail; or, right-click the thumbnail and select an option to open the thumbnail in a different window or tab.
Mapping tabMapping tab
The default values for advanced mapping fields are appropriate in many cases. However, if your organization wants to strip custom prefixes or enable uppercase identifiers, you might want to change map option settings. Understanding how DataDirect Cloud creates and uses maps will help you choose the appropriate values. Watch a video.
Note: Map creation is an expensive operation. In most cases, you will only want to re-create a map if you need to change mapping options.
Click the + next to Set Map Options to display these fields.
The following table describes the mapping options that apply to Oracle Marketing Cloud.
Table 91. Mapping tab Connection Parameters for Oracle Marketing Cloud
Field
Description
Map Name
Optional name of the map definition that DataDirect Cloud uses to interpret the schema of the cloud data store. The DataDirect Cloud service automatically creates a name for the map.
Refresh Schema
The Refresh Schema checkbox specifies whether the connectivity service attempts to refresh the schema when an application first connects.
Valid Values:
When the check box is selected (set to true), the connectivity service attempts to refresh the schema.
When the check box is not selected (set to false), the connectivity service does not attempt to refresh the schema.
Default
false
Notes
*You can choose to refresh the schema by clicking the Refresh button: This refreshes the schema immediately. Note that the refresh option is available only while editing the Data Source.
*Use the checkbox to specify whether the connectivity service attempts to refresh the schema when an application first connects. Use the button if you want to refresh the schema immediately, using an already saved configuration.
*If you are making other edits to the settings, you need to click update to save your configuration. The Refresh schema button will only trigger a runtime call on the saved configuration.
Create Mapping
Determines whether the Oracle Marketing Cloud table mapping files are to be (re)created.
DataDirect Cloud automatically maps cloud data store objects and fields to tables and columns the first time that it connects to the data store. The map includes both standard and custom objects and includes any relationships defined between objects.
Table 91. Valid values for Create Map field
Value
Description
Not Exist
Select this option for most normal operations. If a map for a data source does not exist, this option causes one to be created. If a map exists, the service uses that existing map. If a name is not specified in the Map Name field, the name will be a combination of the User Name and Data Source ID.
Force New
Select this option to force creation of a new map. A map is created on connection whether one exists or not. The connectivity service uses a combination of the User Name and Data Source ID to name the map. Map creation is expensive, so you will likely not want to leave this option set to Force New indefinitely.
No
If a map for a data source does not exist, the connectivity service does not create one.
Keyword Conflict Suffix
The SQL standard and DataDirect Cloud both define keywords and reserved words. These have special meaning in context, and may not be used as identifier names unless typed in uppercase letters and enclosed in quotation marks.
For example, the Case object is a standard object present in most Salesforce organizations but CASE is also an SQL keyword. Therefore, a table named Case cannot be used in a SQL statement unless enclosed in quotes and entered in uppercase letters:
*Execution of the SQL query Select * from Case will return the following:
Error: [DataDirect][DDCloud JDBC Driver][Salesforce]Unexpected token: CASE in statement [select * from case]
*Execution of the SQL query Select * from "Case" will return the following:
Error: [DataDirect][DDCloud JDBC Driver][Salesforce]Table not found in statement [select * from "Case"]
*Execution of the SQL query, Select * from "CASE" will complete successfully.
To avoid using quotes and uppercase for table or column names that match keywords and reserved words, you can instruct DataDirect Cloud to add a suffix to such names. For example, if Keyword Conflict Suffix is set to TAB, the Case table will be mapped to a table named CASETAB. With such a suffix appended in the map, the following queries both work:
*Select * from CASETAB
*Select * from casetab
The default value is an empty string.
Check Box As Text
Specifies whether the check box values of the user-defined columns should be returned as a string or as boolean.
If set to 0, the check box value is returned as a boolean, which is described as BIT in the schema. Any values that cannot be matched to the current 'checkedValue' or 'uncheckedValue' are returned as NULL.
If set to 1, the stored literal value of the check box is returned as a string, which is described as WVARCHAR in the schema.
Fetch Option List
Determines whether the connectivity service describes the column length of option lists based on the length of their values. When enabled, Fetch List Options creates a more accurate schema map, but at the expense of slower performance when creating or refreshing a map.
Valid Values: true | false
If the check box is selected (true), the connectivity service fetches the lengths of option list values to describe the column length of option lists in the schema map. For single-option lists, the column length of an option list is set to the same length as its longest value. For multi-option lists, the column length is set to the sum of the lengths of all its values minus 1.
If the check box is not selected (false), the column length of single-option lists are set to the default length of text data type, while the column length of multi-option lists are set to VARCHAR(1000).

Advanced tab

Click the thumbnail to view the screen.
Advanced tab of the Oracle Marketing Cloud data source setup dialogAdvanced tab of the Oracle Marketing Cloud data source setup dialog
Table 93. Advanced tab connection parameters for Oracle Marketing Cloud
Field
Description
Web Service Fetch Size
Specifies the number of rows of data the DataDirect Cloud connectivity service attempts to fetch for each call.
Valid Values:
0 | x
If set to 0, the DataDirect Cloud connectivity service attempts to fetch up to a maximum of 10000 rows. This value typically provides the maximum throughput.
If set to x, the DataDirect Cloud connectivity service attempts to fetch up to a maximum of the specified number of rows. Setting the value lower than 10000 can reduce the response time for returning the initial data. Consider using a smaller value for interactive applications only.
Default: 1000
Web Service Retry Count
The number of times to retry a timed-out Select request. Insert, Update, and Delete requests are never retried. The Web Service Timeout parameter specifies the period between retries. A value of 0 for the retry count prevents retries. A positive integer sets the number of retries. The default value is 0.
Web Service Timeout
The time, in seconds, to wait before retrying a timed-out Select request. Valid only if the value of Web Service Retry Count is greater than zero. A value of 0 for the timeout waits indefinitely for the response to a Web service request. There is no timeout. A positive integer is considered as a default timeout for any statement created by the connection. The default value is 120.
Fail On Incomplete​ Data
Specifies how DataDirect Cloud processes a query when Oracle Marketing Cloud returns no data for some columns.
For these columns, which together form incomplete data, the connectivity service can either return NULL values or throw an exception.
If set to 0, the connectivity service returns NULL values for such columns.
If set to 1, if possible, the connectivity service tries to retrieve the complete data using the bulk load.
While using the bulk load, if the number of columns exceeds 100 and the interface is therefore unable to satisfy the requirements of the query, the connectivity service throws an exception.
Note: It is preferable that you enable bulk load (Enable Bulk Load), as this allows more options for retrieving the data.
Default: 0
Enable Bulk Load
Enables or disables bulk support for fetching data.
If set to 1, bulk support is enabled.
If set to 0, bulk support is disabled.
Default: 1
Activity Bulk Page Size
The number of records to be fetched from Activity_XXX tables in a single request when using the bulk load.
Valid Values: 2 to 50000
Default: 50000
Bulk Page Size
The number of records to be fetched from Oracle Marketing Cloud in a single request when using the bulk load. 1, 2
Valid Values: 2 to 50000
Default: 5000
Bulk Timeout
The timeout duration for a bulk call in seconds.
Oracle Marketing Cloud automatically clears out the bulk staging area after this timeout, so if the query is large and the data takes more than this time to run, the query could be aborted midstream. This property only has an effect if the bulk load is enabled.
Valid Values: 3600 to 120960
Default: 18000
Bulk Top Threshold
For a Select query that qualifies for the bulk operations and the TOP n clause is used:
If the specified value is less than or equal to 1000, the standard mechanism would be used to process the query.
If the specified value is greater than 1000, bulk load would be used to process the query.
Valid Values: An integer greater than 0
Default: 1000
Read Only
Enables write operations to Oracle Marketing Cloud.
If the check box is selected (set to true), the data source is read only. Write operations are not allowed.
If the check box is not selected (set to false), write operations are permitted.
Default: false (the check box is not selected).
Extended Options
Specifies a semi-colon separated list of connection options and their values. Use this configuration option to set the value of undocumented connection options that are provided by Progress DataDirect technical support. You can include any valid connection option in the Extended Options string, for example:
Database=Server1;UndocumentedOption1=value[;UndocumentedOption2=value;]
If the Extended Options string contains option values that are also set in the setup dialog, the values of the options specified in the Extended Options string take precedence.
Valid Values: string
Default: empty string

1 Generally, higher page sizes return results more quickly. However, Oracle Marketing Cloud imposes a 32 MB limit on response package size. If queries return large records, too many records within a single page will exceed that limit, causing the query to fail.

2 All of the objects returned within a page must be materialized as the page is retrieved, so sufficient Java heap space is necessary with large page sizes containing many small columns.

See the steps for:
Creating a Data Source definition