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.
Authentication
| Property | Description |
| AuthScheme | The scheme used for authenticating to SharePoint. |
| URL | The base URL for the site. |
| SharePointEdition | The edition of SharePoint being used. Set either SharePoint Online or SharePoint
On-Premise. |
| User | The SharePoint user account used to authenticate. |
| Password | The password used to authenticate the user. |
Azure Authentication
| Property | Description |
| AzureTenant | The Microsoft Online tenant being used to access data. If not specified, your default
tentant will be used. |
| AzureEnvironment | The Azure Environment to use when establishing a connection. |
SSO
| 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. |
OAuth
| 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. |
| CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the
callback URL you specify in your Add-In settings. |
| 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://. |
| Scope | The scope used for the OAuth flow to access data from the Application. |
| 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. |
JWT OAuth
Kerberos
SSL
Firewall
| 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. |
Proxy
| 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 . |
Logging
| Property | Description |
| LogModules | Core modules to be included in the log file. |
Schema
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored
procedures. |
| Schema | The type of schema to use. |
Miscellaneous
| Property | Description |
| CalculatedDataType | The data type to be used for calculated fields. |
| ContinueOnError | Indicates whether or not to continue updating items in a batch after an error. |
| CreateIDColumns | Indicates whether or not to create supplemental ID columns for SharePoint columns that use
values from information stored in other Lists. |
| FolderOption | An option to determine how to display folders in results. Enter either FilesOnly,
FilesAndFolders, Recursive, or RecursiveAll. |
| IncludeLookupColumns | This option controls whether the driver returns the lookup columns defined on a table.
|
| 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 SharePoint. |
| Readonly | You can use this property to enforce read-only access to Microsoft SharePoint from the
provider. |
| ShowHiddenColumns | Boolean determining if hidden columns should be shown or not. If false, all hidden columns
will be removed from the column listing. |
| ShowPredefinedColumns | Boolean determining if predefined columns should be shown or not. If false, all columns
derived from a base type will be removed from the column listing. |
| ShowVersionViews | Indicate whether to display the view of list versions. Such as ListA_Versions. |
| STSURL | The URL of the security token service (STS) when using single sign-on (SSO). |
| 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. |
| UseEntityTypeName | Boolean determining if the table name should be EntityTypeName instead of the title in the
REST schema. |
| UseNTLMV1 | Determines whether the driver will attempt to connect with NTLMv1 or NTLMv2 (default).
|
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
| UseSimpleNames | Boolean determining if simple names should be used for tables and columns. |