Connection String Parameters for Dynamics CRM
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.
Name | Description |
AuthScheme | The authentication scheme used. Accepted entries are NTLM, BASIC, DIGEST, NONE, and KERBEROSDELEGATION. |
AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
CacheConnection | The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data. |
CacheLocation | Specifies the path to the cache when caching to a file. |
CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
CacheProvider | The name of the provider to be used to cache data. |
CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
CallerId | The Id of a user to impersonate when inserting or updating new records. |
ConnectionLifeTime | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
CRMVersion | The type of Dynamics CRM server to which you are connecting. Accepted entries are CRM2011+, CRMOnline. |
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 Dynamics CRM server. |
DeviceCredentialLocation | The path to a file where device credentials are stored. If the file does not exist or is empty a new set of credentials will be generated and stored in that file. |
DeviceCredentialPassword | The password used to encrypt or decrypt the credentials stored in the credentials file. |
DeviceName | The device name used to authenticate along with a Windows Live Id. |
DevicePassword | The device password used to authenticate along with a Windows Live Id. |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
IncludeCalculatedColumns | This option controls whether the driver returns the Calculated Columns defined on a table. Only applicable for CRM 2015+. |
InternetFacingDeployment | Whether you are connecting to an Internet Facing Deployment (IFD) for CRM. |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
Logfile | A path to the log file. |
MaxLogFileCount | A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted. |
MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. |
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. |
Offline | Use offline mode to get the data from the cache instead of the live source. |
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. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | The number of rows to return per page from the data source. |
Password | The password used to authenticate to the Dynamics CRM site. |
PoolIdleTimeout | The allowed idle time for a connection before it is closed. |
PoolMaxSize | The maximum connections in the pool. |
PoolMinSize | The minimum number of connections in the pool. |
PoolWaitTime | The max seconds to wait for an available connection. |
ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
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. |
ProxyExceptions | A semicolon separated list of hosts or IPs that are exempt from connecting through the ProxyServer . |
ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
ProxyPort | The TCP port the ProxyServer proxy is running on. |
ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
QueryMethod | The method to use when querying data from Dynamics CRM. In most cases FetchXML will work with all tables. |
QueryPassthrough | This option passes the query to the Dynamics CRM server as is. |
Readonly | You can use this property to enforce read-only access to Dynamics CRM from the provider. |
RTK | The runtime key used for licensing. |
SavedQueryFilter | A comma-separated list of filters to use for displaying Saved Queries as views (ex: Accounts%,Contacts%). |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
STSURL | The URL of the security token service (STS). This value is detected automatically. |
SupportEnhancedSQL | This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
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/. |
UseConnectionPooling | This property enables connection pooling. |
UseDisplayNames | Boolean determining if the display names for the columns 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. |
User | The user who is authenticating to the Dynamics CRM site. |
UseSimpleNames | Boolean determining if simple names should be used for tables and columns. |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |