|
Field
|
Description
|
|
Data Source Name
|
A unique name for the data source. Data source names can contain only alphanumeric characters, underscores, and dashes.
|
|
Description
|
A description of this set of connection parameters.
|
|
User Id, Password
|
The login credentials for your Oracle Marketing 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
 icon. Click the icon 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.
|
|
Field
|
Description
|
|
Version
|
Enables you to choose from the supported OData versions. OData configuration made with one OData version will not work if you switch to a different OData version. If you want to maintain the data source with different OData versions, you must create different data sources for each of them.
|
|
Access URI
|
Specifies the base URI for the OData feed to access the data source, for example, https://example.com:8443/api/odata4/<datasourcename>. 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/columns to expose through OData.
See Configuring data sources for OData connectivity and working with data source groups for more information.
|
|
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.
Valid Values:
ON | OFF
When ON is selected, OData access is restricted to read-only mode.
When OFF is selected, write operations can be performed on the OData service.
Default: OFF
|
|
Field
|
Description
|
||||||||
|
Map Name
|
Optional name of the map definition that Hybrid Data Pipeline uses to interpret the schema of the cloud data store. The Hybrid Data Pipeline service automatically creates a name for the map.
|
||||||||
|
Refresh Schema
|
The Refresh Schema option specifies whether the connectivity service attempts to refresh the schema when an application first connects.
Valid Values:
When set to ON, the connectivity service attempts to refresh the schema.
When set to OFF, the connectivity service does not attempt to refresh the schema.
Default
OFF
Notes
 You can choose to refresh the schema by clicking the Refresh
 icon. This refreshes the schema immediately. Note that the refresh option is available only while editing the data source.
Use the option to specify whether the connectivity service attempts to refresh the schema when an application first connects. Click the Refresh icon 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. Clicking the Refresh icon 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.
The Hybrid Data Pipeline connectivity service automatically maps 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.
|
||||||||
|
Keyword Conflict Suffix
|
The SQL standard and Hybrid Data Pipeline 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 Hybrid Data Pipeline 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.
Default: 0
|
||||||||
|
Fetch Option Lists
|
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: ON | OFF
If set to ON, 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 set to OFF, 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).
Default: OFF
|
|
Field
|
Description
|
|
Web Service Fetch Size
|
Specifies the number of rows of data the Hybrid Data Pipeline connectivity service attempts to fetch for each call.
Valid Values:
0 | x
If set to 0, the Hybrid Data Pipeline connectivity service attempts to fetch up to a maximum of 10000 rows. This value typically provides the maximum throughput.
If set to x, the Hybrid Data Pipeline 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 Hybrid Data Pipeline 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 set to ON, the data source is read only. Write operations are not allowed.
If set to OFF, write operations are permitted.
Default: OFF
|
|
Extended Options
|
Specifies a semi-colon delimited 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
|
|
Metadata Exposed Schemas
|
Restricts the metadata exposed by Hybrid Data Pipeline to a single schema. The metadata exposed in the SQL Editor, the Configure Schema Editor, and third party applications will be limited to the specified schema. JDBC, OData, and ODBC metadata calls will also be restricted. In addition, calls made with the Schema API will be limited to the specified schema.
Warning: This functionality should not be regarded as a security measure. While the Metadata Exposed Schemas option restricts the metadata exposed by Hybrid Data Pipeline to a single schema, it does not prevent queries against other schemas on the backend data store. As a matter of best practice, permissions should be set on the backend data store to control the ability of users to query data.
Valid Values
<schema>
Where:
<schema>
is the name of a valid schema on the backend data store.
Default: No schema is specified. Therefore, all schemas are exposed.
|