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 scheme used for authentication. Accepted entries are NTLM,Basic,Digest,Forms,None,Negotiate,ADFS. |
URL | The base URL for a site or site collection. |
User | The username of the account used to authenticate to the server. |
Password | The password of the account used to authenticate to the server. |
SharePointVersion | The version of the SharePoint server to which you are connecting. |
STSURL | The URL of the security token service (STS) when using Single Sign On (SSO). |
UseNTLMV1 | Determines whether the driver will attempt to connect with NTLMv1 or NTLMv2 (default). |
Property | Description |
DefineTables | Define the tables within a spreadsheet. |
File | The name of the Excel file to which to connect. |
Folder | The folder containing the workbook specified by the File property. |
Header | Indicates whether the first row should be used as a column header when using the REST API. |
Library | The Document Library to which to connect. |
IgnoreCalcError | Indicates whether to ignore errors that occurred during the calculation. |
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. |
TypeDetectionScheme | Determines how to determine the data type of columns. |
UseRESTAPI | Whether or not the REST API is used for retrieving data. |
Property | Description |
SSOLoginURL | The identity provider's login URL. |
SSODomain | The domain of the user when using single sign-on (SSO). |
SSOProperties | Additional properties required to connect to the identity provider in a semicolon-separated list. |
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 |
IncludeNavigationParentColumns | Indicates if navigation parent columns should be included on navigation views. |
Other | These hidden properties are used only in specific use cases. |
RowScanDepth | The maximum number of rows to scan to look for the columns available in a table. |
ShowEmptyRows | Indicates whether or not the empty rows should be pushed when UseRESTAPI = true. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |