Matillion ETL Data Model for SharePoint REST
Version - 21.0.8151.0

Note: Data models are true for the latest version of Matillion ETL. If you are on an older version or using a component from an old job, your experience may differ.



Connection String OptionsBack To Top

  1. AuthScheme
  2. URL
  3. SharePointEdition
  4. User
  5. Password
  6. AzureTenant
  7. AzureEnvironment
  8. SSOLoginURL
  9. SSODomain
  10. SSOProperties
  11. InitiateOAuth
  12. OAuthClientId
  13. OAuthClientSecret
  14. OAuthAccessToken
  15. CallbackURL
  16. OAuthSettingsLocation
  17. Scope
  18. OAuthGrantType
  19. OAuthVerifier
  20. OAuthRefreshToken
  21. OAuthExpiresIn
  22. OAuthTokenTimestamp
  23. OAuthJWTCert
  24. OAuthJWTCertType
  25. OAuthJWTCertPassword
  26. OAuthJWTCertSubject
  27. OAuthJWTIssuer
  28. OAuthJWTSubject
  29. KerberosKDC
  30. KerberosRealm
  31. KerberosSPN
  32. KerberosKeytabFile
  33. KerberosServiceRealm
  34. KerberosServiceKDC
  35. KerberosTicketCache
  36. SSLClientCert
  37. SSLClientCertType
  38. SSLClientCertPassword
  39. SSLClientCertSubject
  40. SSLServerCert
  41. FirewallType
  42. FirewallServer
  43. FirewallPort
  44. FirewallUser
  45. FirewallPassword
  46. ProxyAutoDetect
  47. ProxyServer
  48. ProxyPort
  49. ProxyAuthScheme
  50. ProxyUser
  51. ProxyPassword
  52. ProxySSLType
  53. ProxyExceptions
  54. Logfile
  55. Verbosity
  56. LogModules
  57. MaxLogFileSize
  58. MaxLogFileCount
  59. Location
  60. BrowsableSchemas
  61. Tables
  62. Views
  63. Schema
  64. AutoCache
  65. CacheDriver
  66. CacheConnection
  67. CacheLocation
  68. CacheTolerance
  69. Offline
  70. CacheMetadata
  71. BatchSize
  72. CalculatedDataType
  73. ConnectionLifeTime
  74. ConnectOnOpen
  75. ContinueOnError
  76. CreateIDColumns
  77. FolderOption
  78. IncludeLookupColumns
  79. MaxRows
  80. Other
  81. Pagesize
  82. PoolIdleTimeout
  83. PoolMaxSize
  84. PoolMinSize
  85. PoolWaitTime
  86. PseudoColumns
  87. Readonly
  88. RTK
  89. ShowHiddenColumns
  90. ShowPredefinedColumns
  91. ShowVersionViews
  92. STSURL
  93. SupportEnhancedSQL
  94. Timeout
  95. UseConnectionPooling
  96. UseDisplayNames
  97. UseNTLMV1
  98. UseSimpleNames

AuthScheme

Data Type

string

Default Value

"NTLM"

Remarks

If authenticating to Sharepoint On-Premise instance, 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:

If authenticating to Sharepoint Online, OAuth is the default option. Use the following options to select your authentication scheme:



URL

Data Type

string

Default Value

""

Remarks

The following are examples of valid URLs:

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



SharePointEdition

Data Type

string

Default Value

"SharePoint OnPremise"

Remarks

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



User

Data Type

string

Default Value

""

Remarks

Together with Password, this field is used to authenticate against the SharePoint server.

For SharePoint On-Premise, User should include the domain and will look similar to the following: DOMAIN\Username.

For SharePoint Online, User will look similar to the following: username@domain.onmicrosoft.com.



Password

Data Type

string

Default Value

""

Remarks

The User and Password are together used to authenticate with the server.



AzureTenant

Data Type

string

Default Value

""

Remarks

The Microsoft Online tenant being used to access data. For instance, contoso.onmicrosoft.com. Alternatively, specify the tenant Id. This value is the directory Id in the Azure Portal > Azure Active Directory > Properties.

Typically it is not necessary to specify the Tenant. This can be automatically determined by Microsoft when using the OAuthGrantType set to CODE (default). However, it may fail in the case that the user belongs to multiple tenants. For instance, if an Admin of domain A invites a user of domain B to be a guest user. The user will now belong to both tenants. It is a good practice to specify the Tenant, although in general things should normally work without having to specify it.

The AzureTenant is required when setting OAuthGrantType to CLIENT. When using client credentials, there is no user context. The credentials are taken from the context of the app itself. While Microsoft still allows client credentials to be obtained without specifying which Tenant, it has a much lower probability of picking the specific tenant you want to work with. For this reason, we require AzureTenant to be explicitly stated for all client credentials connections to ensure you get credentials that are applicable for the domain you intend to connect to.



AzureEnvironment

Data Type

string

Default Value

"GLOBAL"

Remarks

In most cases, leaving the environment set to global will work. However, if your Azure Account has been added to a different environment, the AzureEnvironment may be used to specify which environment.



SSOLoginURL

Data Type

string

Default Value

""

Remarks

The identity provider's login URL.



SSODomain

Data Type

string

Default Value

""

Remarks

This property is only applicable when using single sign-on (AuthScheme is configured to use an SSO authentication scheme) 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 the ADFS, OneLogin, or OKTA SSO services.



SSOProperties

Data Type

string

Default Value

""

Remarks

Additional properties required to connect to the identity provider in a semicolon-separated list. is used in conjunction with the SSOLoginURL.

SSO configuration is discussed further in Establishing a Connection.



InitiateOAuth

Data Type

string

Default Value

"OFF"

Remarks

The following options are available:

  1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
  2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the driver. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
  3. REFRESH: Indicates that the driver will only handle refreshing the OAuthAccessToken. The user will never be prompted by the driver to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.



OAuthClientId

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.



OAuthClientSecret

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.



OAuthAccessToken

Data Type

string

Default Value

""

Remarks

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.



CallbackURL

Data Type

string

Default Value

""

Remarks

During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your Add-In settings.



OAuthSettingsLocation

Data Type

string

Default Value

"%APPDATA%\\CData\\SharePoint Data Provider\\OAuthSettings.txt"

Remarks

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the driver saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and allowing the credentials to be shared across connections or processes.

Alternatively to specifying a file path, memory storage can be used instead. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (ex: memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike with the file based storage, you must manually store the credentials when closing the connection with memory storage to be able to set them in the connection when the process is started again. The OAuth property values can be retrieved with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties should be read from the last connection to be closed.

If left unspecified, the default location is "%APPDATA%\\CData\\SharePoint Data Provider\\OAuthSettings.txt" with %APPDATA% being set to the user's configuration directory:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Mac ~/Library/Application Support
Linux ~/.config



Scope

Data Type

string

Default Value

"NONE"

Remarks

The scope used for the OAuth flow to access data from the Application.

Note: If not specified or left to 'NONE', the driver sets the default scope dependant upon OAuthGrantType. Defaults to 'AllSites.Manage' unless using JWT OAuth, Azure Service Principal, or CLIENT grant type. The available values are:



OAuthGrantType

Data Type

string

Default Value

"CODE"

Remarks

The grant type for the OAuth flow. The following options are available: CODE,PASSWORD,REFRESH,SAML_1,CLIENT



OAuthVerifier

Data Type

string

Default Value

""

Remarks

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines

See Establishing a Connection to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the driver exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set InitiateOAuth to GETANDREFRESH automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.



OAuthRefreshToken

Data Type

string

Default Value

""

Remarks

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.



OAuthExpiresIn

Data Type

string

Default Value

""

Remarks

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.



OAuthTokenTimestamp

Data Type

string

Default Value

""

Remarks

Pair with OAuthExpiresIn to determine when the AccessToken will expire.



OAuthJWTCert

Data Type

string

Default Value

""

Remarks

The name of the certificate store for the client certificate.

The OAuthJWTCertType field specifies the type of the certificate store specified by OAuthJWTCert. If the store is password protected, specify the password in OAuthJWTCertPassword.

OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, a search for a certificate is initiated. Please refer to the OAuthJWTCertSubject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.
SPCSoftware publisher certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).



OAuthJWTCertType

Data Type

string

Default Value

"USER"

Remarks

This property can take one of the following values:

USERFor Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
MACHINEFor Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
PFXFILEThe certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOBThe certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILEThe certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java.
JKSBLOBThe certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java.
PEMKEY_FILEThe certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOBThe certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILEThe certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOBThe certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILEThe certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOBThe certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILEThe certificate store is the name of a PKCS7 file containing certificates.
PPKFILEThe certificate store is the name of a file that contains a PPK (PuTTY Private Key).
XMLFILEThe certificate store is the name of a file that contains a certificate in XML format.
XMLBLOBThe certificate store is a string that contains a certificate in XML format.



OAuthJWTCertPassword

Data Type

string

Default Value

""

Remarks

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.



OAuthJWTCertSubject

Data Type

string

Default Value

"*"

Remarks

When loading a certificate the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks the first certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@cdata.com". Common fields and their meanings are displayed below.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma it must be quoted.



OAuthJWTIssuer

Data Type

string

Default Value

""

Remarks

The issuer of the Java Web Token. This is typically either the Client Id or Email Address of the OAuth Application.



OAuthJWTSubject

Data Type

string

Default Value

""

Remarks

The user subject for which the application is requesting delegated access. Typically, the user account name or email address.



KerberosKDC

Data Type

string

Default Value

""

Remarks

The Kerberos properties are used when using SPNEGO or Windows Authentication. The driver will request session tickets and temporary session keys from the Kerberos KDC service. The Kerberos KDC service is conventionally colocated with the domain controller.

If Kerberos KDC is not specified, the driver will attempt to detect these properties automatically from the following locations:

Note: Windows authentication is supported in JRE 1.6 and above only.



KerberosRealm

Data Type

string

Default Value

""

Remarks

The Kerberos properties are used when using SPNEGO or Windows Authentication. The Kerberos Realm is used to authenticate the user with the Kerberos Key Distribution Service (KDC). The Kerberos Realm can be configured by an administrator to be any string, but conventionally it is based on the domain name.

If Kerberos Realm is not specified the driver will attempt to detect these properties automatically from the following locations:

Note: Kerberos-based authentication is supported in JRE 1.6 and above only.



KerberosSPN

Data Type

string

Default Value

""

Remarks

If the SPN on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, use this property to set the SPN.



KerberosKeytabFile

Data Type

string

Default Value

""

Remarks

The Keytab file containing your pairs of Kerberos principals and encrypted keys.



KerberosServiceRealm

Data Type

string

Default Value

""

Remarks

The KerberosServiceRealm is the specify the service Kerberos realm when using cross-realm Kerberos authentication.

In most cases, a single realm and KDC machine are used to perform the Kerberos authentication and this property is not required.

This property is available for complex setups where a different realm and KDC machine are used to obtain an authentication ticket (AS request) and a service ticket (TGS request).



KerberosServiceKDC

Data Type

string

Default Value

""

Remarks

The KerberosServiceKDC is used to specify the service Kerberos KDC when using cross-realm Kerberos authentication.

In most cases, a single realm and KDC machine are used to perform the Kerberos authentication and this property is not required.

This property is available for complex setups where a different realm and KDC machine are used to obtain an authentication ticket (AS request) and a service ticket (TGS request).



KerberosTicketCache

Data Type

string

Default Value

""

Remarks

This property can be set if you wish to use a credential cache file that was created using the MIT Kerberos Ticket Manager or kinit command.



SSLClientCert

Data Type

string

Default Value

""

Remarks

The name of the certificate store for the client certificate.

The SSLClientCertType field specifies the type of the certificate store specified by SSLClientCert. If the store is password protected, specify the password in SSLClientCertPassword.

SSLClientCert is used in conjunction with the SSLClientCertSubject field in order to specify client certificates. If SSLClientCert has a value, and SSLClientCertSubject is set, a search for a certificate is initiated. See SSLClientCertSubject for more information.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.
SPCSoftware publisher certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (for example, PKCS12 certificate store).



SSLClientCertType

Data Type

string

Default Value

"USER"

Remarks

This property can take one of the following values:

USER - defaultFor Windows, this specifies that the certificate store is a certificate store owned by the current user. Note that this store type is not available in Java.
MACHINEFor Windows, this specifies that the certificate store is a machine store. Note that this store type is not available in Java.
PFXFILEThe certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOBThe certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILEThe certificate store is the name of a Java key store (JKS) file containing certificates. Note that this store type is only available in Java.
JKSBLOBThe certificate store is a string (base-64-encoded) representing a certificate store in JKS format. Note that this store type is only available in Java.
PEMKEY_FILEThe certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOBThe certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILEThe certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOBThe certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILEThe certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOBThe certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILEThe certificate store is the name of a PKCS7 file containing certificates.
PPKFILEThe certificate store is the name of a file that contains a PuTTY Private Key (PPK).
XMLFILEThe certificate store is the name of a file that contains a certificate in XML format.
XMLBLOBThe certificate store is a string that contains a certificate in XML format.



SSLClientCertPassword

Data Type

string

Default Value

""

Remarks

If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store.



SSLClientCertSubject

Data Type

string

Default Value

"*"

Remarks

When loading a certificate the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks the first certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For example, "CN=www.server.com, OU=test, C=US, E=support@company.com". The common fields and their meanings are shown below.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma, it must be quoted.



SSLServerCert

Data Type

string

Default Value

""

Remarks

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 is rejected.

This property can take the following forms:

Description Example
A full PEM Certificate (example shortened for brevity) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate C:\cert.cer
The public key (example shortened for brevity) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated) ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated) 34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.



FirewallType

Data Type

string

Default Value

"NONE"

Remarks

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

Type Default Port Description
TUNNEL 80 When this is set, the driver opens a connection to SharePoint and traffic flows back and forth through the proxy.
SOCKS4 1080 When this is set, the driver sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5 1080 When this is set, the driver sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

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



FirewallServer

Data Type

string

Default Value

""

Remarks

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 driver uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.



FirewallPort

Data Type

int

Default Value

0

Remarks

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.



FirewallUser

Data Type

string

Default Value

""

Remarks

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



FirewallPassword

Data Type

string

Default Value

""

Remarks

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



ProxyAutoDetect

Data Type

bool

Default Value

false

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

NOTE: When this property is set to True, the proxy used is determined as follows:

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.



ProxyServer

Data Type

string

Default Value

""

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The driver 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 FirewallType.

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



ProxyPort

Data Type

int

Default Value

80

Remarks

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 FirewallType.



ProxyAuthScheme

Data Type

string

Default Value

"BASIC"

Remarks

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

Note that the driver 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:

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



ProxyUser

Data Type

string

Default Value

""

Remarks

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 user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain

domain\user



ProxyPassword

Data Type

string

Default Value

""

Remarks

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 FirewallType.

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



ProxySSLType

Data Type

string

Default Value

"AUTO"

Remarks

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:

AUTODefault setting. If the URL is an HTTPS URL, the driver will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYSThe connection is always SSL enabled.
NEVERThe connection is not SSL enabled.
TUNNELThe connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.



ProxyExceptions

Data Type

string

Default Value

""

Remarks

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

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



Logfile

Data Type

string

Default Value

""

Remarks

Once this property is set, the driver will populate the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file doesn't already exist, it will be created.

Connection strings and version information are also logged, though connection properties containing sensitive information are masked automatically.

If a relative filepath is supplied, the location of the log file will be resolved based on the path found in the Location connection property.

For more control over what is written to the log file, you can adjust the Verbosity property.

Log contents are categorized into several modules. You can show/hide individual modules using the LogModules property.

To edit the maximum size of a single logfile before a new one is created, see MaxLogFileSize.

If you would like to place a cap on the number of logfiles generated, use MaxLogFileCount.

Java Logging

Java logging is also supported. To enable Java logging, set Logfile to:

Logfile=JAVALOG://myloggername

As in the above sample, JAVALOG:// is a required prefix to use Java logging, and you will substitute your own Logger.

The supplied Logger's getLogger method is then called, using the supplied value to create the Logger instance. If a logging instance already exists, it will reference the existing instance.

When Java logging is enabled, the Verbosity will now correspond to specific logging levels.



Verbosity

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the driver reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.



LogModules

Data Type

string

Default Value

""

Remarks

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

See the Logging page for an overview.



MaxLogFileSize

Data Type

string

Default Value

"100MB"

Remarks

When the limit is hit, a new log is created in the same folder with the date and time appended to the end. The default limit is 100 MB. Values lower than 100 kB will use 100 kB as the value instead.

Adjust the maximum number of logfiles generated with MaxLogFileCount.



MaxLogFileCount

Data Type

int

Default Value

-1

Remarks

When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.

The minimum supported value is 2. A value of 0 or a negative value indicates no limit on the count.

Adjust the maximum size of the logfiles generated with MaxLogFileSize.



Location

Data Type

string

Default Value

"%APPDATA%\\CData\\SharePoint Data Provider\\Schema"

Remarks

The path to a directory which contains the schema files for the driver (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

Note: Given that this driver supports multiple schemas, the structure for SharePoint custom schema files is as follows:

If left unspecified, the default location is "%APPDATA%\\CData\\SharePoint Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Mac ~/Library/Application Support
Linux ~/.config



BrowsableSchemas

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.



Tables

Data Type

string

Default Value

""

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the driver.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.



Views

Data Type

string

Default Value

""

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the driver.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.



Schema

Data Type

string

Default Value

"SOAP"

Remarks

The schemas available are REST (to use Sharepoint REST API) and SOAP (to use Sharepoint SOAP API).



AutoCache

Data Type

bool

Default Value

false

Remarks

When AutoCache = true, the driver automatically maintains a cache of your table's data in the database of your choice. By default, the driver incrementally updates the cache, retrieving only changes since the last SELECT query was run if the length of time since the last run has exceeded the CacheTolerance. After the cache is updated, the query is executed against the cached data.

Setting the Caching Database

When AutoCache = true, the driver caches to a simple, file-based cache. You can configure its location or cache to a different database with the following properties:

See Also



CacheDriver

Data Type

string

Default Value

""

Remarks

You can cache to any database for which you have a JDBC driver, including CData JDBC drivers.

The cache database is determined based on the CacheDriver and CacheConnection properties. The CacheDriver is the name of the JDBC driver class that you want to use to cache data.

Note that you must also add the CacheDriver JAR file to the classpath.

The following examples show how to cache to several major databases. Refer to CacheConnection for more information on the JDBC URL syntax and typical connection properties.

Derby and Java DB

The driver simplifies Derby configuration. Java DB is the Oracle distribution of Derby. The JAR file is shipped in the JDK. You can find the JAR file, derby.jar, in the db subfolder of the JDK installation. In most caching scenarios, you need to specify only the following, after adding derby.jar to the classpath:

jdbc:sharepoint:CacheLocation='c:/Temp/cachedir';User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;
To customize the Derby JDBC URL, use CacheDriver and CacheConnection. For example, to cache to an in-memory database, use a JDBC URL like the following:
jdbc:sharepoint:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;
SQLite

The following is a JDBC URL for the SQLite JDBC driver:

jdbc:sharepoint:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;
MySQL

The following is a JDBC URL for the included CData JDBC Driver for MySQL:

  jdbc:sharepoint:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;

  
SQL Server

The following JDBC URL uses the Microsoft JDBC Driver for SQL Server:

jdbc:sharepoint:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;
Oracle

The following is a JDBC URL for the Oracle Thin Client:

jdbc:sharepoint:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;
NOTE: If using a version of Oracle older than 9i, the cache driver will instead be oracle.jdbc.driver.OracleDriver .
PostgreSQL

The following JDBC URL uses the official PostgreSQL JDBC driver:

jdbc:sharepoint:CacheDriver=cdata.jdbc.postgresql.PostgreSQLDriver;CacheConnection='jdbc:postgresql:User=postgres;Password=admin;Database=postgres;Server=localhost;Port=5432;';User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;



CacheConnection

Data Type

string

Default Value

""

Remarks

The cache database is determined based on the CacheDriver and CacheConnection properties. Both properties are required to use the cache database. Examples of common cache database settings can be found below. For more information on setting the caching database's driver, refer to CacheDriver.

The connection string specified in the CacheConnection property is passed directly to the underlying CacheDriver. Consult the documentation for the specific JDBC driver for more information on the available properties. Make sure to include the JDBC driver in your application's classpath.

Derby and Java DB

The driver simplifies caching to Derby, only requiring you to set the CacheLocation property to make a basic connection.

Alternatively, you can configure the connection to Derby manually using CacheDriver and CacheConnection. The following is the Derby JDBC URL syntax:

jdbc:derby:[subsubprotocol:][databaseName][;attribute=value[;attribute=value] ... ]
For example, to cache to an in-memory database, use the following:
jdbc:derby:memory

SQLite

To cache to SQLite, you can use the SQLite JDBC driver. The following is the syntax of the JDBC URL:

jdbc:sqlite:dataSource

MySQL

The installation includes the CData JDBC Driver for MySQL. The following is an example JDBC URL:

jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache
The following are typical connection properties:

SQL Server

The JDBC URL for the Microsoft JDBC Driver for SQL Server has the following syntax:

jdbc:sqlserver://[serverName[\instance][:port]][;database=databaseName][;property=value[;property=value] ... ]
For example:
jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=true
The following are typical SQL Server connection properties:
Oracle

The following is the conventional JDBC URL syntax for the Oracle JDBC Thin driver:

jdbc:oracle:thin:[userId/password]@[//]host[[:port][:sid]]
For example:
jdbc:oracle:thin:scott/tiger@myhost:1521:orcl
The following are typical connection properties:
PostgreSQL

The following is the JDBC URL syntax for the official PostgreSQL JDBC driver:

jdbc:postgresql:[//[host[:port]]/]database[[?option=value][[&option=value][&option=value] ... ]]
For example, the following connection string connects to a database on the default host (localhost) and port (5432):
jdbc:postgresql:postgres
The following are typical connection properties:



CacheLocation

Data Type

string

Default Value

"%APPDATA%\\CData\\SharePoint Data Provider"

Remarks

The CacheLocation is a simple, file-based cache. The driver uses Java DB, Oracle's distribution of the Derby database. To cache to Java DB, you will need to add the Java DB JAR file to the classpath. The JAR file, derby.jar, is shipped in the JDK and located in the db subfolder of the JDK installation.

If left unspecified, the default location is "%APPDATA%\\CData\\SharePoint Data Provider" with %APPDATA% being set to the user's configuration directory:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Mac ~/Library/Application Support
Linux ~/.config

See Also



CacheTolerance

Data Type

int

Default Value

600

Remarks

The tolerance for stale data in the cache specified in seconds. This only applies when AutoCache is used. The driver checks with the data source for newer records after the tolerance interval has expired. Otherwise, it returns the data directly from the cache.



Offline

Data Type

bool

Default Value

false

Remarks

When Offline = true, all queries execute against the cache as opposed to the live data source. In this mode, certain queries like INSERT, UPDATE, DELETE, and CACHE are not allowed.



CacheMetadata

Data Type

bool

Default Value

false

Remarks

As you execute queries with this property set, table metadata in the SharePoint catalog are cached to the file store specified by CacheLocation if set or the user's home directory otherwise. A table's metadata will be retrieved only once, when the table is queried for the first time.

When to Use CacheMetadata

The driver automatically persists metadata in memory for up to two hours when you first discover the metadata for a table or view and therefore, CacheMetadata is generally not required. CacheMetadata becomes useful when metadata operations are expensive such as when you are working with large amounts of metadata or when you have many short-lived connections.

When Not to Use CacheMetadata



BatchSize

Data Type

int

Default Value

0

Remarks

When BatchSize is set to a value greater than 0, the batch operation will split the entire batch into separate batches of size BatchSize. The split batches will then be submitted to the server individually. This is useful when the server has limitations on the size of the request that can be submitted.

Setting BatchSize to 0 will submit the entire batch as specified.



CalculatedDataType

Data Type

string

Default Value

"Calculated"

Remarks

The data type to be used for calculated fields. By default (Calculated), the data type is determined by the type of calculated field in SharePoint. However, in some cases these calculated fields may return values that are not appropriate for the specified type. In these instances, you may wish to set the Calculated Data Type to the appropriate type.



ConnectionLifeTime

Data Type

int

Default Value

0

Remarks

The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. The default is 0 which indicates there is no limit to the connection lifetime.



ConnectOnOpen

Data Type

bool

Default Value

false

Remarks

When set to true, a connection will be made to SharePoint when the connection is opened. This property enables the Test Connection feature available in various database tools.

This feature acts as a NOOP command as it is used to verify a connection can be made to SharePoint and nothing from this initial connection is maintained.

Setting this property to false may provide performance improvements (depending upon the number of times a connection is opened).



ContinueOnError

Data Type

bool

Default Value

true

Remarks

If this property is set to True (default), the driver will continue adding, updating, or deleting items when an error is encountered on one of the items. When set to False, the driver will stop adding, updating, or deleting items after an error is encountered (entries preceeding the problematic entry will still be added, updated, or deleted).



CreateIDColumns

Data Type

bool

Default Value

true

Remarks

Indicates whether or not to create supplemental ID columns for SharePoint columns that use values from information stored in other Lists (like "Lookup" or "Person or Group" columns). The ID column that is created will contain the related entry's ID (in the context of its original List). If set to false, the ID columns will not be created, the ID will be ignored, and only the value of the referenced column will be returned.



FolderOption

Data Type

string

Default Value

"RecursiveAll"

Remarks

An option to determine how to display folders in results. FilesOnly will display only files in specified lists or libraries. FilesAndFolders will display files and folders in the specified list. RecursiveAll will display files in the specified list and all subfolders.



IncludeLookupColumns

Data Type

bool

Default Value

true

Remarks

This option controls whether the driver returns the lookup columns defined on a table. The SharePoint server may reject the request if too many lookup columns are included in a single query.



MaxRows

Data Type

int

Default Value

-1

Remarks

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

Data Type

string

Default Value

""

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Caching Configuration

CachePartial=TrueCaches only a subset of columns, which you can specify in your query.
QueryPassthrough=TruePasses the specified query to the cache database instead of using the SQL parser of the driver.

Integration and Formatting

DefaultColumnSizeSets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMTDetermines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filenameRecords the underlying socket data transfer to the specified file.



Pagesize

Data Type

int

Default Value

1000

Remarks

The Pagesize property affects the maximum number of results to return per page from SharePoint. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.



PoolIdleTimeout

Data Type

int

Default Value

60

Remarks

The allowed idle time a connection can remain in the pool until the connection is closed. The default is 60 seconds.



PoolMaxSize

Data Type

int

Default Value

100

Remarks

The maximum connections in the pool. The default is 100. To disable this property, set the property value to 0 or less.



PoolMinSize

Data Type

int

Default Value

1

Remarks

The minimum number of connections in the pool. The default is 1.



PoolWaitTime

Data Type

int

Default Value

60

Remarks

The max seconds to wait for a connection to become available. If a new connection request is waiting for an available connection and exceeds this time, an error is thrown. By default, new requests wait forever for an available connection.



PseudoColumns

Data Type

string

Default Value

""

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".



Readonly

Data Type

bool

Default Value

false

Remarks

If this property is set to true, the driver will allow only SELECT queries. INSERT, UPDATE, DELETE, and stored procedure queries will cause an error to be thrown.



RTK

Data Type

string

Default Value

""

Remarks

The RTK property may be used to license a build. See the included licensing file to see how to set this property. The runtime key is only available if you purchased an OEM license.



ShowHiddenColumns

Data Type

bool

Default Value

false

Remarks

Boolean determining if hidden columns should be shown or not. If false, all hidden columns will be removed from the column listing.



ShowPredefinedColumns

Data Type

bool

Default Value

true

Remarks

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. These columns are normally system columns such as CreatedBy and Author. But, predefined columns may also include common columns such as Title.



ShowVersionViews

Data Type

bool

Default Value

false

Remarks

Indicate whether to display the view of list versions. Such as ListA_Versions.



STSURL

Data Type

string

Default Value

""

Remarks

The URL of the security token service (STS) when using single sign-on (SSO). This rarely needs to be set explicitly.



SupportEnhancedSQL

Data Type

bool

Default Value

true

Remarks

When SupportEnhancedSQL = true, the driver offloads as much of the SELECT statement processing as possible to SharePoint and then processes the rest of the query in memory. In this way, the driver can execute unsupported predicates, joins, and aggregation.

When SupportEnhancedSQL = false, the driver limits SQL execution to what is supported by the SharePoint API.

Execution of Predicates

The driver determines which of the clauses are supported by the data source and then pushes them to the source to get the smallest superset of rows that would satisfy the query. It then filters the rest of the rows locally. The filter operation is streamed, which enables the driver to filter effectively for even very large datasets.

Execution of Joins

The driver uses various techniques to join in memory. The driver trades off memory utilization against the requirement of reading the same table more than once.

Execution of Aggregates

The driver retrieves all rows necessary to process the aggregation in memory.



Timeout

Data Type

int

Default Value

60

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

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



UseConnectionPooling

Data Type

bool

Default Value

false

Remarks

This property enables connection pooling. The default is false. See Connection Pooling for information on using connection pools.



UseDisplayNames

Data Type

bool

Default Value

true

Remarks

Boolean determining if the display names for the columns should be used instead of the API names.



UseNTLMV1

Data Type

bool

Default Value

false

Remarks

Determines whether the driver will attempt to connect with NTLMv1 or NTLMv2 (default).



UseSimpleNames

Data Type

bool

Default Value

false

Remarks

SharePoint tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the driver easier to use with traditional database tools.

Setting UseSimpleNames to true will simplify the names of tables and columns returned. It will enforce a naming scheme such that only alphanumeric characters and the underscore are valid for the displayed table and column names. Any nonalphanumeric characters will be converted to an underscore.





TablesBack To Top

  1. Announcements
  2. Attachments
  3. Calendar
  4. Contacts
  5. Documents
  6. Groups
  7. IssueTracking
  8. Links
  9. Pictures
  10. Roles
  11. Tasks
  12. Users
  13. Views

Announcements

Create, update, delete, and query items in Announcement lists.

Columns

Name Type ReadOnly Description
ID [KEY] String True

The ID of the item. The format of the ID is: List|ItemID.

List String False

The name of the list.

Title String False

The title of the item.

Body String False

The body of the item.

Expires Date False

The date the item expires on.

Author String False

The user that created the item.

Editor String False

The last user that modified the item.

Modified Date False

The date modified.

Created Date False

The date created.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
CAMLQuery String

The query to be used while listing the list items.



Attachments

Read or delete Attachments for the specified item on the specified list.

Table Specific Information
Select

List and ItemId are required to return Attachments.

Columns

Name Type ReadOnly Description
Url [KEY] String True

Description of the term set.

List String True

The list to retrieve attachments from.

ItemID String True

The ID of the item on the list to retrieve attachments from.

Name String True

The name of the attachment on the item.



Calendar

Create, update, query, and delete items in SharePoint Calendar lists.

Columns

Name Type ReadOnly Description
ID [KEY] String True

The ID of the calendar entry. The format of the ID is: List|ItemID.

List String False

The name of the calendar list.

Title String False

The title of the entry.

ParticipantsPicker String False

The attendees of the calendar entry.

FreeBusy String False

A flag indicating the free or busy status during the event.

Facilities String False

The resources for this calendar entry.

Location String False

The location of the event.

EventDate Date False

The date the calendar entry starts.

EndDate Date False

The date the calendar entry ends.

Description String False

The description of the event.

Duration String False

The duration of the calendar entry.

EventType String False

The type of the event.

IsAllDayEvent String False

A flag indicating whether the entry is an all day event or not.

fRecurrence String False

A flag indicating whether this is a recurring event.

Author String False

The user that created the item.

Editor String False

The last user that modified the item.

Modified Date False

The date modified.

Created Date False

The date created.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
CAMLQuery String

The query to be used while listing the list items.



Contacts

Create, update, query, and delete items in SharePoint Contact lists.

Columns

Name Type ReadOnly Description
ID [KEY] String True

The ID of the item. The value of this field is of the format: List|ItemId

List String False

The name of the contacts list.

FirstName String False

The first name of the contact.

Title String False

The last name of the contact.

FullName String False

The full name of the contact.

Email String False

The email of the entry.

Company String False

The company the contact works for.

JobTitle String False

The job title of the contact.

WorkPhone String False

The business phone of the contact.

HomePhone String False

The home phone of the contact.

CellPhone String False

The mobile phone of the contact.

WorkFax String False

The fax number of the contact.

WorkAddress String False

The address of the contact.

WorkCity String False

City for the address of the contact.

WorkState String False

State for the address of the contact.

WorkZip String False

Postal code for the address of the contact.

WorkCountry String False

Country for the address of the contact.

WebPage String False

Web page for the contact.

Comments String False

Notes about the contact.

Author String False

The user that created the item.

Editor String False

The last user that modified the item.

Modified Date False

The date modified.

Created Date False

The date created.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
CAMLQuery String

The query to be used while listing the list items.



Documents

Create, update, delete, and query Documents from SharePoint libraries.

Table Specific Information

Select

To pull items in a folder, you need to use the either the Path or FileDirRef field (depending on whether UseDisplayNames is True or False respectively) in the WHERE clause. For example:

SELECT * FROM MyDocumentLibrary WHERE SubFolder='MyDocumentLibrary/MyFolder'

Columns

Name Type ReadOnly Description
ID [KEY] String True

The ID of the document. The format of the ID is: List|ItemID.

List String False

The name of the document list.

LinkFileName String False

The title of the document.

CheckOutUser String False

The user that the document is checked out to.

Author String False

The user that created the item.

Editor String False

The last user that modified the item.

Modified Date False

The date modified.

Created Date False

The date created.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Subfolder String

A subfolder to specify if you would like to list documents in subfolders as well. Use * to denote all subfolders.

The default value is *.

CAMLQuery String

The query to be used while listing the list items.



Groups

Create, update, delete, and query Groups from SharePoint.

Table Specific Information

Columns

Name Type ReadOnly Description
Name# [KEY] String False

The name of the group.

Description# String False

A description of the group.

OwnerLogin# String False

The user name of the owner of the group. This value should be in the format DOMAIN\\username.

OwnerType# String False

The type of owner. User or group.

DefaultLogin# String False

The user name of the default user for the group. This value should be in the format DOMAIN\\username.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
UserName String

The logical name of the user to return groups for. Specify this value on the SELECT statement to return only groups the specified User is in.



IssueTracking

Create, update, query, and delete items in SharePoint Issue Tracking lists.

Columns

Name Type ReadOnly Description
ID [KEY] String True

The ID of the list entry. The format of the ID is: List|ItemID.

List String False

The name of the issue tracking list.

Title String False

The title of the entry.

AssignedTo String False

The user the issue is assigned to.

Status String False

The status of the issue.

Priority String False

The priority assigned to this issue.

Category String False

The category that the issue belongs to.

DueDate Date False

The due date of the issue.

RelatedIssues String False

A list of related issues.

Comments String False

Comments associated with this issue.

Author String False

The user that created the item.

Editor String False

The last user that modified the item.

Modified Date False

The date modified.

Created Date False

The date created.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
CAMLQuery String

The query to be used while listing the list items.



Links

Create, update, query, and delete items in SharePoint Link lists.

Columns

Name Type ReadOnly Description
ID [KEY] String True

The ID of the item. The format of the ID is: List|ItemID.

List String False

The name of the link list.

URL String False

The URL of the link entry.

Comments String False

The notes associated with the entry.

Author String False

The user that created the item.

Editor String False

The last user that modified the item.

Modified Date False

The date modified.

Created Date False

The date created.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
CAMLQuery String

The query to be used while listing the list items.



Pictures

Create, update, delete, and query documents in a picture library.

Columns

Name Type ReadOnly Description
ID [KEY] String True

The ID of the document. The format of the ID is: List|ItemID.

List String False

The name of the list the document belongs to.

LinkFileName String False

The filename of the document on the server.

ImageCreateDate Date False

The date the picture was taken.

Description String False

The description associated with the document.

Keywords String False

The keywords associated with the document.

CheckedOutUser String False

The user the document is checked out to.

Author String False

The user that created the item.

Editor String False

The last user that modified the item.

Modified Date False

The date that the document was modified.

Created Date False

The date that the document was created.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
CAMLQuery String

The query to be used while listing the list items.



Roles

Create, update, delete, and query Roles from SharePoint.

Table Specific Information
Select

To use the UserName pseudo column, you must set the value to the LoginName of the user. You can obtain the LoginName by querying the Users table.

Columns

Name Type ReadOnly Description
Name# [KEY] String False

The name of the role.

Description# String False

A description of the role.

Permissions# Long False

A long representing the permissions for the role.

RoleType String True

The type of role.

IsHidden Boolean True

A boolean indicating if the role is hidden.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
UserName String

The login name of the user to return roles for. Specify this value on a SELECT statement to return only roles assigned to the specified user.

GroupName String

The name of the group to return roles for. Specify this value on a SELECT statement to return only roles assigned to the specified group.



Tasks

Create, update, query, and delete items in a SharePoint Tasks list.

Columns

Name Type ReadOnly Description
ID [KEY] String True

The ID of the item. The format of the ID is: List|ItemID.

List String False

The name of the issue tracking list.

Title String False

The title of the item.

Priority String False

The priority of the task.

Status String False

The status of the task.

PercentComplete String False

The completed progress of the task, expressed as a percentage.

AssignedTo String False

The SharePoint user the task is assigned to.

TaskGroup String False

The SharePoint group the task is assigned to.

Body String False

The description of the item.

StartDate Date False

The start date of the task.

DueDate Date False

The due date of the task.

WorkflowName String False

The name of the workflow associated with the task.

Author String False

The user that created the item.

Editor String False

The last user that modified the item.

Modified Date False

The date modified.

Created Date False

The date created.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
CAMLQuery String

The query to be used while listing the list items.



Users

Create, update, delete, and query Users from SharePoint.

Table Specific Information
Select

Retrieve all users created for the SharePoint Account:

SELECT * FROM Users

You can retrieve Users that belong to a specific Group. In this case specify the Group Name

Select * FROM Users WHERE [Group]="GroupName"

Or you can retrieve Users that have a specific Role. In this case specify the Role Name

Select * FROM Users WHERE [Role]="RoleName"

Columns

Name Type ReadOnly Description
LoginName# [KEY] String False

The login name of the user.

Name# String False

The name of the user.

Email# String False

The email address of the user.

IsInDomainGroup Boolean True

A boolean indicating if the user is in the domain group.

IsSiteAdmin Boolean True

A boolean indicating if the user is a site admin.

Notes# String False

Optional notes concerning the user.

SecurityId String True

The security Id (SID) for the user.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Group String

The group you are adding a user to or deleting the user from. This is an input-only value and either Group or Role must be specified for inserts, but may be optionally specified for deletions.

Role String

The role you are adding a user to or deleting the user from. This is an input-only value and either Group or Role must be specified for inserts, but may be optionally specified for deletions.

NewName String

The new name of the user. Specify this value when updating the user to change the name of the user.



Views

Create, update, delete, and query the available lists in SharePoint.

Table Specific Information

Views is a special table. It may be used to get, update, insert, and delete views from a specified List.

Select
In order to return results from Views, either the Id or List must be specified in the SELECT statement. For example:


SELECT * FROM Views WHERE List='MyListName'

Columns

Name Type ReadOnly Description
ID [KEY] String True

The Id of the view.

List String True

The list the view is associated with. A list must be specified when performing SELECT statements if the Id is not specified.

ViewID String True

The Id of the view. May only be unique for the specific list.

Name String False

The name of the view.

Type String False

The type of view. This must have a value on inserts and updates.

The allowed values are CALENDAR, GRID, HTML.

The default value is HTML.

Fields String False

A comma separated list of the fields associated with the view. This is space-sensitive.

IsDefault Boolean False

A boolean indicating if the view is the default view for the list.

Query String False

A query for the view.





ViewsBack To Top

  1. FileVersions
  2. GetValidTerms
  3. Lists
  4. Permissions
  5. Subsites

FileVersions

Lists the versions of files available on SharePoint.

View-Specific Information

Library and File must be specified to return results from this view.

Columns

Name Type Description
ID [KEY] String The ID of the version.
Comments String Comments about the particular version.
CreateBy String The username of the SharePoint user who modified this version of the file.
Date Datetime When the file was modified.
Size String The size of this version of the file.
Url String The URL to this version of the file.
Library String The library name on SharePoint you are listing versions from. A library must be specified to retrieve the versions for a file.

The default value is Shared Documents.

File String The name of the file on SharePoint to list versions for. A file must be specified to retrieve the versions for a file.



GetValidTerms

Gets a list of valid terms for the specified column on the specified table.

Table Specific Information

GetValidTerms is a special view. It may be used to get valid terms for a Taxonomy or Managed Metadata column of a given list. To use the view, supply both the name of the table and the column for which you are looking to get valid terms. For example:


SELECT * FROM GetValidTerms WHERE List='MyListName' AND ColumnName='MyManagedMetadataColumn'
Columns

Name Type Description
ID [KEY] String The identifier of the term.
TermLabelValue String The label of the term.
Description String Description of the term set.
NameInRequestedLang String The name of the term set in the language requested by the client.
IsOpen Boolean Boolean indicating if the term set is open.
Deprecated Boolean Boolean indicating if the term is deprecated.
InternalId String Internal identifier for the term.
TermSetContact String Term set contact.
ContainerDesc String Container node for the description.
SingleTermLabelDesc String This fully describes a single term label.
IsDefaultLabel Boolean True if the term label is the default term label.
BelongsTo String This item describes a term set to which a term belongs.
IsTaggingAvailable Boolean If the term set is available for tagging, this value is true.
TermPath String Term path of the term with term labels.
TermpathoftermwithIds String Term path of term with identifiers.
ChildTerms String A string value that indicates a custom sort order for the child terms of the term identified by PertainingToTerm.
HasChildTerms Boolean True if the term has child terms.
PertainingToTerm Boolean Identifier of the term that this term set information is pertaining to.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
List String The name of the list to get valid terms for.
ColumnName String The name of the column to get valid terms for.
LocaleId String The locale Id for the term. Defaults to 1033.



Lists

Lists the available lists in SharePoint.

Table Specific Information

Lists can be used to list the tables in SharePoint. This will only return actual lists in SharePoint and not any special tables associated with the driver.

The following columns can be used in the WHERE clause: Title and BaseTemplate.

Columns

Name Type Description
ID [KEY] String The Id of the list.
Title String The title of the list. This column may be used in the WHERE clause and may be used with a wild card (*) character.
Description String A description for the list.
BaseTemplate String Indicates the type of template used to create the list. This column may be used in the WHERE clause.
Version Double The version of the list.
Url String The default URL of the list.
EmailAlias String The email alias of the list.
ImageUrl String The image URL of the list.
ItemCount Integer The number of items in the list.
Item_Deleted Datetime The last time an item was deleted from this list.
Item_Modified Datetime The last time an item was modified from this list.
SendToUrl String The send-to URL of the list.
Created Datetime The time when the list was created.
AllowDeletion String Whether items can be deleted.
AllowMultiResponses Boolean Boolean indicating if multiple responses are enabled for the survey.
Direction String A string that contains LTR if the reading order is left-to-right, RTL if it is right-to-left, or None.
EnableAssignedToEmail Boolean Boolean indicating if assigned-to emails are enabled. Only applies to issues lists.
EnableAttachments Boolean Boolean indicating if attachments may be added to items in the list. Does not apply to document libraries.
EnableModeration Boolean Boolean indicating if content approval is enabled for the list.
EnableVersioning Boolean Boolean indicating if versioning is enabled for the list.
Hidden Boolean Boolean indicating if the list is hidden so that it does not appear on the Documents and Lists page, Quick Launch bar, Modify Site Content page, or Add Column page as an option for lookup fields.
MultipleDataList Boolean Boolean indicating if a meeting-workspace site contains data for multiple meeting instances within the site.
Ordered Boolean Boolean indicating if items in the list can be sorted on the Edit View page.
Showuser Boolean Boolean indicating if the names of users are shown in the results of the survey.



Permissions

The permissions for a site or list. Note: If ItemID is empty, the ObjectType should be set to List or web (an ObjectName must be specified when the ObjectType is list). If not, the ObjectName must be specified along with the ItemID.

Columns

Name Type Description
MemberID [KEY] String The ID of the permission.
Mask Long A 32-bit integer in 0x00000000 format that represents a Microsoft.SharePoint.SPRights value and defines the permission. Use the pipe symbol ('|') in C# or Or in Microsoft Visual Basic to delimit values when creating a custom permission mask that combines permissions.
MemberIsUser Bool Indicate whether it is the permission for user.
MemberGlobal Bool Indicate whether it is the permission for group.
RoleName String A string that contains the name of the site group, the name of the cross-site group, or the user name (DOMAIN\User_Alias) of the user to whom the permission applies.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ObjectName String A string that contains the name of the list or site.
ObjectType String A string that specifies either List or Web.
ItemID String ID of the item.



Subsites

This lists the available subsites.

Columns

Name Type Description
Title String The name of the subsite.
Url String The url of the subsite.