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

Try DataDirect Cloud Now

Oracle Service Cloud connection parameters

The following tables describe parameters available on the tabs of an Oracle® Service Cloud Data Source dialog:
*General tab
*OData tab
*Mapping tab
*Advanced tab
Watch a video to see how to create and test a connection to Oracle Service Cloud.

General tab

Click the thumbnail to view the screen. Required fields are marked with an asterisk.
General tab of the Oracle Service Cloud data source setup dialogGeneral tab of the Oracle Service Cloud data source setup dialog
Table 94. General tab connection parameters for Oracle Service Cloud
Field
Description
Data Source Name
A unique name for this Data Source definition.
Note: Names can contain only alphanumeric characters and underscore.
Description
A description of this set of connection parameters.
User Id, Password
The login credentials for your Oracle Service Cloud cloud data store account.
Note: By default, the password is encrypted.
DataDirect Cloud uses this information to connect to the data store. The administrator of the cloud data store must grant permission to a user with these credentials to access the data store and the target data.
Note: You can save the Data Source definition without specifying the login credentials. In that case, when you test the Data source connection, you will be prompted to specify these details. Applications using the connectivity service will have to supply the data store credentials (if they are not saved in the Data Source) in addition to the Data Source name and the credentials for the DataDirect Cloud account.
By default, the characters 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.
Oracle Service Cloud Login URL
The Host Name for the Oracle Service Cloud site that DataDirect Cloud will use to query the service; for example mysite.custhelp.com, mysite.custhelp.com.
Interface
The name of the Oracle Service Cloud interface to which you want to connect.

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 95. OData tab connection parameters for Oracle Service 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: 1
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 tab of the Oracle Service Cloud data source setup dialogMapping tab of the Oracle Service Cloud data source setup dialog
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.
Click the + next to Set Map Options to display these fields.
The following table describes the mapping options that apply to Oracle Service Cloud.
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.
Table 96. Mapping tab Connection Parameters for Oracle Service Cloud
Field
Description
Audit Columns
The audit columns added by DataDirect Cloud are:
*CreatedByAccountID
*CreatedTime
*UpdatedByAccountID
*UpdatedTime
The following table describes the valid values for the Audit Columns parameter.
Table 96. Valid values for Audit Columns
Value
Description
All
DataDirect Cloud includes all of the audit columns in its table definitions.
standard
DataDirect Cloud adds only the audit columns in its table definitions.
custom
DataDirect Cloud adds audit columns only for custom objects in its table definitions.
None
DataDirect Cloud does not add the audit columns in its table definitions.
The default value for Audit Columns is All.
In a typical Oracle Service Cloud instance, not all users are granted access to the Audit columns. If Audit Columns is set to a value other than None and if DataDirect Cloud cannot include the columns requested, the connection fails and an exception is thrown.
Create Mapping
Determines whether the Oracle Service 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 97. 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.
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.
Map System Column Names
Defines whether DataDirect Cloud maps the integration name of standard columns that appear in each Oracle Service Cloud object to a new name. By default, DataDirect Cloud maps the id column to ROWID, and maps the remaining standard columns to a new name prefixed with SYS_ .
Valid Values:
1 | 0
When set to 1, DataDirect Cloud prefixes the names of standard columns of Oracle Service Cloud objects with SYS_ or ROWID.
When set to 0, DataDirect Cloud does not map the names of standard columns of Oracle Service Cloud objects to new names.
Default: 0
NamedID Behavior
Controls whether the Name attribute of NamedID fields are exposed in the relational model.
Valid Values:
1 | 2
When set to 1, the Id and Name attributes of the NamedID fields are exposed in the relational model. This means that they will be included in the results for the queries. However, including these columns in queries can cause Oracle Service Cloud to return a “poor performing query” error if the table has a large number of rows.
When set to 2, only the Id attribute of the NamedID fields is exposed in the relational model. This setting may improve performance of queries that use NamedID fields.
Default: 1
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.

Advanced tab

Click the thumbnail to view the screen.
Advanced tab of the Oracle Service Cloud data source setup dialogAdvanced tab of the Oracle Service Cloud data source setup dialog
Table 99. Advanced tab connection parameters for Oracle Service Cloud
Field
Description
Enable Paging With Order By ID
Specifies whether the DataDirect Cloud connectivity service can inject the Order By clause in the Select query for each call. Enabling this connection parameter provides a stable paging mechanism for retrieving result sets that are larger than the maximum number of rows for the site. Note: If your application does not retrieve large result sets, consider disabling this feature, because adding the Order By clause can have a negative performance impact on queries.
If the check box is selected (true), the DataDirect Cloud connectivity service can inject the Order By clause in the Select query.
Default: true
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
Initialization String
A semicolon delimited set of commands to be executed on the cloud data store after DataDirect Cloud has established and performed all initialization for the connection. If the execution of a SQL command fails, the connection attempt also fails and DataDirect Cloud returns an error indicating which SQL commands failed.
Syntax:
SQLcommand[[; SQLcommand]...]
where:
SQLcommand is a SQL command. Multiple commands must be separated by semicolons.
Default: an empty string.
Max Pooled Statements
The maximum number of prepared statements to cache for this connection. If the value of this property is set to 20, the connectivity service caches the last 20 prepared statements that are created by the application.
Default: 0
Oracle Service Cloud Database
Determines against which database queries should be resolved. Oracle Service Cloud can satisfy queries against the production (operational) or the reporting database that backs the service.
Valid Values:
report | operational
If set to report, the DataDirect Cloud connectivity service prepends a "USE REPORT; " statement to the base ROQL command. This results in the reporting database being used for subsequent queries.
If set to operational, the DataDirect Cloud connectivity service prepends a "USE OPERATIONAL; " statement to the base ROQL command. This results in the production database being used for subsequent queries.
If not specified, the DataDirect Cloud connectivity service sends the base ROQL command directly. This results in the default database behavior.
Default: report.
Processing Options
Determines whether external events and business rules are run on the server side when performing a Create, Destroy, Get, or Update operation.
Valid Values:
0 | 1 | 2 | 3
If set to 0, external events and business rules run after a Create, Destroy, Get, or Update operation completes.
If set to 1, external events do not run after a Create, Destroy, Get, or Update operation completes.
If set to 2, business rules do not run after a Create, Destroy, Get, or Update operation completes.
If set to 3, external events and business rules do not run after a Create, Destroy, Get, or Update operation completes.
Default: 0
Read Only
Enables write operations to Oracle Service 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 if Oracle Service Cloud Database is set to operational. Write operations are not supported if Oracle Service Cloud Database is set to report.
Default: true (the check box is selected).
Web Service Call Limit
The maximum number of Web service calls allowed to the cloud data store for a single SQL statement or metadata query.
Valid Values: -1 | 0 | x
where x is a positive integer that defines the maximum number of Web service calls that the connectivity service can make when executing any single SQL statement or metadata query.
If set to -1, the connectivity service uses the default value that is configured in the service when connected to a site whose version is August 2014 or later. When connected to sites whose version is prior to August 2014, the connectivity service sets the maximum number of calls to 100.
If set to 0, the connectivity service uses the maximum number of calls allowed by the service when connected to a site whose version is August 2014 or later. When connected to sites whose version is prior to August 2014, there is no limit.
If set to x, the connectivity service uses this value to set the maximum number of Web service calls that can be made when executing a SQL statement or metadata query. If you specify a value that is greater than the maximum number of calls allowed when connected to a site whose version is August 2014 or later, the connectivity service returns a warning and uses the maximum value instead.
Default: -1.
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
where x is a positive integer that defines the maximum number of Web service calls that the connectivity service can make when executing any single SQL statement or metadata query. For servers prior to version 14.08, the maximum is 10,000 rows. For versions 14.08 and higher, the maximum is server dependent.
If set to 0, the connectivity service uses the maximum page size for the Oracle Service Cloud database to which it is connecting (Operational or Report) for sites whose version is 14.08 or higher. When connecting to sites whose version is prior to 14.08, the connectivity service attempts to fetch up to a maximum of 10,000 rows. This value typically provides the maximum throughput.
If set to x, the connectivity service attempts to fetch up to a maximum of the specified number of rows. Setting the value lower than 10,000 can reduce the response time for returning the initial data. Consider using a smaller value for interactive applications only. If you specify a value greater than the server allows, the connectivity service returns a warning and uses the maximum value permitted.
The default is 0.
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.
See the steps for:
Creating a Data Source definition