The CData Sync App provides a straightforward way to continuously pipeline your Microsoft OneNote data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Microsoft OneNote connector can be used from the CData Sync application to pull data from Microsoft OneNote and move it to any of the supported destinations.
All hosted versions of Microsoft OneNote are supported via the Microsoft Graph API v1.0. Includes information accessible from a user's OneNote notebooks, sections, and pages in a personal or organization account.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
The following subsections describe each authentication method in detail.
Note: Microsoft has rebranded Azure AD as Entra ID. In topics that require the user to interact with the Entra ID Admin site, we use the same names Microsoft does. However, there are still CData connection properties whose names or values reference "Azure AD".
Microsoft Entra ID is a multi-tenant, cloud-based identity and access management platform. It supports OAuth-based authentication flows that enable the driver to access Microsoft OneNote endpoints securely.
Authentication to Entra ID via a web application always requires that you first create and register a custom OAuth application. This enables your application to define its own redirect URI, manage credential scope, and comply with organization-specific security policies.
For full instructions on how to create and register a custom OAuth application, see Creating a Custom Authentication App.
After setting AuthScheme to AzureAD, the steps to authenticate vary, depending on the environment. For details on how to connect from desktop applications, web-based workflows, or headless systems, see the following sections.
If you are running Microsoft OneNote on an Azure VM and want to automatically obtain Managed Service Identity (MSI) credentials to connect, set AuthScheme to AzureMSI.
If your VM has multiple user-assigned managed identities, you must also specify OAuthClientId.
Note: Microsoft has rebranded Azure AD as Entra ID. In topics that require the user to interact with the Entra ID Admin site, we use the same names Microsoft does. However, there are still CData connection properties whose names or values reference "Azure AD".
Microsoft OneNote supports OAuth-based authentication using Microsoft Entra ID. If you will connect via a web application and want to authenticate via Entra ID, you must first register a custom OAuth application in the Entra Admin Center, as described below.
If you will connect via a desktop application or headless machine, you can authenticate using Microsoft OneNote's built-in embedded application credentials, which use CData branding. However, custom OAuth applications are also compatible with desktop and headless authentication flows, and may be preferable for production deployments or environments requiring strict policy control.
To register an OAuth application in Microsoft Entra ID, follow these steps:
Note: If you select Accounts in this organizational directory only, when you connect with CData Sync App, you must set AzureTenant to the tenant's ID (either GUID or verified domain). Otherwise, authentication will fail.
Note: Microsoft has rebranded Azure AD as Entra ID. In topics that require the user to interact with the Entra ID Admin site, we use the same names Microsoft does. However, there are still CData connection properties whose names or values reference "Azure AD".
Microsoft OneNote supports OAuth-based authentication using Microsoft Entra ID. If you will connect via a web application and want to authenticate via Entra ID, you must first register a custom OAuth application in the Entra Admin Center, as described below.
If you will connect via a desktop application or headless machine, you can authenticate using Microsoft OneNote's built-in embedded application credentials, which use CData branding. However, custom OAuth applications are also compatible with desktop and headless authentication flows, and may be preferable for production deployments or environments requiring strict policy control.
To register an OAuth application in Microsoft Entra ID, follow these steps:
Note: If you select Accounts in this organizational directory only, when you connect with CData Sync App, you must set AzureTenant to the tenant's ID (either GUID or verified domain). Otherwise, authentication will fail.
The CData Sync App can be used to perform administrative tasks. This can be done by specifying the UserId column to execute CUD operations.
Many tables expose a special UserId column. This is designed to be used by an administrator to modify records on another user's account. If
you are not an administrator or do not desire this behavior, do not specify the UserId when performing an INSERT / UPDATE / DELETE operation.
For instance, executing the following will insert a notebook for another user:
INSERT INTO Notebooks (displayName, UserId) VALUES ('Test Notebook', '12345')
The above request will have the overall effect of attempting to add a notebook under the resource at /users/12345/notebooks. When UserId is not specified, the resources affected will instead be modified under /users/me/notebooks. In general if you are not an administrator, you can only affect or view records under /users/me, so it is not recommended to set UserId when you are not an admin.
This section details a selection of advanced features of the Microsoft OneNote Sync App.
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 .
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" .
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
For further information, see Query Processing.
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.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
This section shows the available API objects and provides more information on executing SQL to Microsoft OneNote APIs.
Views describes the available views. Views are statically defined to model Users and Groups.
Tables describes the available tables. Tables are statically defined to model Notebooks, SectionGroups, Sections and Pages.
Stored Procedures are function-like interfaces to OneNote. They can be used to search, create, and modify information in OneNote.
The Sync App models the data in Microsoft OneNote as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| Notebooks | Retrieves all Notebooks for the authenticated user. |
| SectionGroups | Retrieves all SectionGroups accross notebooks for the authenticated user. |
| Sections | Retrieves all Sections accross notebooks for the authenticated user. |
Retrieves all Notebooks for the authenticated user.
You can also use the UserId and GroupId connection properties to filter records. If you include both in the connection string, GroupId takes precedence over UserId.
Most filters are handled server side, but the specific fields of Id, UserId, GroupId and SiteId will change the endpoint we use to retrieve the data. They must be specified with an '=' or IN condition. For example:
SELECT * FROM Notebooks WHERE Id = '1-56e2fc02-f3dd-4f82-82fb-519bc4807935'
SELECT * FROM Notebooks WHERE Id IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935', '1-56e2fc02-f3dd-4f82-fvgf-dfsdf4807935')
SELECT * FROM Notebooks WHERE UserId = '9525a3f1-aa40-4f17-a97b-68606d118adf'
SELECT * FROM Notebooks WHERE GroupId = '044d385d-6ca8-4d81-800d-223124b651db'
SELECT * FROM Notebooks WHERE SiteId = 'rssbuscrm.sharepoint.com,9839b8a3-343a-4064-996a-d2a300bc559f,2b6cda85-3573-4578-ae76-dfdde60c771b'
The column required to perform an Insert operation on Notebooks table is DisplayName. If the INSERT operation is done on behalf of a group or user then UserId or GroupId should also be specified.
The following examples illustrate an Insert operation on Notebooks:
INSERT INTO Notebooks (DisplayName) VALUES ('Getting started')
INSERT INTO Notebooks (DisplayName, UserId) VALUES ('Getting started', '9525a3f1-aa40-4f17-a97b-68606d118adf')
INSERT INTO Notebooks (DisplayName, GroupId) VALUES ('Getting started', '044d385d-6ca8-4d81-800d-223124b651db')
| Name | Type | ReadOnly | Description |
| id [KEY] | String | True |
The id of the notebook. |
| self | String | False |
The self of the notebook. |
| createdDateTime | Datetime | False |
The created DateTime of the notebook. |
| createdBy_application_displayName | String | False |
The createdBy_application_displayName of the notebook. |
| createdBy_application_id | String | False |
The createdBy_application_id of the notebook. |
| displayName | String | False |
The display name of the notebook. |
| lastModifiedBy_application_displayName | String | False |
The lastModifiedBy_application_displayName of the notebook. |
| lastModifiedBy_application_id | String | False |
The lastModifiedBy_application_id of the notebook. |
| lastModifiedDateTime | Datetime | False |
The lastModified DateTime of the notebook. |
| isDefault | Bool | False |
Indicator if notebook is default. |
| isShared | Bool | False |
Indicator if notebook is shared. |
| links_oneNoteClientUrl_href | String | False |
The links_oneNoteClientUrl_href of the notebook. |
| sectionGroupsUrl | String | False |
The sectionGroups Url of the notebook. |
| sectionsUrl | String | False |
The sectionsUrl of the notebook. |
| userRole | String | False |
The userRole of the notebook. |
| createdBy_user_displayName | String | False |
The createdBy user displayName of the notebook |
| createdBy_user_id | String | False |
The createdBy user id of the notebook |
| UserId | String | False |
The userId that the authenticated user is impersonating. |
| GroupId | String | False |
The groupId that the authenticated user is impersonating. |
| SiteId | String | False |
The Id of the Site. |
Retrieves all SectionGroups accross notebooks for the authenticated user.
You can also use the UserId and GroupId connection properties to filter records. If you include both in the connection string, GroupId takes precedence over UserId.
Most filters are handled server side, but the specific fields of Id, UserId, GroupId, SiteId and ParentNotebookId will change the endpoint we use to retrieve the data. They must be specified with an '=' or IN condition. For example:
SELECT * FROM SectionGroups WHERE Id = '1-56e2fc02-f3dd-4f82-82fb-519bc4807935'
SELECT * FROM SectionGroups WHERE ParentNotebookId = '1-2342423-1234-3424-82fb-519bc4807935'
SELECT * FROM SectionGroups WHERE Id IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935', '1-sdcgw3324-f3dd-5678-derf-519bc4807935')
SELECT * FROM SectionGroups WHERE ParentNotebookId IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935', '1-sdcgw3324-f3dd-5678-derf-519bc4807935')
SELECT * FROM SectionGroups WHERE UserId = '9525a3f1-aa40-4f17-a97b-68606d118adf'
SELECT * FROM SectionGroups WHERE GroupId = '044d385d-6ca8-4d81-800d-223124b651db'
SELECT * FROM SectionGroups WHERE SiteId = 'cdata0.sharepoint.com,0a40f113-9f39-459d-a22a-9cc88b46f031,dd4add46-e9ed-4ed8-b479-d55d0721bc7f'
The columns required to perform an Insert operation on SectionGroups table is DisplayName and ParentNotebookId. If the INSERT operation is done on behalf of a group or user then UserId or GroupId should also be specified.
The following examples illustrate an Insert operation on SectionGroups:
INSERT INTO SectionGroups (DisplayName, ParentNotebookId) VALUES ('Getting started', '1-5c57790b-73c3-4996-940e-07c3f2157571')
INSERT INTO SectionGroups (DisplayName, ParentNotebookId, UserId) VALUES ('Getting started', '1-5c57790b-73c3-4996-940e-07c3f2157571', '9525a3f1-aa40-4f17-a97b-68606d118adf')
INSERT INTO SectionGroups (DisplayName, ParentNotebookId, GroupId) VALUES ('Getting started', '1-5c57790b-73c3-4996-940e-07c3f2157571', '044d385d-6ca8-4d81-800d-223124b651db')
| Name | Type | ReadOnly | Description |
| id [KEY] | String | True |
The id of the section group. |
| self | String | False |
The self of the section group. |
| createdDateTime | Datetime | False |
The createdDateTime of the section group. |
| createdBy_application_displayName | String | False |
The createdBy_application_displayName of the section group. |
| createdBy_application_id | String | False |
The createdBy_application_id of the section group. |
| displayName | String | False |
The displayName of the section group. |
| lastModifiedBy_application_displayName | String | False |
The lastModifiedBy_application_displayName of the section group. |
| lastModifiedBy_application_id | String | False |
The lastModifiedBy_application_id of the section group. |
| lastModifiedDateTime | Datetime | False |
The lastModifiedDateTime of the section group. |
| sectionGroupsUrl | String | False |
The sectionGroupsUrl of the section group. |
| sectionsUrl | String | False |
The sectionsUrl of the section group. |
| ParentNotebookId | String | False |
The ParentNotebookId of the section group. |
| ParentSectionGroupId | String | False |
The ParentSectionGroupId of the section group. |
| createdBy_user_displayName | String | False |
The createdBy_user_displayName of the section group. |
| createdBy_user_id | String | False |
The createdBy_user_id of the section group. |
| UserId | String | False |
The userId that the authenticated user is impersonating. |
| GroupId | String | False |
The groupId that the authenticated user is impersonating. |
| SiteId | String | False |
The Id of the Sharepoint Site. |
Retrieves all Sections accross notebooks for the authenticated user.
You can also use the UserId and GroupId connection properties to filter records. If you include both in the connection string, GroupId takes precedence over UserId.
Most filters are handled server side, but the specific fields of Id, UserId, GroupId, SiteId, ParentNotebookId and ParentSectionGroupId will change the endpoint we use to retrieve the data. They must be specified with an '=' or IN condition. For example:
SELECT * FROM Sections WHERE Id = '1-56e2fc02-f3dd-4f82-82fb-519bc4807935'
SELECT * FROM Sections WHERE ParentNotebookId = '1-56e2fc02-f3dd-4f82-82fb-519bc4807935'
SELECT * FROM Sections WHERE ParentSectionGroupId = '1-56e2fc02-f3dd-4f82-82fb-519bc4807935'
SELECT * FROM Sections WHERE Id IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935', '1-23423-f3dd-rtsd-gfds-4353423fsdf')
SELECT * FROM Sections WHERE ParentNotebookId IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935', '1-23423-f3dd-rtsd-gfds-4353423fsdf')
SELECT * FROM Sections WHERE ParentSectionGroupId IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935', '1-23423-f3dd-rtsd-gfds-4353423fsdf')
SELECT * FROM Sections WHERE UserId = '9525a3f1-aa40-4f17-a97b-68606d118adf'
SELECT * FROM Sections WHERE GroupId = '044d385d-6ca8-4d81-800d-223124b651db'
SELECT * FROM Sections WHERE SiteId = 'cdata0.sharepoint.com,0a40f113-9f39-459d-a22a-9cc88b46f031,dd4add46-e9ed-4ed8-b479-d55d0721bc7f'
The columns required to perform an Insert operation on Sections table is DisplayName and ParentNotebookId. If the INSERT operation is done on behalf of a group or user then UserId or GroupId should also be specified.
The following examples illustrate an Insert operation on Sections:
INSERT INTO Sections (DisplayName, ParentNotebookId) VALUES ('Getting started', '1-5c57790b-73c3-4996-940e-07c3f2157571')
INSERT INTO Sections (DisplayName, ParentNotebookId, UserId) VALUES ('Getting started', '1-5c57790b-73c3-4996-940e-07c3f2157571', '9525a3f1-aa40-4f17-a97b-68606d118adf')
INSERT INTO Sections (DisplayName, ParentNotebookId, GroupId) VALUES ('Getting started', '1-5c57790b-73c3-4996-940e-07c3f2157571', '044d385d-6ca8-4d81-800d-223124b651db')
| Name | Type | ReadOnly | Description |
| id [KEY] | String | True |
The id of the section. |
| self | String | False |
The self of the section. |
| createdDateTime | Datetime | False |
The createdDateTime of the section. |
| createdBy_application_displayName | String | False |
The createdBy_application_displayName of the section. |
| createdBy_application_id | String | False |
The createdBy_application_id of the section. |
| displayName | String | False |
The displayName of the section. |
| lastModifiedBy_application_displayName | String | False |
The lastModifiedBy_application_displayName of the section. |
| lastModifiedBy_application_id | String | False |
The lastModifiedBy_application_id of the section. |
| lastModifiedDateTime | Datetime | False |
The lastModifiedDateTime of the section. |
| isDefault | Bool | False |
The isDefault of the section. |
| links_oneNoteClientUrl_href | String | False |
The links_oneNoteClientUrl_href of the section. |
| pagesUrl | String | False |
The pagesUrl of the section. |
| ParentNotebookId | String | False |
The ParentNotebookId of the section. |
| ParentSectionGroupId | String | False |
The ParentSectionGroupId of the section. |
| createdBy_user_displayName | String | False |
The createdBy_user_displayName of the section. |
| createdBy_user_id | String | False |
The createdBy_user_id of the section. |
| UserId | String | False |
The userId that the authenticated user is impersonating. |
| GroupId | String | False |
The groupId that the authenticated user is impersonating. |
| SiteId | String | False |
The Id of the Sharepoint Site. |
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.
| Name | Description |
| Groups | Retrieves all Azure Active Directory (Azure AD) groups, which can be Office 365 groups, or security groups. |
| Pages | Retrieves all Pages accross notebooks for the authenticated user. |
| PagesContent | Retrieves the content for the pages |
| Sites | Retrieves all sites for the authenticated user. |
| Users | Retrieves all Azure AD user accounts within the authenticated permissions. |
Retrieves all Azure Active Directory (Azure AD) groups, which can be Office 365 groups, or security groups.
Groups require Administrator permissions. To work with them, you must create your own custom OAuth App and set the appropriate OAuthClientId and OAuthClientSecret. In this app, you must configure it to request the Group.Read.All permission. This can be done at https://apps.dev.microsoft.com, or in the App Registrations panel at http://portal.azure.com. See Creating a Custom Authentication App for more details on creating a custom app.
To authorize Groups permissions, an administrator must grant the Groups permissions for your organization at large. This can be done via the
administrator authorization endpoint. Simply have the administrator navigate to the following web page and grant permissions. Then
run the OAuth authorization as normal afterwards.
https://login.microsoftonline.com/common/adminconsent?client_id=[YourClientId]&redirect_uri=http://localhost:33333
Most filters are handled server side, but the specific field of Id will change the endpoint we use to retrieve the data. It must be specified with an '=' or IN condition. For example:
SELECT * FROM Groups WHERE Id = '616391f0-32d8-4127-8f25-aa55771d6617'
SELECT * FROM Groups WHERE Id IN ('616391f0-32d8-4127-8f25-aa55771d6617', 'dfgd4rw3-5rvg-76hy-tr5t-aa55771d6617')
| Name | Type | Description |
| ParentReference | String | The Parent Reference of the group. |
| id [KEY] | String | The Id of the group. |
| deletedDateTime | Datetime | The datetime when the group was deleted. |
| allowExternalSenders | Bool | The indicator showing if external senders should be allowed or not. |
| assignedLabels | String | The assigned labels of the group |
| assignedLicenses | String | The assigned licenses of the group. |
| autoSubscribeNewMembers | Bool | The indicator showing if new members should be autosubscribed. |
| classification | String | The classification of the group. |
| createdDateTime | Datetime | The created DateTime of the group. |
| description | String | The description of the group. |
| displayName | String | The display name of the group. |
| expirationDateTime | Datetime | The expiration datetime of the group. |
| groupTypes | String | The types of the group. |
| hasMembersWithLicenseErrors | Bool | Indicator if there are members with license error. |
| hideFromAddressLists | Bool | The hide From AddressLists of the group. |
| hideFromOutlookClients | Bool | The hide From OutlookClients of the group. |
| isArchived | Bool | Indicator if group is archived. |
| isSubscribedByMail | Bool | Indicator if group is subscribed by email. |
| licenseProcessingState_state | String | The license processing state of the group. |
| String | The mail of the group. | |
| mailEnabled | Bool | Indicator if mail is enabled in the group. |
| mailNickname | String | The mail nickname of the group. |
| membershipRule | String | The membership rule of the group. |
| membershipRuleProcessingState | String | The membership rule processing state of the group. |
| onPremisesDomainName | String | The domain name of the group. |
| onPremisesLastSyncDateTime | Datetime | The LastSync DateTime of the group. |
| onPremisesNetBiosName | String | The Net Bios Name of the group. |
| onPremisesProvisioningErrors | String | The provisioning errors of the group. |
| onPremisesSamAccountName | String | The Sam Account Name of the group. |
| onPremisesSecurityIdentifier | String | The security identifier of the group. |
| onPremisesSyncEnabled | Bool | Indicator if sync is enabled in the group. |
| preferredDataLocation | String | The preferred data location of the group. |
| preferredLanguage | String | preferred language in the group. |
| proxyAddresses | String | The proxy addresses of the group. |
| renewedDateTime | Datetime | The renewed DateTime of the group. |
| securityEnabled | Bool | Indicator if security is enabled in the group. |
| securityIdentifier | String | The security identifier of the group. |
| theme | String | The theme of the group. |
| unseenCount | Int | The unseen count of the group. |
| visibility | String | The visibility of the group. |
Retrieves all Pages accross notebooks for the authenticated user.
You can also use the UserId and GroupId connection properties to filter records. If you include both in the connection string, GroupId takes precedence over UserId.
Most filters are handled server side, but the specific fields of Id, ParentSectionId, UserId, GroupId or SiteId will change the endpoint we use to retrieve the data. They must be specified with an '=' or IN condition.
For example:
SELECT * FROM Pages WHERE Id = '1-e8992fa8e5254df387d062d04e75a6e7!6-e8341f6e-75b1-4811-8bb4-d2069c7f7a2d'
SELECT * FROM Pages WHERE Id IN ('1193-dsdda-9392-4706514c636b', '1193-dsdda-9392-sdfasdw33324')
SELECT * FROM Pages WHERE ParentSectionId = '1-e8341f6e-75b1-4811-8bb4-d2069c7f7a2d'
SELECT * FROM Pages WHERE ParentSectionId = '1-e8341f6e-75b1-4811-8bb4-d2069c7f7a2d' AND UserId = '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe'
SELECT * FROM Pages WHERE ParentSectionId = '1-e8341f6e-75b1-4811-8bb4-d2069c7f7a2d' AND GroupId = '1772bb5a-f8e9-405d-a90b-eac11b0b9b9a'
SELECT * FROM Pages WHERE GroupId = 'acabe397-8370-4c31-aeb7-2d7ae6b8cda1'
SELECT * FROM Pages WHERE UserId = '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe'
SELECT * FROM Pages WHERE SiteId = 'cdata0.sharepoint.com,0a40f113-9f39-459d-a22a-9cc88b46f031,dd4add46-e9ed-4ed8-b479-d55d0721bc7f'
| Name | Type | Description |
| id [KEY] | String | The id of the page. |
| self | String | The self of the page. |
| createdDateTime | Datetime | The createdDateTime of the page. |
| contentUrl | String | The contentUrl of the page. |
| createdByAppId | String | The createdByAppId of the page. |
| lastModifiedDateTime | Datetime | The lastModifiedDateTime of the page. |
| level | Int | The level of the page. |
| links_oneNoteClientUrl_href | String | The links_oneNoteClientUrl_href of the page |
| order | Int | The order of the page. |
| title | String | The title of the page. |
| userTags | String | The userTags of the page. |
| ParentSectionId | String | The ParentSectionId of the page. |
| UserId | String | The userId that the authenticated user is impersonating. |
| GroupId | String | The groupId that the authenticated user is impersonating. |
| SiteId | String | The Id of the Sharepoint site. |
Retrieves the content for the pages
You can also use the UserId and GroupId connection properties to filter records. If you include both in the connection string, GroupId takes precedence over UserId.
Most filters are handled server side, but the specific fields of PageId, UserId, GroupId or SiteId will change the endpoint we use to retrieve the data. They must be specified with an '=' or IN condition.
For example:
SELECT * FROM PagesContent WHERE PageId = '1-396658ffc20744bcb716bdd972cc3bfb!1-26d8f808-d809-4df0-a292-d79499d870d'
SELECT * FROM PagesContent where PageId IN ('1-396658ffc20744bcb716bdd972cc3bfb!1-26d8f808-d809-4df0-a292-d79499d870d7', '1-3c0db927dab643d0bbe402f79e6be51f!1-11a54aa2-2105-4d7b-92c3-6e448fbadcc7', '1-a4375ec1f6cd4183ae142bd1fc54859c!1-11a54aa2-2105-4d7b-92c3-6e448fbadcc7')
SELECT * FROM PagesContent WHERE PageId IN (SELECT Id from Pages WHERE UserId = '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe') AND UserId = '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe'
SELECT * FROM PagesContent WHERE UserId = '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe'
SELECT * FROM PagesContent WHERE SiteId = 'cdata0.sharepoint.com,0a40f113-9f39-459d-a22a-9cc88b46f031,dd4add46-e9ed-4ed8-b479-d55d0721bc7f'
| Name | Type | Description |
| PageId | String | The id of the page. |
| Content | String | The html content of the page. |
| UserId | String | The id of the user. |
| GroupId | String | The id of the group. |
| SiteId | String | The id of the site. |
Retrieves all sites for the authenticated user.
The Sync App will use the Microsoft OneNote API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Sync App.
For example:
SELECT * FROM Sites WHERE SiteId = 'b68ddac7-df6d-4649-ad63-d7f22f8535a4' SELECT * FROM Sites WHERE WebId = '577cb6eb-6b89-4638-9bdc-1f92e62af1a5'
| Name | Type | Description |
| Id [KEY] | String | The full identifier of the site. |
| SiteId | String | The unique identifier of the site collection. |
| WebId | String | The Web Id of the site. |
| SiteName | String | The name of the site. |
| Title | String | The title of the site. |
| SiteDescription | String | The description of the site. |
| Description | String | The description of the item. |
| CreatedDateTime | Datetime | Date and time the site was created. |
| LastModifiedDateTime | Datetime | Date and time the site was last modified. |
| SPWebUrl | String | URL that displays the resource in the browser. |
| Author | String | The author of the site. |
| DocumentSignature | String | The document signature of the site. |
| FileExtension | String | The extension of the site's file. |
| SecondaryFileExtension | String | The secondary extension of the site's file. |
| FileType | String | The file type of the site. |
| DocId | Long | The unique identifier of the site within a geo location. |
| GeoLocationSource | String | The geo location of the site. |
| HitHighlightedSummary | String | The heighted summary of the site. |
| Importance | Long | The importance of the site. |
| IsContainer | Bool | Specifies whether the site is a folder. |
| IsDocument | Bool | Specifies whether the site is a document. |
| OriginalPath | String | The original site path. |
| Path | String | The current site path. |
| Rank | Double | The rank of the site. |
| RenderTemplateId | String | The site's control render template name. |
| SiteLogo | String | The URI of the site's logo. |
| ViewsLifeTime | Long | The total view count since the site was created. |
| ViewsRecent | Long | The total view count of the site in the last 14 days. |
| WebTemplate | String | The web temple from which the site is created. |
Retrieves all Azure AD user accounts within the authenticated permissions.
Users require Administrator permissions. To work with them, you must create your own custom OAuth App and set the appropriate OAuthClientId and OAuthClientSecret. In this app, you must configure it to request the User.Read.All permission. This can be done at https://apps.dev.microsoft.com, or in the App Registrations panel at http://portal.azure.com. See Creating a Custom Authentication App for more details on creating a custom app.
To authorize User permissions, an administrator must grant the Users permissions for your organization at large. This can be done via the
administrator authorization endpoint. Simply have the administrator navigate to the following web page and grant permissions. Then
run the OAuth authorization as normal afterwards.
https://login.microsoftonline.com/common/adminconsent?client_id=[YourClientId]&redirect_uri=http://localhost:33333
Most filters are handled server side, but the specific field of Id will change the endpoint we use to retrieve the data. It must be specified with an '=' or IN condition. For example:
SELECT * FROM Users WHERE Id = '616391f0-32d8-4127-8f25-aa55771d6617'
SELECT * FROM Users WHERE Id IN ('616391f0-32d8-4127-8f25-aa55771d6617', 'dfgd4rw3-5rvg-76hy-tr5t-aa55771d6617')
| Name | Type | Description |
| id [KEY] | String | The id of the user. |
| deletedDateTime | Datetime | The deletedDateTime of the user. |
| aboutMe | String | The aboutMe of the user. |
| accountEnabled | Bool | Indicates if accountEnabled for the user. |
| ageGroup | String | The ageGroup of the user. |
| assignedLicenses | String | The assignedLicenses of the user. |
| assignedPlans | String | The assignedPlans of the user. |
| birthday | Datetime | The birthday of the user. |
| businessPhones | String | The businessPhones of the user. |
| city | String | The city of the user. |
| companyName | String | The companyName of the user. |
| consentProvidedForMinor | String | The consentProvidedForMinor of the user. |
| country | String | The country of the user. |
| createdDateTime | Datetime | The createdDateTime of the user. |
| creationType | String | The creationType of the user. |
| department | String | The department of the user. |
| deviceEnrollmentLimit | Int | The deviceEnrollmentLimit of the user. |
| displayName | String | The displayName of the user. |
| employeeHireDate | Datetime | The employeeHireDate of the user. |
| employeeId | String | The employeeId of the user. |
| employeeOrgData_costCenter | String | The employeeOrgData_costCenter of the user. |
| employeeOrgData_division | String | The employeeOrgData_division of the user. |
| employeeType | String | The employeeType of the user. |
| externalUserState | String | The externalUserState of the user. |
| externalUserStateChangeDateTime | Datetime | The externalUserStateChangeDateTime of the user. |
| faxNumber | String | The faxNumber of the user. |
| givenName | String | The givenName of the user. |
| hireDate | Datetime | The hireDate of the user. |
| identities | String | The identities of the user. |
| imAddresses | String | The imAddresses of the user. |
| interests | String | The interests of the user. |
| isResourceAccount | Bool | Indicates if it isResourceAccount of the user. |
| jobTitle | String | The jobTitle of the user. |
| lastPasswordChangeDateTime | Datetime | The lastPasswordChangeDateTime of the user. |
| legalAgeGroupClassification | String | The legalAgeGroupClassification of the user. |
| licenseAssignmentStates | String | The licenseAssignmentStates of the user. |
| String | The mail of the user. | |
| mailboxSettings_archiveFolder | String | The mailboxSettings_archiveFolder of the user. |
| mailboxSettings_automaticRepliesSetting_externalAudience | String | The mailboxSettings_automaticRepliesSetting_externalAudience of the user. |
| mailboxSettings_automaticRepliesSetting_externalReplyMessage | String | The mailboxSettings_automaticRepliesSetting_externalReplyMessage of the user. |
| mailboxSettings_automaticRepliesSetting_internalReplyMessage | String | The mailboxSettings_automaticRepliesSetting_internalReplyMessage of the user. |
| mailboxSettings_automaticRepliesSetting_scheduledEndDateTime_dateTime | Datetime | The mailboxSettings_automaticRepliesSetting_scheduledEndDateTime_dateTime of the user. |
| mailboxSettings_automaticRepliesSetting_scheduledEndDateTime_timeZone | String | The mailboxSettings_automaticRepliesSetting_scheduledEndDateTime_timeZone of the user. |
| mailboxSettings_automaticRepliesSetting_status | String | The mailboxSettings_automaticRepliesSetting_status of the user. |
| mailboxSettings_dateFormat | String | The mailboxSettings_dateFormat of the user. |
| mailboxSettings_delegateMeetingMessageDeliveryOptions | String | The mailboxSettings_delegateMeetingMessageDeliveryOptions of the user. |
| mailboxSettings_language_displayName | String | The mailboxSettings_language_displayName of the user. |
| mailboxSettings_language_locale | String | The mailboxSettings_language_locale of the user. |
| mailboxSettings_timeFormat | String | The mailboxSettings_timeFormat of the user. |
| mailboxSettings_timeZone | String | The mailboxSettings_timeZone of the user. |
| mailboxSettings_workingHours_daysOfWeek | String | The mailboxSettings_workingHours_daysOfWeek of the user. |
| mailboxSettings_workingHours_endTime | Time | The mailboxSettings_workingHours_endTime of the user. |
| mailboxSettings_workingHours_startTime | Time | The mailboxSettings_workingHours_startTime of the user. |
| mailboxSettings_workingHours_timeZone_name | String | The mailboxSettings_workingHours_timeZone_name of the user. |
| mailNickname | String | The mailNickname of the user. |
| mobilePhone | String | The mobilePhone of the user. |
| mySite | String | The mySite of the user. |
| officeLocation | String | The officeLocation of the user. |
| onPremisesDistinguishedName | String | The onPremisesDistinguishedName of the user. |
| onPremisesDomainName | String | The onPremisesDomainName of the user. |
| onPremisesExtensionAttributes_extensionAttribute1 | String | The onPremisesExtensionAttributes_extensionAttribute1 of the user. |
| onPremisesExtensionAttributes_extensionAttribute10 | String | The onPremisesExtensionAttributes_extensionAttribute10 of the user. |
| onPremisesExtensionAttributes_extensionAttribute11 | String | The onPremisesExtensionAttributes_extensionAttribute11 of the user. |
| onPremisesExtensionAttributes_extensionAttribute12 | String | The onPremisesExtensionAttributes_extensionAttribute12 of the user. |
| onPremisesExtensionAttributes_extensionAttribute13 | String | The onPremisesExtensionAttributes_extensionAttribute13 of the user. |
| onPremisesExtensionAttributes_extensionAttribute14 | String | The onPremisesExtensionAttributes_extensionAttribute14 of the user. |
| onPremisesExtensionAttributes_extensionAttribute15 | String | The onPremisesExtensionAttributes_extensionAttribute15 of the user. |
| onPremisesExtensionAttributes_extensionAttribute2 | String | The onPremisesExtensionAttributes_extensionAttribute2 of the user. |
| onPremisesExtensionAttributes_extensionAttribute3 | String | The onPremisesExtensionAttributes_extensionAttribute3 of the user. |
| onPremisesExtensionAttributes_extensionAttribute4 | String | The onPremisesExtensionAttributes_extensionAttribute4 of the user. |
| onPremisesExtensionAttributes_extensionAttribute5 | String | The onPremisesExtensionAttributes_extensionAttribute5 of the user. |
| onPremisesExtensionAttributes_extensionAttribute6 | String | The onPremisesExtensionAttributes_extensionAttribute6 of the user. |
| onPremisesExtensionAttributes_extensionAttribute7 | String | The onPremisesExtensionAttributes_extensionAttribute7 of the user. |
| onPremisesExtensionAttributes_extensionAttribute8 | String | The onPremisesExtensionAttributes_extensionAttribute8 of the user. |
| onPremisesExtensionAttributes_extensionAttribute9 | String | The onPremisesExtensionAttributes_extensionAttribute9 of the user. |
| onPremisesImmutableId | String | The onPremisesImmutableId of the user. |
| onPremisesLastSyncDateTime | Datetime | The onPremisesLastSyncDateTime of the user. |
| onPremisesProvisioningErrors | String | The onPremisesProvisioningErrors of the user. |
| onPremisesSamAccountName | String | The onPremisesSamAccountName of the user. |
| onPremisesSecurityIdentifier | String | The onPremisesSecurityIdentifier of the user. |
| onPremisesSyncEnabled | Bool | Indicates onPremisesSyncEnabled for the user. |
| onPremisesUserPrincipalName | String | The onPremisesUserPrincipalName of the user. |
| otherMails | String | The otherMails of the user. |
| passwordPolicies | String | The passwordPolicies of the user. |
| passwordProfile_forceChangePasswordNextSignIn | Bool | Indicate passwordProfile_forceChangePasswordNextSignIn for the user. |
| passwordProfile_forceChangePasswordNextSignInWithMfa | Bool | Indicate passwordProfile_forceChangePasswordNextSignInWithMfa for the user. |
| passwordProfile_password | String | The passwordProfile_password of the user. |
| pastProjects | String | The pastProjects of the user. |
| postalCode | String | The postalCode of the user. |
| preferredLanguage | String | The preferredLanguage of the user. |
| preferredName | String | The preferredName of the user. |
| provisionedPlans | String | The provisionedPlans of the user. |
| proxyAddresses | String | The proxyAddresses of the user. |
| responsibilities | String | The responsibilities of the user. |
| schools | String | The schools of the user. |
| showInAddressList | Bool | Indicate showInAddressList of the user. |
| signInSessionsValidFromDateTime | Datetime | The signInSessionsValidFromDateTime of the user. |
| skills | String | The skills of the user. |
| state | String | The state of the user. |
| streetAddress | String | The streetAddress of the user. |
| surname | String | The surname of the user. |
| usageLocation | String | The usageLocation of the user. |
| userPrincipalName | String | The userPrincipalName of the user. |
| userType | String | The userType of the user. |
| ParentReference | String | The ParentReference of the user. |
Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT operations with Microsoft OneNote.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Microsoft OneNote, along with an indication of whether the procedure succeeded or failed.
Copies a notebook to the Notebooks folder in the destination Documents library. The folder is created if it doesn't exist.
| Name | Type | Required | Description |
| NotebookId | String | True | The id of the notebook that you want to copy. |
| GroupId | String | False | The id of the group to copy to. Use only when copying to an Office 365 group. |
| UserId | String | False | The id of the user to copy to. Use only when copying to an Office 365 user. |
| RenameAs | String | False | The name of the copy. Defaults to the name of the existing item. |
| Name | Type | Description |
| Status | String | Status of the copying operation. |
Copies a page to a specific section.
| Name | Type | Required | Description |
| PageId | String | True | The id of the page that you want to copy. |
| SectionId | String | True | The id of the section that you want to copy. |
| GroupId | String | False | The id of the group to copy to. Use only when copying to an Office 365 group. |
| UserId | String | False | The id of the user to copy to. Use only when copying to an Office 365 user. |
| Name | Type | Description |
| Status | String | Status of the copying operation. |
Copies a section to a specific notebook or section group.
| Name | Type | Required | Description |
| SectionId | String | True | The Id of the section that you want to copy. |
| GroupId | String | False | The Id of the group to copy to. Use only when copying to an Office 365 group. |
| UserId | String | False | The Id of the user to copy to. Use only when copying to an Office 365 user. |
| NotebookId | String | False | The Id of the destination notebook. Either this, or SectionGroupId should be specified. |
| SectionGroupId | String | False | The Id of the destination section group. Either this, or NotebookId should be specified. |
| RenameAs | String | False | The name of the copy. Defaults to the name of the existing item. |
| Name | Type | Description |
| Status | String | Status of the copying operation. |
Creates a new page for the specified section
EXECUTE CreatePage SectionId = '1-8a84fed0-5381-47f3-89bc-cd16f7a4f06d', File = 'C:\\Users\\Dell\\Desktop\\content.html'
| Name | Type | Required | Description |
| SectionId | String | True | The id of the page. |
| Content | String | False | The html content of the page. |
| File | String | False | The path of the file containing the html content of the page. |
| GroupId | String | False | The id of the group. |
| UserId | String | False | The id of the User |
| Name | Type | Description |
| Id | String | The Id of the created page. |
| Status | String | Status of the create page operation. |
| Title | String | Title of the page created. |
To download the file or image resource object
| Name | Type | Required | Description |
| ResourceId | String | True | The Id of the file/image to download. |
| GroupId | String | False | The group id of the resource id. |
| UserId | String | False | The user id of the resource id. |
| Name | String | False | The name of the file/image to download (you can set manually the correct name of the file, or you can set another name). FileName should contain the file format as well. Example: Test.jpg |
| LocalPath | String | False | The local path to save the files/image to. |
| Encoding | String | False | The FileData input encoding type.
The allowed values are NONE, BASE64. The default value is BASE64. |
| Name | Type | Description |
| FullName | String | The name of the downloaded file/image. |
| FullPath | String | The full path (including name) of the downloaded file. |
| Status | String | Status of the downloading document operation. |
| FileData | String | If the LocalPath and FileStream are not provided, this contains the content of the file. |
Gets the admin consent URL that must be opened separately by an admin of a given domain to grant access to your application. Only needed when using custom OAuth credentials.
| Name | Type | Required | Description |
| CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. This value must match the Reply URL in the Azure AD app settings. |
| State | String | False | The same value for state that you sent when you requested the authorization code. |
| Scope | String | False | A space-separated list of scopes to request from the Admin. The default value is 'https://graph.microsoft.com/group.read.all https://graph.microsoft.com/user.read.all https://graph.microsoft.com/notes.readwrite.all' |
| Name | Type | Description |
| URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
Gets an authentication token from OneNote.
| Name | Type | Required | Description |
| AuthMode | String | False | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.
The allowed values are APP, WEB. The default value is APP. |
| CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. This value must match the Reply URL you have specified in the Azure AD app settings. |
| Verifier | String | False | The verifier returned from Azure AD after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL. |
| Scope | String | False | A space-separated list of scopes to request from the user. When OAuthGrantType='CLIENT', a scope of 'https://graph.microsoft.com/.default' is used. '/.default' picks up whatever permissions your app already has. |
| State | String | False | An arbitrary string of your choosing that is returned to your app; a successful roundtrip of this string helps ensure that your app initiated the request. |
| Prompt | String | False | Defaults to 'select_account' which prompts the user to select account while authenticating. Set to 'None', for no prompt, 'login' to force user to enter their credentials or 'consent' to trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app. |
| Name | Type | Description |
| OAuthAccessToken | String | The access token used for communication with OneNote. |
| ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
| OAuthRefreshToken | String | Refresh token to renew the access token. |
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the auth token from this URL.
| Name | Type | Required | Description |
| CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. This value must match the Reply URL in the Azure AD app settings. |
| State | String | False | The same value for state that you sent when you requested the authorization code. |
| Scope | String | False | A space-separated list of scopes to request from the user. When OAuthGrantType='CLIENT', a scope of 'https://graph.microsoft.com/.default' is used. '/.default' picks up whatever permissions your app already has.
The default value is offline_access https://graph.microsoft.com/.default. |
| Prompt | String | False | Defaults to 'select_account' which prompts the user to select account while authenticating. Set to 'None', for no prompt, 'login' to force user to enter their credentials or 'consent' to trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app. |
| Name | Type | Description |
| URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
The HTML content of the particular Page
| Name | Type | Required | Description |
| PageId | String | True | The id of the page. |
| GroupId | String | False | The id of the group. |
| UserId | String | False | The id of the User |
| Name | Type | Description |
| Content | String | The HTML content of the particular Page. |
Refreshes the OAuth access token used for authentication with various OneNote services.
| Name | Type | Required | Description |
| OAuthRefreshToken | String | True | The refresh token returned from the original authorization code exchange. |
| Name | Type | Description |
| OAuthAccessToken | String | The authentication token returned from Azure AD. This can be used in subsequent calls to other operations for this particular service. |
| OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
| ExpiresIn | String | The remaining lifetime on the access token. |
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 OneNote (OData V4) | CData Schema |
| Edm.Binary | binary |
| Edm.Boolean | bool |
| Edm.Date | datetime |
| Edm.DateTimeOffset | datetime |
| Edm.Decimal | decimal |
| Edm.Double | double |
| Edm.Guid | guid |
| Edm.Int32 | int |
| Edm.String | string |
| Edm.TimeOfDay | time |
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.
| Property | Description |
| AuthScheme | Specifies the type of authentication to use when connecting to Microsoft OneNote. If this property is left blank, the default authentication is used. |
| Property | Description |
| IncludeSharePointSites | Whether to retrieve drives for all SharePoint sites when querying Drives view. If 'true' the provider will retrieve all Site IDs recursively and for each of them issue a separate call to get their drives. Therefore, be aware that setting this property to 'true' may decrease performance for the Drives view. |
| Property | Description |
| AzureTenant | Identifies the Microsoft OneNote tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID. |
| AzureEnvironment | Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added. |
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Scope | Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created. |
| Property | Description |
| OAuthJWTCert | Supplies the name of the client certificate's JWT Certificate store. |
| OAuthJWTCertType | Identifies the type of key store containing the JWT Certificate. |
| OAuthJWTCertPassword | Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank. |
| OAuthJWTCertSubject | Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| 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. |
| 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 | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server 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 | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| 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. |
| 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 . |
| Property | Description |
| DefaultGroups | Determines whether to use the /me/memberOf or /groups endpoint for user authentication. |
| DefaultUser | Determines whether to use the /me or /users endpoint for user authentication. |
| GroupId | Specify a default GroupId. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
| UserId | Specify a default UserId. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| AuthScheme | Specifies the type of authentication to use when connecting to Microsoft OneNote. If this property is left blank, the default authentication is used. |
Specifies the type of authentication to use when connecting to Microsoft OneNote. If this property is left blank, the default authentication is used.
For information about creating a custom application to authenticate with Azure AD, see Creating a Custom Authentication App.
This section provides a complete list of the Connection properties you can configure in the connection string for this provider.
| Property | Description |
| IncludeSharePointSites | Whether to retrieve drives for all SharePoint sites when querying Drives view. If 'true' the provider will retrieve all Site IDs recursively and for each of them issue a separate call to get their drives. Therefore, be aware that setting this property to 'true' may decrease performance for the Drives view. |
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 OneNote tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID. |
| AzureEnvironment | Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added. |
Identifies the Microsoft OneNote tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID.
A tenant is a digital container for your organization's users and resources, managed through Microsoft Entra ID (formerly Azure AD). Each tenant is associated with a unique directory ID, and often with a custom domain (for example, microsoft.com or contoso.onmicrosoft.com).
To find the directory (tenant) ID in the Microsoft Entra Admin Center, navigate to Microsoft Entra ID > Properties and copy the value labeled "Directory (tenant) ID".
This property is required in the following cases:
You can provide the tenant value in one of two formats:
Specifying the tenant explicitly ensures that the authentication request is routed to the correct directory, which is especially important when a user belongs to multiple tenants or when using service principal–based authentication.
If this value is omitted when required, authentication may fail or connect to the wrong tenant. This can result in errors such as unauthorized or resource not found.
Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.
Required if your Azure account is part of a different network than the Global network, such as China, USGOVT, or USGOVTDOD.
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 (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Scope | Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created. |
Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
This property is required in two cases:
(When the driver provides embedded OAuth credentials, this value may already be provided by the Sync App and thus not require manual entry.)
OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.
OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.
While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.
For more information on how this property is used when configuring a connection, see Establishing a Connection.
Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.
The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.
OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.
Notes:
For more information on how this property is used when configuring a connection, see Establishing a Connection
Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.
Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.
When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested.
When InitiateOAuth is set to either REFRESH or OFF, you can change which scopes are requested using either this property or the Scope input.
This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthJWTCert | Supplies the name of the client certificate's JWT Certificate store. |
| OAuthJWTCertType | Identifies the type of key store containing the JWT Certificate. |
| OAuthJWTCertPassword | Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank. |
| OAuthJWTCertSubject | Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate. |
Supplies the name of the client certificate's JWT Certificate store.
The OAuthJWTCertType field specifies the type of the certificate store specified in OAuthJWTCert. If the store is password-protected, use OAuthJWTCertPassword to supply the password..
OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, the CData Sync App initiates a search for a certificate. For further information, see OAuthJWTCertSubject.
Designations of certificate stores are platform-dependent.
Notes
Identifies the type of key store containing the JWT Certificate.
| Value | Description | Notes |
| USER | A certificate store owned by the current user. | Only available in Windows. |
| MACHINE | A machine store. | Not available in Java or other non-Windows environments. |
| PFXFILE | A PFX (PKCS12) file containing certificates. | |
| PFXBLOB | A string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. | |
| JKSFILE | A Java key store (JKS) file containing certificates. | Only available in Java. |
| JKSBLOB | A string (base-64-encoded) representing a certificate store in Java key store (JKS) format. | Only available in Java. |
| PEMKEY_FILE | A PEM-encoded file that contains a private key and an optional certificate. | |
| PEMKEY_BLOB | A string (base64-encoded) that contains a private key and an optional certificate. | |
| PUBLIC_KEY_FILE | A file that contains a PEM- or DER-encoded public key certificate. | |
| PUBLIC_KEY_BLOB | A string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. | |
| SSHPUBLIC_KEY_FILE | A file that contains an SSH-style public key. | |
| SSHPUBLIC_KEY_BLOB | A string (base-64-encoded) that contains an SSH-style public key. | |
| P7BFILE | A PKCS7 file containing certificates. | |
| PPKFILE | A file that contains a PPK (PuTTY Private Key). | |
| XMLFILE | A file that contains a certificate in XML format. | |
| XMLBLOB | Astring that contains a certificate in XML format. | |
| BCFKSFILE | A file that contains an Bouncy Castle keystore. | |
| BCFKSBLOB | A string (base-64-encoded) that contains a Bouncy Castle keystore. |
Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
This property specifies the password needed to open a password-protected certificate store. To determine if a password is necessary, refer to the documentation or configuration for your specific certificate store.
Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.
The value of this property is used to locate a matching certificate in the store. The search process works as follows:
You can set the value to '*' to automatically select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For example: CN=www.server.com, OU=test, C=US, [email protected].
Common fields include:
| 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 |
If a field value contains a comma, enclose it in quotes. For example: "O=ACME, Inc.".
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are 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 |
Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.
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.
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 OneNote. Traffic flows back and forth via the proxy at this location. |
| SOCKS4 | 1080 | The port where the Sync App opens a connection to Microsoft OneNote. 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 OneNote. 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.
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.
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.
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.
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 | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server 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 | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies 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.
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. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
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 (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (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.
Supported authentication types :
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.
Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
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 username of a user registered with the proxy server. |
| DIGEST | The username 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. |
Note: The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the username specified in your system proxy settings.
Specifies the password of the user specified in the ProxyUser connection property.
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.
Note: The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the password specified in your system proxy settings.
Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
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. |
Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note: 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.
The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.
Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.
When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;
By default, logged operations from all modules are included.
You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP
To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res
Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.
The available modules and submodules are:
| Module Name | Module Description | Submodules |
| INFO | General Information. Includes the connection string, product version (build number), and initial connection messages. |
|
| EXEC | Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well. |
|
| HTTP | HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages. |
|
| WSDL | Messages pertaining to the generation of WSDL/XSD files. | — |
| SSL | SSL certificate messages. |
|
| AUTH | Authentication related failure/success messages. |
|
| SQL | Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages. |
|
| META | Metadata cache and schema messages. |
|
| FUNC | Information related to executing SQL functions. |
|
| TCP | Incoming and outgoing raw bytes on TCP transport layer messages. |
|
| FTP | Messages pertaining to the File Transfer Protocol. |
|
| SFTP | Messages pertaining to the Secure File Transfer Protocol. |
|
| POP | Messages pertaining to data transferred via the Post Office Protocol. |
|
| SMTP | Messages pertaining to data transferred via the Simple Mail Transfer Protocol. |
|
| CORE | Messages relating to various internal product operations not covered by other modules. | — |
| DEMN | Messages related to SQL remoting. | — |
| CLJB | Messages about bulk data uploads (cloud job). |
|
| SRCE | Miscellaneous messages produced by the product that don't belong in any other module. | — |
| TRANCE | Advanced messages concerning low-level product operations. | — |
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 . |
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.
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.
If left unspecified, the default location is %APPDATA%\\CData\\OneNote 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 .
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 .
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 .
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.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| DefaultGroups | Determines whether to use the /me/memberOf or /groups endpoint for user authentication. |
| DefaultUser | Determines whether to use the /me or /users endpoint for user authentication. |
| GroupId | Specify a default GroupId. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
| UserId | Specify a default UserId. |
Determines whether to use the /me/memberOf or /groups endpoint for user authentication.
Determines whether to use the /me/memberOf or /groups endpoint for user authentication.
Supported values are:
Determines whether to use the /me or /users endpoint for user authentication.
Determines whether to use the /me or /users endpoint for user authentication.
Supported values are:
Specify a default GroupId.
Specify a default GroupId.
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)
Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use 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.
| Property | Description |
| 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=True | Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time). |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
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:
*=*
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
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.
Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.
Disabling the timeout allows 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.
Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UserDefinedViews 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 Notebooks WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
You can use this property to define multiple views in a single file and specify the filepath.
For example:
UserDefinedViews=C:\Path\To\UserDefinedViews.jsonWhen you specify a view in UserDefinedViews, the Sync App only sees that view.
For further information, see User Defined Views.
Specify a default UserId.
Specify a default UserId.
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.