Connection String Options
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Basic Tab.
| Property | Description |
| AuthScheme | The authentication scheme used. Accepted entries are Auto,OAuth,NTLM,Kerberos. |
| URL | The root URL of the organization. For example, a CRM 4.0 or CRM 2011 URL will resemble http://MySite/MyOrganization. For CRM Online, the URL will resemble https://myOrg.crm.dynamics.com/. |
| CRMVersion | The type of Dynamics CRM server to which you are connecting. Accepted entries are CRM2011+, CRMOnline. |
| InternetFacingDeployment | Whether you are connecting to an Internet Facing Deployment (IFD) for CRM. |
| User | The SharePoint user account used to authenticate. |
| Password | The password used to authenticate the user. |
| OrganizationName | The name of the organization. In Dynamics CRM 4.0 without IFD, the organization is specified in the URL; for example, http://website/organizationname. In Dynamics CRM 4.0 with IFD, this property must be set. In other versions of CRM, this property is optional. |
| ServerVersion | The Server SDK version of DynamicsCRM. |
| Property | Description |
| AzureTenant | The Microsoft Online tenant being used to access data. If not specified, your default tentant will be used. |
| Property | Description |
| InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
| OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
| OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
| OAuthAccessToken | The access token for connecting using OAuth. |
| OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://. |
| CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
| ADFSServer | The ADFS Server used for authentication. |
| OAuthGrantType | The grant type for the OAuth flow. |
| OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
| OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
| OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
| OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
| Property | Description |
| KerberosKDC | The Kerberos Key Distribution Center (KDC) service used to authenticate the user. |
| KerberosRealm | The Kerberos Realm used to authenticate the user. |
| KerberosSPN | The service principal name (SPN) for the Kerberos Domain Controller. |
| KerberosKeytabFile | The Keytab file containing your pairs of Kerberos principals and encrypted keys. |
| KerberosServiceRealm | The Kerberos realm of the service. |
| KerberosServiceKDC | The Kerberos KDC of the service. |
| KerberosTicketCache | The full file path to an MIT Kerberos credential cache file. |
| Property | Description |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
| ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
| ProxyPort | The TCP port the ProxyServer proxy is running on. |
| ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
| ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
| Property | Description |
| LogModules | Core modules to be included in the log file. |
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| Property | Description |
| CallerId | The Id of a user to impersonate when inserting or updating new records. |
| DefaultPrecision | The currency precision that is used for pricing throughout the system. Valid values are 0-4 and Auto. If the value is Auto, the default value will be retrieved from the Microsoft Dynamics CRM server. |
| ExposeVirtualSubColumn | Boolean that exposes a virtual subcolumn to return data in a different format. |
| IncludeCalculatedColumns | This option controls whether the driver returns the Calculated Columns defined on a table. Only applicable for CRM 2015+. |
| LanguageCode | The code indicating the language. |
| MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
| Other | These hidden properties are used only in specific use cases. |
| Pagesize | The maximum number of results to return per page from Microsoft Dynamics CRM. |
| PricingPrecision | The Pricing Precision of DynamicsCRM. |
| QueryMethod | The method to use when querying data from Dynamics CRM. In most cases FetchXML will work with all tables. |
| Readonly | You can use this property to enforce read-only access to Microsoft Dynamics CRM from the provider. |
| SavedQueryFilter | A comma-separated list of filters to use for displaying Saved Queries as views (ex: Accounts%,Contacts%). |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UseDisplayNames | Boolean determining if the display names for the columns should be used instead of the API names. UseDisplayNames and UseSchemaNames are mutually exclusive. |
| UseDisplayTableNames | Boolean determining if the display names for the table should be used instead of the API names. |
| UseNameForPicklistValue | Boolean determining if the string value should be used for picklist field values instead of integers. |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
| UseSchemaNames | Boolean determining if the schema names for the table should be used instead of the API names. UseDisplayNames and UseSchemaNames are mutually exclusive. |
| UseSimpleNames | Boolean determining if simple names should be used for tables and columns. |