Purpose

Determines how the embedded database and the mapping of the remote data model to the relational data model is configured, customized, and updated.
Note: This property is primarily used for initial configuration of the driver for a particular user. It is not intended for use with every connection. By default, the driver configures itself and this option is normally not needed. If ConfigOptions is specified on a connection after the initial configuration, the values specified for ConfigOptions must match the values specified for the initial configuration. The preferred method for setting the configuration options for a particular user is through the database configuration file. See Using the Database Configuration File for details.

Valid Values

(key=value[;key=value])

where:

key
is one of the following values: AuditColumns, MapCustomNamedIDFields, MapSystemColumnNames, NamedIDBehavior, or UppercaseIdentifiers.
The value is a set of key value pairs separated by a semicolon (;). The value must be enclosed in parentheses. For example:
(AuditColumns=none;UppercaseIdentifiers=false)

AuditColumns: Determines whether the driver includes audit columns when mapping the remote data model to the relational data model.

The driver supports the following audit columns for standard objects and custom objects:
  • CreatedTime
  • UpdatedTime
  • CreatedByAccountId
  • UpdatedByAccountId
Note: Although the CreatedTime and UpdatedTime fields on custom objects map to the relational view, you cannot query against them unless you enable the fields within the Object Designer in the Oracle Service Cloud admin tool.

Valid values for AuditColumns are:

Value Description
all The driver includes audit columns in all objects in the relational map.
standard The driver includes audit columns only for standard objects in the relational map.
custom The driver includes audit columns only for custom objects in the relational map.
none The driver removes audit columns from all objects in the relational map.

The default value for AuditColumns is all.

MapCustomNamedIDFields: Codetermines whether the driver exposes the NameID fields on custom objects and Name ID fields that are custom attributes on standard objects. When these fields are exposed, the driver uses the DESCRIBE command to discover how they are exposed. This process can significantly affect the time it takes the driver to build the relational map the first time it connects to Oracle Service Cloud. Valid values for MapCustomNamedIDFields are:

Value Description
0 The driver does not expose the NameID fields on custom objects and Name ID fields that are custom fields on standard objects.
1 The driver exposes the NameID fields on custom objects and Name ID fields that are custom fields on standard objects.

The default value for MapCustomNamedIDFields is 1.

MapSystemColumnNames: Determines how the driver maps Oracle Service Cloud system columns. Valid values for MapSystemColumnNames are:

Value Description
0 The driver does not change the names of any Oracle Service Cloud system columns.
1 The driver changes the names of Oracle Service Cloud system columns as follows:
Field Name             MappedName
----------             ----------
Id                     ROWID
LookUpName             SYS_LOOKUPNAME
CreatedTime            SYS_CREATEDTIME
UpdatedTime            SYS_UPDATEDTIME
CreatedByAccountId     SYS_CREATEDBYACCOUNT_ID
UpdatedByAccountId     SYS_UPDATEDBYACCOUNT_ID

The default value for MapSystemColumnNames is 0.

NamedIDBehavior: Determines whether the Name attribute of NamedID fields is exposed in the relational map.

Valid values for NamedIDBehavior are:

Value Description
1 The driver exposes the Name attribute of the NamedID fields in the relational model. Specify this setting if your application needs to access the Name strings associated with NamedID columns.
2 The driver does not expose the Name attribute of the NamedID fields in the relational model. This setting can be used to avoid "poor performing query" errors received when executing SELECT * queries against tables containing a large number of rows.
Note: If you are receiving "poor performing query" errors, you can work around this issue by setting NamedIDBehavior=2. This reduces the size of the result set, allowing the Oracle Service Cloud service to successfully return the query. For this change to have effect, you will need recreate the local mapping files by setting CreateDB=1; then, connecting to your Oracle Service Cloud instance. After creating your new local mapping files, you should reconfigure CreateDB to your preferred setting. We recommend a setting of CreateDB=2. For more information, see "Poor Performing Query errors."

The default value for NamedIDBehavior is 1.

UppercaseIdentifiers: Defines how the driver maps identifiers. By default, the driver maps all identifier names to uppercase.
Note: Do not change the value of UppercaseIdentifiers unless the data source you are connecting to has objects with names that differ only by case.

Valid values for UppercaseIdentifiers are:

Value Description
true The driver maps identifiers to uppercase.
false If set to false, the driver maps identifiers in mixed case as they exist in the object model. If mixed case identifiers are used, then they must be quoted in SQL statements because the identifier case in the driver's SQL engine is SQL_IC_UPPER.

The default value for UppercaseIdentifiers is true.

Defaults

AuditColumns=all;
MapCustomNamedIDFields=1;
MapSystemColumnNames=0;
NamedIDBehavior=1;
UppercaseIdentifiers=true

Data Type

String