The connection option descriptions in this section are listed alphabetically by the GUI name that appears on the driver Setup dialog box. The connection string attribute name, along with its short name, is listed immediately underneath the GUI name in the option topics.

In most cases, the GUI name and the attribute name are the same; however, some exceptions exist. If you need to look up an option by its connection string attribute name, please refer to the following tables of connection string attribute names.

Also, a few connection string attributes, for example, Password, do not have equivalent options that appear on the GUI. They are in the list of descriptions by their attribute names.

Note: The driver does not support specifying values for the same connection option multiple times in a connection string or DSN. If a value is specified using the same attribute multiple times or using both long and short attributes, the connection may fail or the driver may not behave as intended.

The following tables provide a summary of supported connection options by functionality, including their attribute names, short names, and default values.

General options

OAuth 2.0 options

NTLM options

Mapping options

SQL engine options

Proxy server options

Web service options

Additional Options

General options

The following table summarizes general connection options that can apply to all connections that use data sources.

Table 1. General options
Attribute (Short Name) Default
DataSourceName (dsn) No default value
Description (n/a) No default value
ServiceURL (surl) No default value

OAuth 2.0 options

The following table summarizes options used for OAuth 2.0 authentication. The OAuth 2.0 options you must specify depend on the grant type used in your environment. If you are unsure of the grant type or its requirements, contact your system administrator. For details on supported grant types, see OAuth 2.0 authentication.

Table 2. OAuth 2.0 options
Attribute (Short Name) Default
AccessToken (atok) No default value
AuthenticationMethod (am) 24 (OAuth2)
AuthURI (o2au) No default value
ClientID (cid) No default value
ClientSecret (clse) No default value
RefreshToken (rtok) No default value
Scope (oas) No default value
ServiceURL (surl) No default value
TokenURI (o2tu) No default value

NTLM options

The following table summarizes options used for NTLM authentication.

Table 3. NTLM authentication options
Attribute (Short Name) Default
AuthenticationMethod (am) 24 (OAuth2)
NTLMDomain (ntdo) No default value
Password (pwd) No default value
ServiceURL (surl) No default value
User No default value

Mapping options

The following table summarizes connection options involved in mapping the Dynamics 365 data model to a SQL model.

Table 4. Mapping options
Attribute (Short Name) Default
CreateMap (cm) 4 (OnChange)
CustomPrefix (cpx) 1 (Include)
CustomPrefixName (cpxn) No default value
KeywordConflictSuffix (kcs) No default value
RefreshSchema (rs) 0 (false)
SchemaMap (smp) Default value depends on environment
ShowNameColumns (snc) 0 (false)

SQL engine options

The following table lists the options used to configure the SQL engine.

Table 5. SQL engine options
Attribute (Short Name) Default
JVMArgs (jvma) For the 32-bit driver when the SQL Engine Mode is set to 2 (Direct):

-Xmx256m

For all other configurations:

-Xmx1024m

JVMClassPath (jvmcp) install_dir\java\lib\dynamics365.jar
JVMPath (jvmp) install_dir\jre\bin\java.exe
ServerPortNumber (spn) No default value
ServerProxyHost (sph) No default value
ServerProxyPassword (spw) No default value
ServerProxyPort (spp) No default value
ServerProxyUser (spu) No default value
SQLEngineMode (sem) For Windows:

0 (Auto)

For Linux:

The SQL engine runs in Direct mode by default.

SQLService (ss) No default value

Proxy server options

The following table summarizes proxy server connection options.

Table 6. Proxy server options
Attribute (Short Name) Default
ProxyHost (pxhn) No default value
ProxyPassword (pxpw) No default value
ProxyPort (pxpt) 0 which means that the default value is determined by whether the value specified for the Proxy Host (ProxyHost) option is an HTTP or HTTPS URL.

For HTTP: 80

For HTTPS: 443

ProxyUser (pxun) No default value

Web service options

The following table summarizes Web service connection options, including those related to timeouts.

Table 7. Web service options
Attribute (Short Name) Default
StmtCallLimit (scl) 0 (no limit)
StmtCallLimitBehavior (sclb) 1 (ErrorAlways)
WSCompressData (wscd) 0 (Compress)
WSTimeout (wst) 300

Additional options

The following table summarizes additional connection options.

Table 8. Additional Options
Attribute (Short Name) Default
ApplicationUsingThreads (aut) 1 (True)
BatchUpdateChunkSize (bucs) 200
CrossCompany (cc) 0 (false)
ExtendedOptions (xo) No default value
FetchSize (fs) 100 (rows)
IANAAppCodePage (Linux only) 4 (ISO 8559-1 Latin-1)
InitializationString (is) No default value
LogConfigFile (lgcf) ddlogging.properties
ReadOnly (ro) 0 (false)
ReportCodepageConversionErrors (rcce) 0 (Ignore Errors)
TransactionMode (tm) 0 (NoTransactions)
UseEntityTypeNames (uetn) 0 (false)

This section includes the following topics: