Adding a Connection to Microsoft SharePoint

To add a connection to Microsoft SharePoint:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the Microsoft SharePoint icon is not available, click the Add More icon to download and install the Microsoft SharePoint connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to Microsoft SharePoint

Regardless of whether you will connect online or on-premesis, what architecture will be used, and which Lists and Documents will be accessed, connecting to Microsoft SharePoint requires exactly two things:

• Set the URL connection property.
• Set the appropriate authentication properties for your working environment.

Setting URL:

Microsoft SharePoint works with all Lists and Documents in the global Microsoft Sharepoint site, or all Lists and Documents at individual sites.

To work with all Lists and Documents in the global Microsoft Sharepoint site, set the URL connection property to your Site Collection URL. For example:

https://teams.contoso.com

To work with all Lists and Documents at an individual site, set the URL connection property to your individual site URL. For example:

 https://teams.contoso.com/TeamA

The following sections describe how to set the appropriate authentication properties for your working environment. For information about how to create a custom OAuth application (required for use with AzureAD in a Web application; optional for AzureAD access via a Desktop application or a Headless Server), see Creating a Custom OAuth Application.

Microsoft SharePoint Online

Set SharePointEdition to "SharePoint Online" and set the User and Password to the credentials you use to log onto SharePoint, for example, the credentials to your Microsoft Online Services account.

Microsoft SharePoint online supports a number of cloud-based architectures, each of which supports a different set of authentication schemes:

• AzureAD
• Single sign-on (SSO) via the ADFS, Okta, OneLogin, or PingFederate SSO identity provider
• Azure MSI
• Azure Password
• OAuthJWT
• SharePointOAuth

If the user account domain is different from the domain configured with the identity provider, set SSODomain to the latter. This property may be required for any SSO.

AzureAD

Azure Active Directory (AzureAD) is a connection type that leverages OAuth to authenticate. OAuth requires the authenticating user to interact with Microsoft SharePoint using an internet browser. The driver facilitates this in several ways as described below. Set your AuthScheme to AzureAD. The AzureAD flows described below assume that you have done so.

Your organization may require Admin Consent when authorizing a new AzureAD application for your Azure Tenant. In all AzureAD flows, any initial installation and use of an AzureAD application requires that an administrator approve the application for their Azure Tenant. For details, see Creating a Custom OAuth Application.

Single Sign-On Identity Providers

ADFS

Set the AuthScheme to ADFS. You must set the following connection properties:

• User: The ADFS user.
• Password: The user's ADFS password.
• SSODomain (optional): The domain configured with the ADFS identity provider.

Example connection string:

AuthScheme=ADFS;User=ADFSUserName;Password=ADFSPassword;URL='http://sharepointserver/mysite';

Okta

Set the AuthScheme to Okta. The following connection properties are used to connect to Okta:

• User: The Okta user.
• Password: The user's Okta password.
• SSODomain (optional): The domain configured with the OKTA identity provider.

Example connection string:

AuthScheme=Okta;User=oktaUserName;Password=oktaPassword;URL='http://sharepointserver/mysite';

OneLogin

Set the AuthScheme to OneLogin. The following connection properties are used to connect to OneLogin:

• User: The OneLogin user.
• Password: The user's OneLogin password.
• SSODomain (optional): The domain configured with the OneLogin identity provider.

Example connection string:

AuthScheme=OneLogin;User=OneLoginUserName;Password=OneLoginPassword;URL='http://sharepointserver/mysite';

PingFederate

Set the AuthScheme to PingFederate. The following connection properties are used to connect to PingFederate:

• User: The PingFederate user.
• Password: PingFederate password for the user.
• SSODomain (optional): The domain configured with the PingFederate identity provider.

Example connection string:

AuthScheme=PingFederate;User=PingFederateUserName;Password=PingFederatePassword;URL='http://sharepointserver/mysite';

Azure MSI

If you are running Microsoft SharePoint on an Azure VM, you can leverage Azure Managed Service Identity (MSI) credentials to connect:

• AuthScheme: AzureMSI.

The MSI credentials are automatically obtained for authentication.

Azure Password

To connect using your Azure dredentials directly, specify the following connection properties:

• AuthScheme: AzurePassword
• User: The user account used to connect to Azure
• Password: The password used to connect to Azure
• AzureTenant: Directory (tenant) ID, found on the Overview page of the OAuth application used to authenticate to Microsoft SharePoint on Azure.

OAuthJWT Certificate

Set the AuthScheme to OAUTHJWT. The following connection properties are used to connect to Microsoft SharePoint:

• AzureTenant: The tenant you wish to connect to.
• OAuthJWTCert: The JWT certificate store.
• OAuthJWTCertType: The type of key store containing the JWT certificate.
• OAuthJWTIssuer: The OAuth client Id.
• OAuthJWTCertPassword: The password associated with the JWT certificate. Set this is your certificate type requires a password.

SharePointOAuth

Set the AuthScheme to SharePointOAuth. The following connection properties are used to connect to SharePointOAuth:

• Schema: REST.
• InitiateOAuth: GETANDREFRESH.
• OAuthClientId: The application's identity/Client Id.
• OAuthClientSecret: The application's Client Secret.

Example connection string:

SharePointEdition='SharepointOnline';URL=https://rssbuscrm.sharepoint.com;Schema=REST;AuthScheme=SharepointOAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=11111111-1111-1111-1111-111111111111;OAuthClientSecret=1111111111111/11111111111111/11111111111111=;

This AuthScheme works with the custom OAuth application. To generate credentials from a custom OAuth application, see Creating a Custom OAuth Application.

Microsoft SharePoint REST API is supported both on Sharepoint OnPremise and on Sharepoint Online. To connect using the REST API set Schema to REST.

The property SharePointEdition may be used to define the edition of Sharepoint.

Sharepoint Online

SharePoint Online uses OAuth standard to authenticate. Follow the steps under "Authenticating to SharePoint Online" in Establishing a Connection for more information.

Sharepoint OnPremise

Follow the steps under "Authenticating to SharePoint On Premises" in Establishing a Connection for more information.

Kerberos

To authenticate to Microsoft SharePoint with Kerberos, set AuthScheme to NEGOTIATE.

Authenticating to Microsoft SharePoint via Kerberos requires you to define authentication properties and to choose how Kerberos should retrieve authentication tickets.

Retrieve Kerberos Tickets

Kerberos tickets are used to authenticate the requester's identity. The use of tickets instead of formal logins/passwords eliminates the need to store passwords locally or send them over a network. Users are reauthenticated (tickets are refreshed) whenever they log in at their local computer or enter kinit USER at the command prompt.

The Sync App provides three ways to retrieve the required Kerberos ticket, depending on whether or not the KRB5CCNAME and/or KerberosKeytabFile variables exist in your environment.

MIT Kerberos Credential Cache File

This option enables you to use the MIT Kerberos Ticket Manager or kinit command to get tickets. With this option there is no need to set the User or Password connection properties.

This option requires that KRB5CCNAME has been created in your system.

To enable ticket retrieval via MIT Kerberos Credential Cache Files:

1. Ensure that the KRB5CCNAME variable is present in your environment.
2. Set KRB5CCNAME to a path that points to your credential cache file. (For example, C:\krb_cache\krb5cc_0 or /tmp/krb5cc_0.) The credential cache file is created when you use the MIT Kerberos Ticket Manager to generate your ticket.
3. To obtain a ticket:
   1. Open the MIT Kerberos Ticket Manager application.
   2. Click Get Ticket.
   3. Enter your principal name and password.
   4. Click OK.

   If the ticket is successfully obtained, the ticket information appears in Kerberos Ticket Manager and is stored in the credential cache file.

The Sync App uses the cache file to obtain the Kerberos ticket to connect to Microsoft SharePoint.

Note: If you would prefer not to edit KRB5CCNAME, you can use the KerberosTicketCache property to set the file path manually. After this is set, the Sync App uses the specified cache file to obtain the Kerberos ticket to connect to Microsoft SharePoint.

Keytab File

If your environment lacks the KRB5CCNAME environment variable, you can retrieve a Kerberos ticket using a Keytab File.

To use this method, set the User property to the desired username, and set the KerberosKeytabFile property to a file path pointing to the keytab file associated with the user.

User and Password

If your environment lacks the KRB5CCNAME environment variable and the KerberosKeytabFile property has not been set, you can retrieve a ticket using a user and password combination.

To use this method, set the User and Password properties to the user/password combination that you use to authenticate with Microsoft SharePoint.

Enabling Cross-Realm Authentication

More complex Kerberos environments can require cross-realm authentication where multiple realms and KDC servers are used. For example, they might use one realm/KDC for user authentication, and another realm/KDC for obtaining the service ticket.

To enable this kind of cross-realm authentication, set the KerberosRealm and KerberosKDC properties to the values required for user authentication. Also, set the KerberosServiceRealm and KerberosServiceKDC properties to the values required to obtain the service ticket.

Fine Tuning the Microsoft SharePoint Connection

To make it easier to access data in advanced integrations, use the following connection properties to control column name identifiers and other aspects of data access:

• UseDisplayNames: Set this to true to return column names that match field names in the underlying API.
  By default, the Sync App uses column names that match the field names defined in SharePoint.
• UseSimpleNames: Set this to true to perform substitutions on special characters in column names that SharePoint allows but that many databases typically do not.
• ShowPredefinedColumns: Set this to false to exclude fields derived from fields in the list; for example, Author and CreatedAt.
  This setting excludes the predefined fields from being returned in SELECT * statements and schema discovery.
• ShowHiddenColumns: When true, columns marked as hidden in SharePoint will be displayed by the Sync App.

This section details a selection of advanced features of the Microsoft SharePoint Sync App.

User Defined Views

The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Microsoft SharePoint and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Client SSL Certificates

The Microsoft SharePoint Sync App also supports setting client certificates. Set the following to connect using a client certificate.

• SSLClientCert: The name of the certificate store for the client certificate.
• 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.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Sync App uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Sync App models Microsoft SharePoint entities in relational Tables, Views, and Stored Procedures. The table definitions are dynamically obtained based on your Microsoft SharePoint site. Any changes you make, such as adding a custom field or changing a field's data type, are automatically reflected when you connect.

Customizing the Data Model

The Sync App sets defaults to facilitate the maximum number of integrations; however, the following connection properties allow a greater granularity of customization, which is useful in advanced integrations:

• CalculatedDataType: The data type to be used for calculated fields.
• 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.
• PseudoColumns: Indicates whether to report pseudo columns as columns in the table metadata.

Tables

Tables describes the available tables.

The Sync App can expose custom lists from Microsoft SharePoint that are not mentioned in the Tables. The data model illustrates a sample of what your SharePoint site might look like. The actual data model will be obtained dynamically based on your user credentials and SharePoint site.

Views

Typically, entities that cannot be modified are represented as Views, or read-only tables. You can also access custom views of a list as relational views.

To get data from a custom view of a list, you can set the ViewID pseudo column in the WHERE clause.

SELECT * FROM ListName WHERE ViewID='ID of the view'

You can get the ID of the view from the Views list. You must specify the List pseudo column to get a list of views for that list. For instance:

SELECT * FROM Views WHERE List ='ListName'

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They surface additional capabilities of the Microsoft SharePoint API such as searching, updating, and modifying information.

The Sync App maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.

Microsoft SharePoint	CData Schema
Choice (menu)	string
Currency	float
Date and Time	datetime
Hyperlink or Picture	string
Lookup	string
Multiple lines of text	string
Number	float
Person or Group	string
Single line of text	string
Task Outcome	string
Yes/No	bool

The Sync App models the data in Microsoft SharePoint as a list of tables in a relational database that can be queried using standard SQL statements.

Microsoft SharePoint Connector for CData Sync Tables

Name	Description
Attachments	Reads or deletes attachments to the specified item on the specified list.
Groups	Creates, updates, deletes, and queries Groups from SharePoint.
Roles	Creates, updates, deletes, and queries Roles from SharePoint.
Users	Updates, deletes, and queries Users from SharePoint.
Views	Creates, updates, deletes, and queries the available lists in SharePoint.

Reads or deletes attachments to the specified item on the specified list.

Table Specific Information

Select

List and ItemId are required to return Attachments.

Insert

Call the AddAttachments stored procedure to add new attachments to a list item.

Columns

Name	Type	ReadOnly	Description
Url [KEY]	String	True	Description of the term set.
List	String	True	The internal name of the list to retrieve attachments from.
ListDisplayName	String	True	The display name of 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.

Creates, updates, deletes, and queries Groups from SharePoint.

Table Specific Information

Insert

The Name, DefaultLogin, and OwnerLogin columns are required to insert to this table.

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

Creates, updates, deletes, and queries 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.

Insert

To insert a Role, at a minimum the Name is required:

INSERT INTO Roles (Name) VALUES ('My Role')

Columns

Name	Type	ReadOnly	Description
Name# [KEY]	String	False	The name of the role.
Description#	String	False	A description of the role.
Permissions#	String	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.

Updates, deletes, and queries Users from SharePoint.

Table Specific Information

Select

Retrieves 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
ID	String	True	The Id of the user.
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 and selecting or deleting the user from. This is an input-only value and you must specify either Group or Role for inserts and selects, but you can optionally specify deletions.
Role	String	The role you are adding a user to and selecting or deleting the user from. This is an input-only value and you must specify either Group or Role for inserts and selects, but but you can optionally specify deletions.

Creates, updates, deletes, and queries 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

To return results from Views, yout must specify either the ID or List in the SELECT statement. For example,

SELECT * FROM Views WHERE List = 'MyListName'

Insert

The List, Name, and Fields columns are required to insert to this table.

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.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Microsoft SharePoint Connector for CData Sync Views

Name	Description
FileVersions	Lists the versions of files available on SharePoint.
GetValidTerms	Gets a list of valid terms for the specified column on the specified table.
Lists	Lists the available lists in SharePoint.
Permissions	The permissions for a site or list. Note: If ItemId is empty, set the ObjectType to List or web (an ObjectName must be specified when the ObjectType is list). If not, you must specify the ObjectName along with the ItemID.
Subsites	Lists the available subsites.

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. You must specify a file to retrieve the versions for a file.

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

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	A Boolean indicating if the term set is open.
Deprecated	Boolean	A Boolean indicating if the term is deprecated.
InternalId	String	An internal identifier for the term.
TermSetContact	String	The term set contact.
ContainerDesc	String	The 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	String	An 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 the available lists in SharePoint.

View 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 Sync App.

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	A 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	A Boolean indicating if assigned-to emails are enabled. Only applies to issues lists.
EnableAttachments	Boolean	A Boolean indicating if attachments may be added to items in the list. Does not apply to document libraries.
EnableModeration	Boolean	A Boolean indicating if content approval is enabled for the list.
EnableVersioning	Boolean	A Boolean indicating if versioning is enabled for the list.
Hidden	Boolean	A 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	A Boolean indicating if a meeting-workspace site contains data for multiple meeting instances within the site.
Ordered	Boolean	A Boolean indicating if items in the list can be sorted on the Edit View page.
Showuser	Boolean	A Boolean indicating if the names of users are shown in the results of the survey.

The permissions for a site or list. Note: If ItemId is empty, set the ObjectType to List or web (an ObjectName must be specified when the ObjectType is list). If not, you must specify the ObjectName 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.

Lists the available subsites.

Columns

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

The CData Sync App models Microsoft SharePoint entities in relational Tables, Views, and Stored Procedures. The table definitions are dynamically obtained based on your Microsoft SharePoint site. Any changes you make, such as adding a custom field or changing a field's data type, are automatically reflected when you connect.

Tables

Lists in your Microsoft SharePoint site are generated as relational tables dynamically. This means any change you make in your lists, i.e adding a new list or new fields, is reflected in the driver.

Since tables are generated dynamically, documentation on specific tables is not available.

Views

Views are tables that cannot be modified. Typically, read-only data are shown as views.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They surface additional capabilities of the Microsoft SharePoint API such as searching, updating, and modifying information.

Using OData standard

Since the REST API is OData based, server side filters, are done using OData standard. So the driver takes the most of the server filtering, by reading the metadata file and determing which filters can be done on the server.

NOTE: When executing "SELECT *" queries, the Microsoft SharePoint REST API response, does not return all the available fields. So to avoid too many null values, the provider will select all the columns explicitly using the $select filter. However, the provider will do this only if the $select filter's length is not bigger than 1500, to avoid an error from Microsoft SharePoint REST API regarding the URL length. This is a limitation of the Microsoft SharePoint REST API, so in these cases, the only way to see the actual value of some columns, is to explicitly select them in your query.

The Sync App maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.

Microsoft SharePoint	CData Schema
Choice (menu)	string
Currency	float
Date and Time	datetime
Hyperlink or Picture	string
Lookup	string
Multiple lines of text	string
Number	float
Person or Group	string
Single line of text	string
Task Outcome	string
Yes/No	bool

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Microsoft SharePoint Connector for CData Sync Views

Name	Description
Attachments	Reads attachments to the specified item to the specified list.
Comments	This view represents comments within SharePoint, detailing their authors, content, replies, and associated metadata.
Files	Reads attachments to the specified item to the specified list.
Groups	Retrieve group information from the specified SharePoint Site, including membership settings, permissions, and ownership details.
Lists	Query the available lists on your sharepoint site.
ListItems	This view represents general SharePoint items containing standard columns across various SharePoint lists.
RoleAssignmentMember	Get Web RoleAssignments member.
RoleAssignments	Acquires Web RoleAssignments.
RoleDefinitionBindings	Get Web Role definition binding.
Roles	Contains details about role definitions available in the SharePoint site collection.
Subsites	This lists the available subsites.
Users	Represents users and their roles in the SharePoint site or group.

Reads attachments to the specified item to the specified list.

Table Specific Information

Select

Note: List and ItemId are required to return Attachments.

List can be fetched from the Lists view(Title column).

SELECT * FROM Attachments WHERE List = 'TestApp' AND ItemID = 1

Columns

Name	Type	References	Description
Id [KEY]	String		The Id of the attachment to the item.
Updated	Datetime		The updated date of the attachment to the item.
FileName	String		The FileName of the attachment to the item.
ServerRelativePath_DecodedUrl	String		The ServerRelativePath DecodedUrl of the attachment to the item.
FileNameAsPath_DecodedUrl	String		The FileNameAsPath DecodedUrl of the attachment to the item.
ServerRelativeUrl	String		The ServerRelativeUrl of the attachment to the item.
List	String	Lists.Title	The internal name of the list to retrieve attachments from.
ItemID	Int		The Id of the item in the list to retrieve attachments from.

This view represents comments within SharePoint, detailing their authors, content, replies, and associated metadata.

Columns

Name	Type	References	Description
Id [KEY]	Int		A unique identifier for each comment.
ItemId [KEY]	Int	ListItems.Id	The ID of the item associated with the comment.
List	String	Lists.Title	The name of the SharePoint list containing the item and its comments.
ListId	String		The unique ID of the list the comment belongs to.
AuthorId	Int		The unique identifier of the comment's author.
AuthorEmail	String		The email address of the comment's author.
IsReply	Bool		Indicates whether the comment is a reply to another comment.
ParentId	Int	Comments.Id	The unique ID of the parent comment if this is a reply.
ReplyCount	Int		The total number of replies to the comment.
LikeCount	Int		The total number of likes on the comment.
IsLikedByUser	Bool		Indicates whether the comment is liked by the current user.
Text	String		The text content of the comment.
Mentions	String		A list of users mentioned in the comment, if any.
CreatedDate	Datetime		The date and time when the comment was originally created.
ModifiedDate	Datetime		The date and time when the comment was last modified.

Reads attachments to the specified item to the specified list.

Columns

Name	Type	References	Description
Id [KEY]	String		Unique identifier
CreatedBy_Id	String		The ID of the user that added the file
CreatedBy_Name	String		The name of the user that added the file
CreatedBy_Puid	String		The personal ID of the user that added the file
ETag	String		ETag value
LastModifiedBy_Id	String		The ID of the user that last modified the file
LastModifiedBy_Name	String		The name of the user that last modified the file
LastModifiedBy_Puid	String		The personal ID of the user that last modified the file
Name	String		Name of the file including the extension
Size	Long		The size of the file in bytes, excluding the size of any Web Parts that are used in the file.
TimeCreated	Datetime		Specifies when the file was created.
TimeLastModified	Datetime		Specifies when the file was last modified.
Url	String		URL of the file
List	String		The display name of the list to retrieve files from.

Retrieve group information from the specified SharePoint Site, including membership settings, permissions, and ownership details.

Columns

Name	Type	References	Description
Id [KEY]	Int		The unique identifier for the group.
LoginName	String		The login name or alias associated with the group.
Title	String		The display name of the group or principal.
AllowMembersEditMembership	Bool		Indicates whether group members are allowed to modify the membership of the group.
AllowRequestToJoinLeave	Bool		Indicates whether users can request to join or leave the group.
AutoAcceptRequestToJoinLeave	Bool		Indicates whether requests to join or leave the group are automatically accepted.
CanCurrentUserEditMembership	Bool		Indicates whether the current user has permissions to edit the group's membership.
CanCurrentUserManageGroup	Bool		Indicates whether the current user has permissions to manage the group.
CanCurrentUserViewMembership	Bool		Indicates whether the current user can view the group's membership details.
Description	String		A brief description or summary of the group's purpose or function.
IsHiddenInUI	Bool		Indicates whether the group is hidden from the user interface.
OnlyAllowMembersViewMembership	Bool		Indicates whether only members of the group are allowed to view its membership details.
OwnerTitle	String		The display name of the group's owner.
RequestToJoinLeaveEmailSetting	String		The email address where membership requests (to join or leave) are sent.
PrincipalType	Int		Specifies the type of principal. This is a bitwise value where possible. Types include: None = 0; User = 1; DistributionList = 2; SecurityGroup = 4; SharePointGroup = 8; All = 15.

Query the available lists on your sharepoint site.

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 Sync App.

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

Columns

Name	Type	References	Description
HasUniqueRoleAssignments [KEY]	Bool
LinkedFirstUniqueAncestorSecurableObject	String
LinkedRoleAssignments	String
ServerRelativeUrl	String		The relative URL of the file based on the URL for the server. This column is available when the URL is a subsite.
Id [KEY]	String
AllowContentTypes	Bool
AllowDeletion	Bool
BaseTemplate	Int
BaseType	Int
BrowserFileHandling	Int
ContentTypesEnabled	Bool
CrawlNonDefaultViews	Bool
Created	Datetime
CurrentChangeToken_StringValue	String
CustomActionElements_Items	String
DataSource_Properties	String
DefaultContentApprovalWorkflowId	String
DefaultDisplayFormUrl	String
DefaultEditFormUrl	String
DefaultItemOpenUseListSetting	Bool
DefaultNewFormUrl	String
DefaultViewPath_DecodedUrl	String
DefaultViewUrl	String
Description	String
Direction	String
DisableGridEditing	Bool
DocumentTemplateUrl	String
DraftVersionVisibility	Int
EffectiveBasePermissions_High	Long
EffectiveBasePermissions_Low	Long
EffectiveBasePermissionsForUI_High	Long
EffectiveBasePermissionsForUI_Low	Long
EnableAssignToEmail	Bool
EnableAttachments	Bool
EnableFolderCreation	Bool
EnableMinorVersions	Bool
EnableModeration	Bool
EnableRequestSignOff	Bool
EnableVersioning	Bool
EntityTypeName	String
ExcludeFromOfflineClient	Bool
ExemptFromBlockDownloadOfNonViewableFiles	Bool
FileSavePostProcessingEnabled	Bool
ForceCheckout	Bool
HasExternalDataSource	Bool
Hidden	Bool
ImagePath_DecodedUrl	String
ImageUrl	String
IrmEnabled	Bool
IrmExpire	Bool
IrmReject	Bool
IsApplicationList	Bool
IsCatalog	Bool
IsEnterpriseGalleryLibrary	Bool
IsPrivate	Bool
IsSiteAssetsLibrary	Bool
IsSystemList	Bool
ItemCount	Int
LastItemDeletedDate	Datetime
LastItemModifiedDate	Datetime
LastItemUserModifiedDate	Datetime
ListExperienceOptions	Int
ListItemEntityTypeFullName	String
MajorVersionLimit	Int
MajorWithMinorVersionsLimit	Int
MultipleDataList	Bool
NoCrawl	Bool
OnQuickLaunch	Bool
PageRenderType	Int
ParentWebPath_DecodedUrl	String
ParentWebUrl	String
ParserDisabled	Bool
ReadSecurity	Int
SchemaXml	String
ServerTemplateCanCreateFolders	Bool
TemplateFeatureId	String
Title	String
ValidationFormula	String
ValidationMessage	String
WriteSecurity	Int
LinkedContentTypes	String
LinkedCreatablesInfo	String
LinkedDefaultView	String
LinkedDescriptionResource	String
LinkedEventReceivers	String
LinkedFields	String
LinkedForms	String
LinkedInformationRightsManagementSettings	String
LinkedItems	String
LinkedParentWeb	String
LinkedRootFolder	String
LinkedSubscriptions	String
LinkedTitleResource	String
LinkedUserCustomActions	String
LinkedViews	String
LinkedWorkflowAssociations	String

This view represents general SharePoint items containing standard columns across various SharePoint lists.

Columns

Name	Type	References	Description
ID [KEY]	Int		Unique identifier for the list item.
Title	String		Title of the list item.
Attachments	Bool		Indicates if the item has attachments.
Description	String		Detailed description of the item.
List [KEY]	String	Lists.Title	The display name of the list to retrieve items from.
ContentTypeID	String		Identifier for the content type of the item.
FileSystemObjectType	Int		Indicates the type of object in the file system, such as: '-1': Invalid, '0': File, '1': Folder, '2': Web.
GUID	String		Globally unique identifier for the item.
Version	String		The version string of the item indicates its version history.
CreatedBy	Int	Users.Id	Identifier for the author of the item.
ModifiedBy	Int	Users.Id	Identifier for the last editor of the item.
Created	Datetime		Date and time when the item was created.
Modified	Datetime		Date and time when the item was last modified.

Get Web RoleAssignments member.

Table Specific Information

Select

Note: PrincipalId is required to return RoleAssignmentMember.

SELECT * FROM RoleAssignmentMember WHERE PrincipalId = 3
SELECT * FROM RoleAssignmentMember WHERE List = 'TestApp' AND PrincipalId = 3
SELECT * FROM RoleAssignmentMember WHERE PrincipalId = 5 AND list = 'MyTestList' AND ItemId = '3'

Columns

Name	Type	References	Description
ID [KEY]	Int		The ID of the role assigned member.
Updated	Datetime		The updated date for role assigned member.
IsHiddenInUI	Boolean		A Boolean indicating if the assigned role member is hidden in UI.
LoginName	String		The login name of the role assigned member.
Title	String		The title of the role assigned member.
PrincipalType	Int		The principal type of the role assigned member. None = 0; User = 1; DistributionList = 2; SecurityGroup = 4; SharePointGroup = 8; All principal types = 15.
AllowMembersEditMembership	Boolean		A Boolean indicating whether to allow members edit membership.
AllowRequestToJoinLeave	Boolean		A Boolean indicating whether to allow request to join leave.
AutoAcceptRequestToJoinLeave	Boolean		A Boolean indicating whether to auto accept request to join leave.
Description	String		The description of the role assigned member.
OnlyAllowMembersViewMembership	Boolean		A Boolean indicating whether to only allow members view membership.
OwnerTitle	String		The owner title of the role assigned member.
RequestToJoinLeaveEmailSetting	String		The request to join leave email setting of the role assigned member.
List	String	Lists.Title	The display name of the list to retrieve role assigned member from.
ItemId	Int		List item id for role assignment.
PrincipalId	Int	RoleAssignments.PrincipalId	The Principal Id.

Acquires Web RoleAssignments.

Table Specific Information

Select

SELECT * FROM RoleAssignments WHERE List = 'TestApp'
SELECT * FROM RoleAssignments WHERE PrincipalId = 5 AND list = 'MyListName' AND ItemId = '3'

Columns

Name	Type	References	Description
ID [KEY]	String		The Id of the role assigned.
PrincipalId	Int		The Principal ID for role assigned.
Updated	Datetime		The updated date for role assigned.
List	String	Lists.Title	The display name of the list to retrieve role assigned from.
ItemId	Int		List item id for role assignments.

Get Web Role definition binding.

Table Specific Information

Select

NOTE: PrincipalId is required to return RoleDefinitionBindings.

SELECT * FROM RoleDefinitionBindings WHERE PrincipalId = 3
SELECT * FROM RoleDefinitionBindings WHERE List = 'TestApp' AND PrincipalId = 3
SELECT * FROM RoleDefinitionBindings WHERE PrincipalId = 5 AND list = 'KatsunariMatsumoto' AND ItemId = '3'

Columns

Name	Type	References	Description
PrincipalId [KEY]	Int	RoleAssignments.PrincipalId	The Principal Id.
ID [KEY]	Int		The ID of the role assigned member.
BasePermissions_High	Long		The base permissions high.
BasePermissions_Low	Long		The base permissions low.
Description	String		The description.
Hidden	Boolean		A Boolean indicating if it is hidden.
Name	String		The name.
Order	Int		The order.
RoleTypeKind	Int		The role type kind.
List	String	Lists.Title	The display name of the list to retrieve role assigned member from.
ItemId	Int		List item id for role defintion.

Contains details about role definitions available in the SharePoint site collection.

Columns

Name	Type	References	Description
Id [KEY]	Int		Specifies the unique identifier of the role definition.
BasePermissions_High	Long		Specifies the high-level base permissions set for the role definition.
BasePermissions_Low	Long		Specifies the low-level base permissions set for the role definition.
Description	String		Provides a description of the role definition's purpose and permissions.
Hidden	Bool		Indicates whether the role definition is hidden from the Permission Levels page.
Name	String		Defines the name assigned to the role definition.
Order	Int		Specifies the display order of the role definition on the Permission Levels page in the site collection.
RoleTypeKind	Int		Represents the type of role definition, mapping to an SP.RoleType enumeration.

This lists the available subsites.

Columns

Name	Type	References	Description
Id [KEY]	String		The Id of the subsite.
AllowRssFeeds	Boolean		The AllowRssFeeds of the subsite.
AlternateCssUrl	String		The AlternateCssUrl of the subsite.
AppInstanceId	String		The AppInstanceId of the subsite.
ClassicWelcomePage	String		The ClassicWelcomePage of the subsite.
Configuration	Int		The Configuration of the subsite.
Created	Datetime		The Created of the subsite.
CurrentChangeToken_StringValue	String		The CurrentChangeToken_StringValue of the subsite.
CustomMasterUrl	String		The CustomMasterUrl of the subsite.
Description	String		The Description of the subsite.
DesignPackageId	String		The DesignPackageId of the subsite.
DocumentLibraryCalloutOfficeWebAppPreviewersDisabled	Boolean		The DocumentLibraryCalloutOfficeWebAppPreviewersDisabled of the subsite.
EnableMinimalDownload	Boolean		The EnableMinimalDownload of the subsite.
FooterEmphasis	Int		The FooterEmphasis of the subsite.
FooterEnabled	Boolean		The FooterEnabled of the subsite.
FooterLayout	Int		The FooterLayout of the subsite.
HeaderEmphasis	Int		The HeaderEmphasis of the subsite.
HeaderLayout	Int		The HeaderLayout of the subsite.
HideTitleInHeader	Boolean		The HideTitleInHeader of the subsite.
HorizontalQuickLaunch	Boolean		The HorizontalQuickLaunch of the subsite.
IsHomepageModernized	Boolean		The IsHomepageModernized of the subsite.
IsMultilingual	Boolean		The IsMultilingual of the subsite.
IsRevertHomepageLinkHidden	Boolean		The IsRevertHomepageLinkHidden of the subsite.
Language	Int		The Language of the subsite.
LastItemModifiedDate	Datetime		The LastItemModifiedDate of the subsite.
LastItemUserModifiedDate	Datetime		The LastItemUserModifiedDate of the subsite.
LogoAlignment	Int		The LogoAlignment of the subsite.
MasterUrl	String		The MasterUrl of the subsite.
MegaMenuEnabled	Boolean		The MegaMenuEnabled of the subsite.
NavAudienceTargetingEnabled	Boolean		The NavAudienceTargetingEnabled of the subsite.
NoCrawl	Boolean		The NoCrawl of the subsite.
ObjectCacheEnabled	Boolean		The ObjectCacheEnabled of the subsite.
OverwriteTranslationsOnChange	Boolean		The OverwriteTranslationsOnChange of the subsite.
ResourcePath_DecodedUrl	String		The ResourcePath_DecodedUrl of the subsite.
QuickLaunchEnabled	Boolean		The QuickLaunchEnabled of the subsite.
RecycleBinEnabled	Boolean		The RecycleBinEnabled of the subsite.
SearchScope	Int		The SearchScope of the subsite.
ServerRelativeUrl	String		The ServerRelativeUrl of the subsite.
SiteLogoUrl	String		The SiteLogoUrl of the subsite.
SyndicationEnabled	Boolean		The SyndicationEnabled of the subsite.
TenantAdminMembersCanShare	Int		The TenantAdminMembersCanShare of the subsite.
Title	String		The Title of the subsite.
TreeViewEnabled	Boolean		The TreeViewEnabled of the subsite.
UIVersion	Int		The UIVersion of the subsite.
UIVersionConfigurationEnabled	Boolean		The UIVersionConfigurationEnabled of the subsite.
Url	String		The Url of the subsite.
WebTemplate	String		The WebTemplate of the subsite.
WelcomePage	String		The WelcomePage of the subsite.
AccessRequestListUrl	String		The AccessRequestListUrl of the subsite.
AccessRequestSiteDescription	String		The AccessRequestSiteDescription of the subsite.
Acronym	String		The Acronym of the subsite.
AllowAutomaticASPXPageIndexing	Boolean		The AllowAutomaticASPXPageIndexing of the subsite.
AllowCreateDeclarativeWorkflowForCurrentUser	Boolean		The AllowCreateDeclarativeWorkflowForCurrentUser of the subsite.
AllowDesignerForCurrentUser	Boolean		The AllowDesignerForCurrentUser of the subsite.
AllowMasterPageEditingForCurrentUser	Boolean		The AllowMasterPageEditingForCurrentUser of the subsite.
AllowRevertFromTemplateForCurrentUser	Boolean		The AllowRevertFromTemplateForCurrentUser of the subsite.
AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser	Boolean		The AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser of the subsite.
AllowSavePublishDeclarativeWorkflowForCurrentUser	Boolean		The AllowSavePublishDeclarativeWorkflowForCurrentUser of the subsite.
CommentsOnSitePagesDisabled	Boolean		The CommentsOnSitePagesDisabled of the subsite.
ContainsConfidentialInfo	Boolean		The ContainsConfidentialInfo of the subsite.
CustomSiteActionsDisabled	Boolean		The CustomSiteActionsDisabled of the subsite.
DefaultNewPageTemplateId	String		The DefaultNewPageTemplateId of the subsite.
DescriptionForExistingLanguage	String		The DescriptionForExistingLanguage of the subsite.
DescriptionTranslations	String		The DescriptionTranslations of the subsite.
DesignerDownloadUrlForCurrentUser	String		The DesignerDownloadUrlForCurrentUser of the subsite.
DisableAppViews	Boolean		The DisableAppViews of the subsite.
DisableFlows	Boolean		The DisableFlows of the subsite.
DisableRecommendedItems	Boolean		The DisableRecommendedItems of the subsite.
EffectiveBasePermissions_High	Long		The EffectiveBasePermissions_High of the subsite.
EffectiveBasePermissions_Low	Long		The EffectiveBasePermissions_Low of the subsite.
ExcludeFromOfflineClient	Boolean		The ExcludeFromOfflineClient of the subsite.
HasWebTemplateExtension	Boolean		The HasWebTemplateExtension of the subsite.
IsEduClass	Boolean		The IsEduClass of the subsite.
IsEduClassProvisionChecked	Boolean		The IsEduClassProvisionChecked of the subsite.
IsEduClassProvisionPending	Boolean		The IsEduClassProvisionPending of the subsite.
IsProvisioningComplete	Boolean		The IsProvisioningComplete of the subsite.
LastItemModifiedDate	Datetime		The LastItemModifiedDate of the subsite.
LastItemUserModifiedDate	Datetime		The LastItemUserModifiedDate of the subsite.
LogoAlignment	Int		The LogoAlignment of the subsite.
NotificationsInOneDriveForBusinessEnabled	Boolean		The NotificationsInOneDriveForBusinessEnabled of the subsite.
NotificationsInSharePointEnabled	Boolean		The NotificationsInSharePointEnabled of the subsite.
PrimaryColor	String		The PrimaryColor of the subsite.
RelatedHubSiteIds	String		The RelatedHubSiteIds of the subsite.
RequestAccessEmail	String		The RequestAccessEmail of the subsite.
SaveSiteAsTemplateEnabled	Boolean		The SaveSiteAsTemplateEnabled of the subsite.
SearchBoxInNavBar	Int		The SearchBoxInNavBar of the subsite.
SearchBoxPlaceholderText	String		The SearchBoxPlaceholderText of the subsite.
ServerRelativePath_DecodedUrl	String		The ServerRelativePath_DecodedUrl of the subsite.
ShowUrlStructureForCurrentUser	Boolean		The ShowUrlStructureForCurrentUser of the subsite.
SiteLogoDescription	String		The SiteLogoDescription of the subsite.
SupportedUILanguageIds	String		The SupportedUILanguageIds of the subsite.
TenantTagPolicyEnabled	Bit		The TenantTagPolicyEnabled of the subsite.
ThemeData	String		The ThemeData of the subsite.
ThemedCssFolderUrl	String		The ThemedCssFolderUrl of the subsite.
ThirdPartyMdmEnabled	Boolean		The ThirdPartyMdmEnabled of the subsite.
TitleForExistingLanguage	String		The TitleForExistingLanguage of the subsite.
TitleTranslations	String		The TitleTranslations of the subsite.
WebTemplateConfiguration	String		The WebTemplateConfiguration of the subsite.
WebTemplatesGalleryFirstRunEnabled	Boolean		The WebTemplatesGalleryFirstRunEnabled of the subsite.
WebTemplatesGalleryFirstRunComplete	Boolean		The WebTemplatesGalleryFirstRunComplete of the subsite.

Represents users and their roles in the SharePoint site or group.

Table Specific Information

Select

SELECT * FROM Users // Fetch all the Users
SELECT * FROM Users WHERE GroupId = 5 // Fetch a user for a particular Group

Columns

Name	Type	References	Description
Id [KEY]	Int		Unique identifier for each user in the SharePoint environment.
LoginName	String		The unique login name used by the user to access the SharePoint environment.
Title	String		The display name or title associated with the user.
IsHiddenInUI	Bool		Indicates whether the user is hidden from the SharePoint user interface.
GroupId	Int		The identifier of the group to which the user belongs.
AadObjectId_NameId	String		Azure Active Directory (AAD) object ID representing the user's unique identifier.
AadObjectId_NameIdIssuer	String		The issuer of the Azure Active Directory (AAD) NameId for the user.
Email	String		Primary email address associated with the user.
EmailWithFallback	String		An alternate or fallback email address for the user if the primary is unavailable.
Expiration	String		Specifies the expiration date of the user's access, if applicable.
HexCid	String		A hexadecimal representation of the user's client ID.
IsEmailAuthenticationGuestUser	Bool		Indicates if the user is a guest authenticated via email.
IsShareByEmailGuestUser	Bool		Indicates if the user is a guest invited via email for sharing purposes.
IsSiteAdmin	Bool		Specifies whether the user has administrative rights for the site collection.
UserId_NameId	String		The unique identifier for the user in SharePoint's user ID system.
UserId_NameIdIssuer	String		The issuer of the user's ID in SharePoint's user ID system.
UserPrincipalName	String		User Principal Name (UPN) for the user, usually an email-style identifier.
PrincipalType	Int		Defines the type of principal, using bitwise values: None=0, User=1, DistributionList=2, SecurityGroup=4, SharePointGroup=8, All=15.

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 Establishing a Connection.

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	Identifies the Microsoft SharePoint tenant being used to access data, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional).
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, formatted as a semicolon-separated list.

OAuth

---

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
Scope	The scope used for the OAuth flow to access data from the Application.
State	Optional value for representing extra OAuth state information.
OAuthGrantType	Specifies the grant type for the chosen OAuth flow. This value should be the same as the grant_type that was set during OAuth custom application creation.

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 used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.
OAuthJWTIssuer	The issuer of the Java Web Token.

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.
KerberosSPN	The service principal name (SPN) for the Kerberos Domain Controller.
KerberosUser	The principal name for the Kerberos Domain Controller. Used in the format host/user@realm.
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.

SSL

---

Property	Description
SSLClientCert	Specifies the TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). This property works in conjunction with other SSL-related properties to establish a secure connection.
SSLClientCertType	Specifies the type of key store containing the TLS/SSL client certificate for SSL Client Authentication. Choose from a variety of key store formats depending on your platform and certificate source.
SSLClientCertPassword	Specifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access.
SSLClientCertSubject	Specifes the subject of the TLS/SSL client certificate to locate it in the certificate store. Use a comma-separated list of distinguished name fields, such as CN=www.server.com, C=US. The wildcard * selects the first certificate in the store.
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

---

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

---

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema

---

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Schema	The type of schema to use.

Miscellaneous

---

Property	Description
CalculatedDataType	The data type to be used for calculated fields. This property applies only to the SOAP schema.
ContinueOnError	Indicates whether to continue updating items in a batch after an error.
CreateIDColumns	Create supplemental ID columns for SharePoint columns that use values from information stored in other Lists. This property applies only to the SOAP schema.
DisableFilterLimit	Microsoft SharePoint natively supports listing up to 5000 records as they appear in your list filter. Use this property to pull more than 5000 records from the list filter at the cost of additional performance overhead. This property applies only to the REST schema.
FolderOption	An option to determine how to display folders in results. Enter either FilesOnly, FilesAndFolders, Recursive, or RecursiveAll. This property applies only to the SOAP schema.
GetColumnsMetadata	Specifies when the provider should retrieve column metadata. This property applies only to the REST schema.
IncludeLookupColumns	This option controls whether the driver returns the lookup columns defined on a table. This property applies only to the SOAP schema.
IncludeLookupDisplayValueColumns	Determines whether the display values for lookup columns should be included. This property applies only to the REST schema.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize	Specifies the maximum number of results to return from Microsoft SharePoint, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
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	Indicates whether to include the list version views during metadata discovery. This property applies only to the SOAP schema.
STSURL	The URL of the security token service (STS) when using single sign-on (SSO).
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UseDisplayNames	Boolean determining if the display names for the columns should be used instead of the API names.
UseEntityTypeName	Boolean determining if the list's EntityTypeName field should be used as the table name during metadata discovery instead of the Title field. This property applies only to the REST schema.
UseNTLMV1	Determines whether the driver will attempt to connect with NTLMv1 or NTLMv2 (default).
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
UseSimpleNames	Boolean determining if simple names should be used for tables and columns.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

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.

The scheme used for authenticating to SharePoint.

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:

• NTLM: Set this to use your Windows credentials for authentication.
• Negotiate: If AuthScheme is set to Negotiate, the Sync App will Negotiate an authentication mechanism with the server. Set AuthScheme to Negotiate if you want to use Kerberos authentication.
• None: Set this to use anonymous authentication; for example, to access a public site.
• Basic: Set this to use HTTP Basic authentication.
• ADFS: Set this to use Single Sign-On authentication with ADFS.

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

• AzureAD: Set this to perform Azure Active Directory OAuth Authentication.
• AzureServicePrincipalCert: Set this to authenticate as an Azure Service Principal using a certificate.
• AzurePassword: Set this to authenticate using OAuth with Password GrantType.
• PingFederate: Set this to use Single Sign-On authentication with PingFederate.
• ADFS: Set this to use Single Sign-On authentication with ADFS.
• OneLogin: Set this to use Single Sign-On authentication with OneLogin.
• OKTA: Set this to use Single Sign-On authentication with OKTA.
• AzureMSI: Set this to automatically obtain Managed Service Identity credentials when running on an Azure VM.
• SharePointOAuth: Set this to use OAuth authentication with Sharepoint APP for Client Credentials.

The base URL for the site.

Remarks

The following are examples of valid URLs:

• http://server/SharePoint/
• http://server/Sites/mysite/
• http://server:90/

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

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

Remarks

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

The SharePoint user account used to authenticate.

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: [email protected].

The password used to authenticate the user.

Remarks

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

This section provides a complete list of the Azure Authentication properties you can configure in the connection string for this provider.

---

Property	Description
AzureTenant	Identifies the Microsoft SharePoint tenant being used to access data, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional).
AzureEnvironment	The Azure Environment to use when establishing a connection.

Identifies the Microsoft SharePoint tenant being used to access data, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional).

Remarks

A tenant is a digital representation of your organization, primarily associated with a domain (for example, microsoft.com). The tenant is managed through a Tenant ID (also known as the directory ID), which is specified whenever you assign users permissions to access or manage Azure resources.

To locate the directory ID in the Azure Portal, navigate to Azure Active Directory > Properties.

Specifying AzureTenant is required when AuthScheme = either AzureServicePrincipal or AzureServicePrincipalCert, or if AuthScheme = AzureAD and the user belongs to more than one tenant.

The Azure Environment to use when establishing a connection.

Remarks

In most cases, leaving the environment set to global works. However, if you have added your Azure Account to a different environment, you can use AzureEnvironment to specify which environment. The available values are GLOBAL, CHINA, USGOVT, USGOVTDOD.

Use this property to resolve issues with the URL suffix (e.g., set it to USGOVT if your URL ends in .us), based on which cloud the you are using. More information about this setting can be found in Microsoft documentation about National clouds

This section provides a complete list of the SSO properties you can configure in the connection string for this provider.

---

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, formatted as a semicolon-separated list.

The identity provider's login URL.

Remarks

The identity provider's login URL.

The domain of the user when using single sign-on (SSO).

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. [email protected]) is different than the domain configured within the SSO service (e.g. [email protected]).

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

Additional properties required to connect to the identity provider, formatted as a semicolon-separated list.

Remarks

Additional properties required to connect to the identity provider, formatted as a semicolon-separated list. This is used with the SSOLoginURL.

SSO configuration is discussed further in .

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

---

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
Scope	The scope used for the OAuth flow to access data from the Application.
State	Optional value for representing extra OAuth state information.
OAuthGrantType	Specifies the grant type for the chosen OAuth flow. This value should be the same as the grant_type that was set during OAuth custom application creation.

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

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

Remarks

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

Note: If not specified or left to 'NONE', the Sync App 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:

• AllSites.Read: Enables reading custom lists
• AllSites.Write: Enables reading & writing custom lists
• AllSites.Manage: Enables reading, writing and creating custom lists
• .default: Requests application permissions without a user context. All the application permissions that have been granted for that web API are included in the retrieved OAuthAccessToken.

Optional value for representing extra OAuth state information.

Remarks

Optional value for representing extra OAuth state information.

Specifies the grant type for the chosen OAuth flow. This value should be the same as the grant_type that was set during OAuth custom application creation.

Remarks

In most cases, the default grant type should not be modified. For information about the most common OAuth grant types and the trade-offs between them, see https://oauth.net/2/grant-types/.

This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.

---

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 used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.
OAuthJWTIssuer	The issuer of the Java Web Token.

The JWT Certificate store.

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:

MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.
SPC	Software 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).

The type of key store containing the JWT Certificate.

Remarks

This property can take one of the following values:

USER	For 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.
MACHINE	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
PFXFILE	The certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE	The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java.
JKSBLOB	The 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_FILE	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB	The certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE	The certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILE	The certificate store is the name of a PKCS7 file containing certificates.
PPKFILE	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
XMLFILE	The certificate store is the name of a file that contains a certificate in XML format.
XMLBLOB	The certificate store is a string that contains a certificate in XML format.
BCFKSFILE	The certificate store is the name of a file that contains an Bouncy Castle keystore.
BCFKSBLOB	The certificate store is a string (base-64-encoded) that contains a Bouncy Castle keystore.

The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.

Remarks

This property specifies the password needed to open the certificate store, but only if the store type requires one. To determine if a password is necessary, refer to the documentation or configuration for your specific certificate store.

The issuer of the Java Web Token.

Remarks

The issuer of the Java Web Token. In most cases, this takes the value of the OAuth App Id (Client Id) connection property and does not need to be individually set.

This section provides a complete list of the Kerberos properties you can configure in the connection string for this provider.

---

Property	Description
KerberosKDC	The Kerberos Key Distribution Center (KDC) service used to authenticate the user.
KerberosRealm	The Kerberos Realm used to authenticate the user.
KerberosSPN	The service principal name (SPN) for the Kerberos Domain Controller.
KerberosUser	The principal name for the Kerberos Domain Controller. Used in the format host/user@realm.
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.

The Kerberos Key Distribution Center (KDC) service used to authenticate the user.

Remarks

The Kerberos properties are used when using SPNEGO or Windows Authentication. The Sync App 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 Sync App will attempt to detect these properties automatically from the following locations:

• KRB5 Config File (krb5.ini/krb5.conf): If the KRB5_CONFIG environment variable is set and the file exists, the Sync App will obtain the KDC from the specified file. Otherwise, it will attempt to read from the default MIT location based on the OS: C:\ProgramData\MIT\Kerberos5\krb5.ini (Windows) or /etc/krb5.conf (Linux).
• Domain Name and Host: If the Kerberos Realm and Kerberos KDC could not be inferred from another location, the Sync App will infer them from the configured domain name and host.

The Kerberos properties are used when using SPNEGO or Windows Authentication. The Sync App 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 Sync App will attempt to detect these properties automatically from the following locations:

• KRB5 Config File (krb5.ini/krb5.conf): If the KRB5_CONFIG environment variable is set and the file exists, the Sync App will obtain the KDC from the specified file. Otherwise, it will attempt to read from the default MIT location based on the OS: C:\ProgramData\MIT\Kerberos5\krb5.ini (Windows) or /etc/krb5.conf (Linux).
• Domain Name and Host: If the Kerberos Realm and Kerberos KDC could not be inferred from another location, the Sync App will infer them from the configured domain name and host.

The Kerberos Realm used to authenticate the user.

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 Sync App will attempt to detect these properties automatically from the following locations:

• KRB5 Config File (krb5.ini/krb5.conf): If the KRB5_CONFIG environment variable is set and the file exists, the Sync App will obtain the default realm from the specified file. Otherwise, it will attempt to read from the default MIT location based on the OS: C:\ProgramData\MIT\Kerberos5\krb5.ini (Windows) or /etc/krb5.conf (Linux)
• Domain Name and Host: If the Kerberos Realm and Kerberos KDC could not be inferred from another location, the Sync App will infer them from the user-configured domain name and host. This might work in some Windows environments.

The service principal name (SPN) for the Kerberos Domain Controller.

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.

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.

The principal name for the Kerberos Domain Controller. Used in the format host/user@realm.

Remarks

If the user you are using for the database doesn't match the user that is in the Kerberos database, this should be set to the Kerberos principal name.

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

Remarks

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

The Kerberos realm of the service.

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

The Kerberos KDC of the service.

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

The full file path to an MIT Kerberos credential cache file.

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.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

Property	Description
SSLClientCert	Specifies the TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). This property works in conjunction with other SSL-related properties to establish a secure connection.
SSLClientCertType	Specifies the type of key store containing the TLS/SSL client certificate for SSL Client Authentication. Choose from a variety of key store formats depending on your platform and certificate source.
SSLClientCertPassword	Specifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access.
SSLClientCertSubject	Specifes the subject of the TLS/SSL client certificate to locate it in the certificate store. Use a comma-separated list of distinguished name fields, such as CN=www.server.com, C=US. The wildcard * selects the first certificate in the store.
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Specifies the TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). This property works in conjunction with other SSL-related properties to establish a secure connection.

Remarks

This property specifies the client certificate store for SSL Client Authentication. Use this property alongside SSLClientCertType, which defines the type of the certificate store, and SSLClientCertPassword, which specifies the password for password-protected stores. When SSLClientCert is set and SSLClientCertSubject is configured, the driver searches for a certificate matching the specified subject.

Certificate store designations vary by platform. On Windows, certificate stores are identified by names such as MY (personal certificates), while in Java, the certificate store is typically a file containing certificates and optional private keys.

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

MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.
SPC	Software publisher certificates.

For PFXFile types, set this property to the filename. For PFXBlob types, set this property to the binary contents of the file in PKCS12 format.

Specifies the type of key store containing the TLS/SSL client certificate for SSL Client Authentication. Choose from a variety of key store formats depending on your platform and certificate source.

Remarks

This property determines the format and location of the key store used to provide the client certificate. Supported values include platform-specific and universal key store formats. The available values and their usage are:

USER - default	For 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.
MACHINE	For Windows, this specifies that the certificate store is a machine store. Note that this store type is not available in Java.
PFXFILE	The certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE	The certificate store is the name of a Java key store (JKS) file containing certificates. Note that this store type is only available in Java.
JKSBLOB	The 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_FILE	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB	The certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE	The certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILE	The certificate store is the name of a PKCS7 file containing certificates.
PPKFILE	The certificate store is the name of a file that contains a PuTTY Private Key (PPK).
XMLFILE	The certificate store is the name of a file that contains a certificate in XML format.
XMLBLOB	The certificate store is a string that contains a certificate in XML format.
BCFKSFILE	The certificate store is the name of a file that contains an Bouncy Castle keystore.
BCFKSBLOB	The certificate store is a string (base-64-encoded) that contains a Bouncy Castle keystore.

Specifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access.

Remarks

This property provides the password needed to open a password-protected certificate store. This property is necessary when using certificate stores that require a password for decryption, as is often recommended for PFX or JKS type stores.

If the certificate store type does not require a password, for example USER or MACHINE on Windows, this property can be left blank. Ensure that the password matches the one associated with the specified certificate store to avoid authentication errors.

Specifes the subject of the TLS/SSL client certificate to locate it in the certificate store. Use a comma-separated list of distinguished name fields, such as CN=www.server.com, C=US. The wildcard * selects the first certificate in the store.

Remarks

This property determines which client certificate to load based on its subject. The Sync App searches for a certificate that exactly matches the specified subject. If no exact match is found, the Sync App looks for certificates containing the value of the subject. If no match is found, no certificate is selected.

The subject should follow the standard format of a comma-separated list of distinguished name fields and values. For example, CN=www.server.com, OU=Test, C=US. Common fields include the following:

Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

Note: If any field contains special characters, such as commas, the value must be quoted. For example: CN="Example, Inc.", C=US.

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

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.

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

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

---

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

The following table provides port number information for each of the supported protocols.

Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to Microsoft SharePoint. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to Microsoft SharePoint. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5	1080	The port where the Sync App sends data to Microsoft SharePoint. If the SOCKS 5 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.

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

---

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

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

The hostname or IP address of the proxy server that you want to route HTTP traffic through.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NTLM: The Sync App retrieves an NTLM token.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• NONE: Set this when the ProxyServer does not require authentication.

For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.

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

The username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

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

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value	Value to set for ProxyUser
BASIC	The user name of a user registered with the proxy server.
DIGEST	The user name of a user registered with the proxy server.
NEGOTIATE	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NTLM	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NONE	Do not set the ProxyPassword connection property.

The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.

The password associated with the user specified in the ProxyUser connection property.

Remarks

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

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value	Value to set for ProxyPassword
BASIC	The password associated with the proxy server user specified in ProxyUser.
DIGEST	The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE	The password associated with the Windows user account specified in ProxyUser.
NTLM	The password associated with the Windows user account specified in ProxyUser.
NONE	Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.

The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :

AUTO	Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

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

Note that the Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.

For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.

The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.

For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Schema	The type of schema to use.

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

Note: Since this Sync App supports multiple schemas, custom schema files for Microsoft SharePoint should be structured such that:

• Each schema should have its own folder, named for that schema.
• All schema folders should be contained in a parent folder.

Location should always be set to the parent folder, and not to an individual schema's folder.

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

Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

The type of schema to use.

Remarks

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

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

Property	Description
CalculatedDataType	The data type to be used for calculated fields. This property applies only to the SOAP schema.
ContinueOnError	Indicates whether to continue updating items in a batch after an error.
CreateIDColumns	Create supplemental ID columns for SharePoint columns that use values from information stored in other Lists. This property applies only to the SOAP schema.
DisableFilterLimit	Microsoft SharePoint natively supports listing up to 5000 records as they appear in your list filter. Use this property to pull more than 5000 records from the list filter at the cost of additional performance overhead. This property applies only to the REST schema.
FolderOption	An option to determine how to display folders in results. Enter either FilesOnly, FilesAndFolders, Recursive, or RecursiveAll. This property applies only to the SOAP schema.
GetColumnsMetadata	Specifies when the provider should retrieve column metadata. This property applies only to the REST schema.
IncludeLookupColumns	This option controls whether the driver returns the lookup columns defined on a table. This property applies only to the SOAP schema.
IncludeLookupDisplayValueColumns	Determines whether the display values for lookup columns should be included. This property applies only to the REST schema.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize	Specifies the maximum number of results to return from Microsoft SharePoint, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
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	Indicates whether to include the list version views during metadata discovery. This property applies only to the SOAP schema.
STSURL	The URL of the security token service (STS) when using single sign-on (SSO).
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UseDisplayNames	Boolean determining if the display names for the columns should be used instead of the API names.
UseEntityTypeName	Boolean determining if the list's EntityTypeName field should be used as the table name during metadata discovery instead of the Title field. This property applies only to the REST schema.
UseNTLMV1	Determines whether the driver will attempt to connect with NTLMv1 or NTLMv2 (default).
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
UseSimpleNames	Boolean determining if simple names should be used for tables and columns.

The data type to be used for calculated fields. This property applies only to the SOAP schema.

Remarks

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.

Indicates whether to continue updating items in a batch after an error.

Remarks

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

This property applies to both SOAP and REST schemas.

Create supplemental ID columns for SharePoint columns that use values from information stored in other Lists. This property applies only to the SOAP schema.

Remarks

If true, the Sync App creates 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 contains the related entry's ID (in the context of its original List).

If set to false, the ID columns are not created, the ID is ignored, and only the value of the referenced column is returned.

Microsoft SharePoint natively supports listing up to 5000 records as they appear in your list filter. Use this property to pull more than 5000 records from the list filter at the cost of additional performance overhead. This property applies only to the REST schema.

Remarks

Regardless of whether this property is set to true or false, for list filters with 5000 or fewer records, server-side processing of list filter queries is supported by Microsoft SharePoint, leading to the fastest possible performance.

When this property is set to true and the list filter exceeds 5000 entries, the Sync App will delegate the filters to the server, and they will be processed server-side. Note that trying to pull more than 5000 entries this way will likely result in a server error.

However, if this property is set to false (the default behavior) and the list filter exceeds 5000 entries, the Sync App will query from the list itself (as opposed to the list filter) and the filtering will be done client-side, which has an extra cost to performance.

An option to determine how to display folders in results. Enter either FilesOnly, FilesAndFolders, Recursive, or RecursiveAll. This property applies only to the SOAP schema.

Remarks

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

Specifies when the provider should retrieve column metadata. This property applies only to the REST schema.

Remarks

Available settings:

• OnStart: The Sync App retrieves and caches metadata for all columns in every table before executing the first statement.
• OnUse: The Sync App retrieves table-specific metadata the first time the table is referenced, if the metadata is not already cached.

This option controls whether the driver returns the lookup columns defined on a table. This property applies only to the SOAP schema.

Remarks

The SharePoint server may reject the request if too many lookup columns are included in a single query.

Determines whether the display values for lookup columns should be included. This property applies only to the REST schema.

Remarks

For the REST schema, the driver will by default push the record identifiers from which a list lookup column retrieves the data from. For example:

MultiLookUpColumn=1, 2

When this property is enabled (true), an additional column (name is suffixed with _DisplayValue) for each lookup column will be listed during metadata retrieval, from which the actual data of the looked-up column can be queried. For example:

MultiLookUpColumn=1, 2
MultiLookUpColumn_DisplayValue=United States, United Kingdom

Note that enabling this connection property will likely result in worse performance, because the server will need more time and resources to retrieve the values of the look up columns.

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Remarks

This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

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

Specifies the maximum number of results to return from Microsoft SharePoint, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.

Remarks

You may want to adjust the default pagesize to optimize results for a particular object or service endpoint you are querying. Be aware that increasing the page size may improve performance, but it could also result in higher memory consumption per page.

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Remarks

This property allows you to define which pseudocolumns the Sync App exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

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

Remarks

This property applies to both SOAP and REST schemas.

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.

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.

This property applies to both SOAP and REST schemas.

Indicates whether to include the list version views during metadata discovery. This property applies only to the SOAP schema.

Remarks

Indicates whether to include list versions as views (e.g. ListA_Versions).

The URL of the security token service (STS) when using single sign-on (SSO).

Remarks

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

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Remarks

This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

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

Remarks

This property applies to both SOAP and REST schemas.

Boolean determining if the list's EntityTypeName field should be used as the table name during metadata discovery instead of the Title field. This property applies only to the REST schema.

Remarks

Boolean determining if the list's EntityTypeName field should be used as the table name during metadata discovery instead of the Title field.

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

Remarks

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

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:

{
	"MyView": {
		"query": "SELECT * FROM Calendar WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.

Boolean determining if simple names should be used for tables and columns.

Remarks

Microsoft SharePoint tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the Sync App 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.