49. Sharepoint
49.1. SharePoint Version Support
The driver supports all versions of SharePoint that support the SOAP API. This includes: Windows SharePoint Services 3.0, SharePoint Server 2007+ (2010, 2013, etc.), and SharePoint Online.
 
49.2. Connection Options
49.2.1. Authentication
Property
Description
AuthScheme
The scheme used for authenticating to SharePoint. For On-Premise instances, accepted entries are NTLM, Basic, Digest, Forms, None, and Negotiate. NTLM is the default. For Sharepoint Online, the accepted entries are OAuth and OAuthJWT.
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.
49.2.2. 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.
49.2.3. 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.
49.2.4. 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.
49.2.5. JWT OAuth
Property
Description
OAuthJWTCert
The JWT Certificate store.
OAuthJWTCertType
The type of key store containing the JWT Certificate.
OAuthJWTCertPassword
The password for the OAuth JWT certificate.
OAuthJWTCertSubject
The subject of the OAuth JWT certificate.
OAuthJWTIssuer
The issuer of the Java Web Token.
OAuthJWTSubject
The user subject for which the application is requesting delegated access.
49.2.6. Kerberos
Property
Description
KerberosKDC
The Kerberos Key Distribution Center (KDC) service used to authenticate the user.
KerberosRealm
The Kerberos Realm used to authenticate the user with.
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.
49.2.7. SSL
Property
Description
SSLClientCert
The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSLClientCertType
The type of key store containing the TLS/SSL client certificate.
SSLClientCertPassword
The password for the TLS/SSL client certificate.
SSLClientCertSubject
The subject of the TLS/SSL client certificate.
SSLServerCert
The certificate to be accepted from the server when connecting using TLS/SSL.
49.2.8. 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.
49.2.9. 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 .
49.2.10. Logging
Property
Description
Logfile
A filepath which designates the name and location of the log file.
Verbosity
The verbosity level that determines the amount of detail included in the log file.
LogModules
Core modules to be included in the log file.
MaxLogFileSize
A string specifying the maximum size in bytes for a log file (for example, 10 MB).
MaxLogFileCount
A string specifying the maximum file count of log files.
49.2.11. Schema
Property
Description
Location
A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Schema
The type of schema to use.
49.2.12. Caching
Property
Description
AutoCache
Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
CacheDriver
The database driver to be used to cache data.
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.
CacheTolerance
The tolerance for stale data in the cache specified in seconds when using AutoCache .
Offline
Use offline mode to get the data from the cache instead of the live source.
CacheMetadata
This property determines whether or not to cache the table metadata to a file store.
49.2.13. Miscellaneous
Property
Description
BatchSize
The maximum size of each batch operation to submit.
CalculatedDataType
The data type to be used for calculated fields.
ConnectionLifeTime
The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
ConnectOnOpen
This property species whether to connect to the SharePoint when the connection is opened.
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 SharePoint.
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.
PseudoColumns
This property indicates whether or not to include pseudo columns as columns to the table.
Readonly
You can use this property to enforce read-only access to SharePoint from the provider.
RTK
The runtime key used for licensing.
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).
SupportEnhancedSQL
This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
Timeout
The value in seconds until the timeout error is thrown, canceling the operation.
UseConnectionPooling
This property enables connection pooling.
UseDisplayNames
Boolean determining if the display names for the columns should be used instead of the API names.
UseNTLMV1
Determines whether the driver will attempt to connect with NTLMv1 or NTLMv2 (default).
UseSimpleNames
Boolean determining if simple names should be used for tables and columns.