The scheme used for authentication. Accepted entries are NTLM, BASIC, DIGEST, FORMS, NONE, NEGOTIATE, and KERBEROSDELEGATION.

string

"NTLM"

Together with Password and User, this field is used to authenticate against the server. NTLM is the default option. Use the following options to select your authentication scheme:

NTLM: Set this to use your Windows credentials for authentication.

BASIC: Set this to use HTTP Basic authentication.

DIGEST: Set this to HTTP Digest authentication.

FORMS: Set this to use Forms authentication.

NEGOTIATE: If

AuthScheme is set to NEGOTIATE, the adapter will negotiate an authentication mechanism with the server. Set AuthScheme to NEGOTIATE if you want to use Kerberos authentication.

KERBEROSDELEGATION: Set this to use delegation through the Kerberos protocol. Set the User and Password of the account you want to impersonate.

Define the tables within a spreadsheet.

string

""

This property is used to define the ranges within a spreadsheet that will appear as tables, when using the REST API. The value is a comma-separated list of name-value pairs in the form [Table Name]=[Sheet Name]![Range]. Table Name is the name of the table you want to use for the data and will be used when issuing queries. Sheet Name is the name of the sheet within the spreadsheet and Range is the range of cells that contain the data for the table.

Here is an example DefineTables value: DefineTables="DefinedTable1=Sheet1!A1:N25,DefinedTable2=Sheet2!C3:M53"

Note: If the name of a defined table is the same as one returned by default (e.g. same name as a worksheet), the defined table will replace the default table.

The name of the Excel file to which to connect.

string

""

The name of Excel file to which to connect (including the extension). The file must exist.

A password used to authenticate to a proxy-based firewall.

string

""

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

The TCP port for a proxy-based firewall.

string

""

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The name or IP address of a proxy-based firewall.

string

""

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the adapter uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The protocol used by a proxy-based firewall.

string

"NONE"

This property specifies the protocol that the adapter will use to tunnel traffic through the FirewallServer proxy. Note that by default the adapter connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

 

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

The user name to use to authenticate with a proxy-based firewall.

string

""

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

The folder containing the workbook specified by the File property.

string

""

The full, hierarchical path of the subfolder in a Library where the File can be found. For example if the File is located in a folder called "SubFolder" within the folder called "BaseFolder", the property will be set to "/BaseFolder/SubFolder/".

Indicates whether the first row should be used as a column header when using the REST API.

bool

true

If true, the first row will be used as a column header. Otherwise, the pseudo column names A, B, C, etc. will be used.

Note: This property is only used when UseRESTAPI is 'True'.

Indicates whether to ignore errors that occurred during the calculation.

bool

true

IgnoreCalcError defaults to false. If IgnoreCalcError is set to true, the provider will ignore any errors that occur due to formula calculation. If this happens, the formula result may be unreliable, but other data will be accurate.

The Document Library to which to connect.

string

""

This property indicates the name of the Document Library containing the Excel file. If no library is specified, the "Shared Documents" library will be used.

If you wish to connect to OneDrive for Business, set this property to "Documents".

A path to the directory that contains the schema files defining tables, views, and stored procedures.

string

""

The path to a directory which contains the schema files for the adapter (.rsd files for tables and views, .rsb files for stored procedures). The Location property is only needed if you would like to customize definitions (e.g., change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

The schema files are deployed alongside the adapter assemblies. You must also ensure that Location points to the folder that contains the schema files. The folder location can be a relative path from the location of the executable.

Core modules to be included in the log file.

string

""

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

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.

string

"-1"

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.

The other parameters necessary to connect to a data source, such as username and password, when applicable.

string

""

The Other property is a semicolon-separated list of name-value pairs used in connection parameters specific to a data source.

The password of the SharePoint Online account used to authenticate to the SharePoint Online server.

string

""

Together with User, this field is used to authenticate against the SharePoint Online server;.

The authentication type to use to authenticate to the ProxyServer proxy.

string

"BASIC"

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the adapter will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

BASIC: The adapter performs HTTP BASIC authentication.

DIGEST: The adapter performs HTTP DIGEST authentication.

NEGOTIATE: The adapter retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.

PROPRIETARY: The adapter does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see Firewall Type.

This indicates whether to use the system proxy settings or not. Set ProxyAutoDetect to FALSE to use custom proxy settings. This takes precedence over other proxy settings.

bool

true

By default, the adapter uses the system HTTP proxy. Set this to false if you want to connect to another proxy.

To connect to an HTTP proxy, see Proxy Server.

For other proxies, such as SOCKS or tunneling, see Firewall Type.

A semicolon separated list of hosts or IPs that will be exempt from connecting through the ProxyServer .

string

""

The ProxyServer will be used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the adapter will use the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you will need to set ProxyAutoDetect to false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

A password to be used to authenticate to the ProxyServer proxy.

string

""

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see Firewall Type.

By default, the adapter uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

string

"80"

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see Firewall Type.

The hostname or IP address of a proxy to route HTTP traffic through.

string

""

The hostname or IP address of a proxy to route HTTP traffic through. The adapter can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see Firewall Type.

By default, the adapter uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

string

"AUTO"

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

 

 

A user name to be used to authenticate to the ProxyServer proxy.

string

""

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the username of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a username in one of the following formats:

The maximum number of rows to scan to look for columns available in the table. If TypeDetectionScheme is set to RowScan, this property will also control how many rows to scan in order to determine data type.

string

"50"

Since Excel Services is schemaless, the columns in a table must be determined by scanning table rows. This value determines the maximum number of rows that will be scanned.

The edition of SharePoint being used. Set either SharePoint Online or SharePoint On-Premise.

string

"SharePoint Online"

The edition of SharePoint being used. Set either SharePoint Online or SharePoint On-Premise.

The version of the SharePoint server to which you are connecting.

string

"SharePoint 2013"

Accepted entries are SharePoint 2013 and SharePoint 2010.

The certificate to be accepted from the server when connecting using TLS/SSL.

string

""

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine will be rejected.

This property can take the forms:

 

 

If not specified, any certificate trusted by the machine will be accepted. Use '*' to signify to accept all certificates (not recommended for security concerns).

The domain of the user when using Single Sign On (SSO).

string

""

This property is only applicable when using Single Sign On (UseSSO is set to true) and if the domain of the User (e.g. user@mydomain.com) is different than the domain configured within the SSO service (e.g. user@myssodomain.com).

This property may be required when using OneLogin or OKTA SSO services.

The URL of the security token service (STS) when using Single Sign On (SSO).

string

""

This property only needs to be set when using Single Sign On with a local Active Directory Federation Services (ADFS).

The value in seconds until the timeout error is thrown, canceling the operation.

string

"60"

If the Timeout property is set to 0, operations do not time out: They run until they complete successfully or encounter an error condition.

If Timeout expires and the operation is not yet complete, the adapter throws an exception.

Determines how to determine the data type of columns.

string

"RowScan"

The base URL for a site or site collection.

string

""

The following are examples of valid URLs:

http://server/SharePoint/

http://server/Sites/mysite/

http://server:90/

The provider will use Url to derive URLs for other calls to the server.

The username of the SharePoint Online account used to authenticate to the server.

string

""

Together with Password, this field is used to authenticate to the SharePoint Online server specified in Url.

Whether or not the REST API is used for retrieving data.

string

"False"

Whether or not the REST API is used for retrieving data. Enable this option to use the REST API when connecting to SharePoint 2013, SharePoint 2016, and SharePoint Online. In these SharePoint versions, both the REST API and OData API are available.

Use the REST API to access spreadsheets and ranges as tables as well as table objects. The OData API enables access to only table objects.

See Data Model for more information on querying spreadsheets organized in different ways.

Whether or not to use Single Sign On (SSO) to authenticate to SharePoint Online.

bool

false

When set to true, Single Sign On (SSO) will be used to authenticate to SharePoint Online using the account specified via User and Password. Active Directory Federation Services (ADFS), OneLogin, and OKTA SSO identity providers are supported.

SSODomain may be required to be set if the domain configured on the SSO domain is different than the domain of the User.

If you need to use a local ADFS instance to perform authentication, STSURL must be set to the URL of the local instance.

SSO is only applicable when using SharePoint Online. SSO is not supported for On-Premise versions of SharePoint.