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 | Specifies the authentication scheme the provider uses to connect. Set this to one of the following values: NTLM, Basic, Digest, Forms, Negotiate, ADFS, or None. |
| URL | Specifies the base URL of the SharePoint site or site collection the provider connects to. |
| User | Specifies the username for the account used to authenticate to the server. |
| Password | Specifies the password for the user account used to authenticate to the server. |
| SharePointVersion | Specifies the version of the SharePoint server that the provider connects to. |
| STSURL | Specifies the URL of the security token service (STS) used for single sign-on (SSO) with ADFS. |
| UseNTLMV1 | Specifies whether the provider uses the NTLMv1 authentication protocol instead of the default NTLMv2. |
| Property | Description |
| DefineTables | Specifies custom table definitions by mapping table names to sheet ranges in the spreadsheet. Use name-value pairs in the form TableName=SheetName!Range. |
| File | Specifies the name of the Excel file to connect to, including the .xlsx extension. |
| Folder | Specifies the folder path within the document library where the file specified in the File property is located. |
| Header | Specifies whether the first row of the sheet contains column names when using the REST API. |
| Library | Specifies the name of the document library that contains the Excel file you want to connect to. |
| IgnoreCalcError | Specifies whether the provider should ignore formula calculation errors in Excel worksheets. |
| MaxRows | Specifies the maximum number of rows the provider returns when a query does not include aggregation or grouping. |
| TypeDetectionScheme | Specifies how the provider determines the data types of columns in a worksheet. |
| UseRESTAPI | Specifies whether the provider uses the SharePoint REST API instead of the OData API to retrieve data. |
| Property | Description |
| SSOLoginURL | The identity provider's login URL. |
| SSODomain | Specifies the domain associated with the user account when using single sign-on (SSO). |
| SSOProperties | Additional properties required to connect to the identity provider, formatted as a semicolon-separated list. |
| Property | Description |
| KerberosKDC | Identifies the Kerberos Key Distribution Center (KDC) service used to authenticate the user. (SPNEGO or Windows authentication only). |
| KerberosRealm | Identifies the Kerberos Realm used to authenticate the user. |
| KerberosSPN | Identifies the service principal name (SPN) for the Kerberos Domain Controller. |
| KerberosUser | Confirms the principal name for the Kerberos Domain Controller, which uses the format host/user@realm. |
| KerberosKeytabFile | Identifies the Keytab file containing your pairs of Kerberos principals and encrypted keys. |
| KerberosServiceRealm | Identifies the service's Kerberos realm. (Cross-realm authentication only). |
| KerberosServiceKDC | Identifies the service's Kerberos Key Distribution Center (KDC). |
| KerberosTicketCache | Specifies the full file path to an MIT Kerberos credential cache file. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| Property | Description |
| IncludeNavigationParentColumns | Specifies whether the provider includes non-key parent columns in views generated from navigation properties. |
| Other | Specifies additional hidden properties for specific use cases., to be used only when our Support team advises it, to address specific issues. See Remarks for details. |
| RowScanDepth | The maximum number of rows to scan to look for the columns available in a table. |
| ShowEmptyRows | Specifies whether the provider includes empty rows when reading data from a worksheet. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |