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.
CData provides an embedded OAuth application that simplifies authentication. You can, however, create a custom application for authentication. For information about creating a custom application and reasons for doing so, see Creating a Custom Authentication App.
For authentication, the only difference between using the CData-provided (embedded) application and creating your own custom application is that you must set two additional connection properties in the Advanced Tab when using custom OAuth applications.
Before you connect, for Custom Azure AD applications only, set the following variables:
Click Connect to Microsoft OneNote to open the OAuth endpoint in your default browser. Log in and grant permissions to the application.
The driver then completes the OAuth process as follows:
Azure Service Principal is role-based application-based authentication. This means that authentication is done per application, rather than per user. All tasks taken on by the application are executed without a default user context, but based on the assigned roles. The application access to the resources is controlled through the assigned roles' permissions.
For information about how to set up Azure Service Principal authentication, see Creating a Custom Authentication App.
If you are running Microsoft OneNote on an Azure VM and want to leverage MSI to connect, set AuthScheme to AzureMSI.
When your VM has multiple user-assigned managed identities, you must also specify OAuthClientId.
This topic describes how to:
In portal.azure.com:
Note: Since the embedded OAuth credentials authenticate on a per-user basis, you cannot use them in a client OAuth flow. You must always create a custom OAuth application to use client credentials.
In portal.azure.com:
After your OAuth application is created:
This topic describes how to:
In portal.azure.com:
Note: Since the embedded OAuth credentials authenticate on a per-user basis, you cannot use them in a client OAuth flow. You must always create a custom OAuth application to use client credentials.
In portal.azure.com:
After your OAuth application is created:
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 allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
The Sync App offloads as much of the SELECT statement processing as possible to Microsoft OneNote and then processes the rest of the query in memory (client-side).
See Query Processing for more information.
See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.
By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.
To specify another certificate, see the SSLServerCert property for the available formats to do so.
To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.
In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.
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.
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.
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.
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.
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
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.
| 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. |
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 | The type of authentication to use when connecting to Microsoft OneNote. |
| 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. Note that the SharePointAccessToken or OAuthJWTCert connection property must be specified to query the SharePointSites view and other views if IncludeSharePointSites is set to 'true' when using the CLIENT OAuthGrantType or the AzureServicePrincipal AuthScheme. |
| Property | Description |
| AzureTenant | The Microsoft Online tenant being used to access data. If not specified, your default tenant is used. |
| AzureEnvironment | The Azure Environment to use when establishing a connection. |
| Property | Description |
| OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
| OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
| OAuthGrantType | The grant type for the OAuth flow. |
| Property | Description |
| OAuthJWTCert | The JWT Certificate store. |
| OAuthJWTCertType | The type of key store containing the JWT Certificate. |
| OAuthJWTCertPassword | The password for the OAuth JWT certificate. |
| OAuthJWTCertSubject | The subject of the OAuth JWT certificate. |
| Property | Description |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | This indicates whether to use the system proxy settings or not. |
| ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
| ProxyPort | The TCP port the ProxyServer proxy is running on. |
| ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
| ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
| Property | Description |
| LogModules | Core modules to be included in the log file. |
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
| Property | Description |
| GroupId | Specify this GroupId in order to access the OneNote documents for this group. |
| MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
| Other | These hidden properties are used only in specific use cases. |
| PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
| UserId | Specify this UserId in order to access the OneNote documents for this user. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| AuthScheme | The type of authentication to use when connecting to Microsoft OneNote. |
The type of authentication to use when connecting to Microsoft OneNote.
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. Note that the SharePointAccessToken or OAuthJWTCert connection property must be specified to query the SharePointSites view and other views if IncludeSharePointSites is set to 'true' when using the CLIENT OAuthGrantType or the AzureServicePrincipal AuthScheme. |
This section provides a complete list of the Azure Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| AzureTenant | The Microsoft Online tenant being used to access data. If not specified, your default tenant is used. |
| AzureEnvironment | The Azure Environment to use when establishing a connection. |
The Microsoft Online tenant being used to access data. If not specified, your default tenant is used.
The Microsoft Online tenant being used to access data. For instance, contoso.onmicrosoft.com. Alternatively, specify the tenant Id. This value is the directory Id in the Azure Portal > Azure Active Directory > Properties.
Typically it is not necessary to specify the Tenant. This can be automatically determined by Microsoft when using the OAuthGrantType set to CODE (default). However, it may fail in the case that the user belongs to multiple tenants. For instance, if an Admin of domain A invites a user of domain B to be a guest user. The user will now belong to both tenants. It is a good practice to specify the Tenant, although in general things should normally work without having to specify it.
The AzureTenant is required when setting OAuthGrantType to CLIENT. When using client credentials, there is no user context. The credentials are taken from the context of the app itself. While Microsoft still allows client credentials to be obtained without specifying which Tenant, it has a much lower probability of picking the specific tenant you want to work with. For this reason, we require AzureTenant to be explicitly stated for all client credentials connections to ensure you get credentials that are applicable for the domain you intend to connect to.
The Azure Environment to use when establishing a connection.
In most cases, leaving the environment set to global will work. However, if your Azure Account has been added to a different environment, the AzureEnvironment may be used to specify which environment. The available values are GLOBAL, CHINA, USGOVT, USGOVTDOD.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
| OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
| OAuthGrantType | The grant type for the OAuth flow. |
The client Id assigned when you register your application with an OAuth authorization server.
As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
The client secret assigned when you register your application with an OAuth authorization server.
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.
The grant type for the OAuth flow.
The following options are available: CODE,CLIENT
This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthJWTCert | The JWT Certificate store. |
| OAuthJWTCertType | The type of key store containing the JWT Certificate. |
| OAuthJWTCertPassword | The password for the OAuth JWT certificate. |
| OAuthJWTCertSubject | The subject of the OAuth JWT certificate. |
The JWT Certificate store.
The name of the certificate store for the client certificate.
The OAuthJWTCertType field specifies the type of the certificate store specified by OAuthJWTCert. If the store is password protected, specify the password in OAuthJWTCertPassword.
OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, a search for a certificate is initiated. Please refer to the OAuthJWTCertSubject field for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
| SPC | Software publisher certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
The type of key store containing the JWT Certificate.
This property can take one of the following values:
| USER | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java. |
| MACHINE | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
| PFXFILE | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
| PFXBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. |
| JKSFILE | The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java. |
| JKSBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java. |
| PEMKEY_FILE | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| PEMKEY_BLOB | The certificate store is a string (base64-encoded) that contains a private key and an optional certificate. |
| PUBLIC_KEY_FILE | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| PUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| SSHPUBLIC_KEY_FILE | The certificate store is the name of a file that contains an SSH-style public key. |
| SSHPUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains an SSH-style public key. |
| P7BFILE | The certificate store is the name of a PKCS7 file containing certificates. |
| PPKFILE | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| XMLFILE | The certificate store is the name of a file that contains a certificate in XML format. |
| XMLBLOB | The certificate store is a string that contains a certificate in XML format. |
The password for the OAuth JWT certificate.
If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
The subject of the OAuth JWT certificate.
When loading a certificate the subject is used to locate the certificate in the store.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks the first certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, [email protected]". Common fields and their meanings are displayed below.
| 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 it must be quoted.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
The certificate to be accepted from the server when connecting using TLS/SSL.
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
The protocol used by a proxy-based firewall.
This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that 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.
| Type | Default Port | Description |
| TUNNEL | 80 | When this is set, the Sync App opens a connection to Microsoft OneNote and traffic flows back and forth through the proxy. |
| SOCKS4 | 1080 | When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted. |
| SOCKS5 | 1080 | When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
The name or IP address of a proxy-based firewall.
This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.
Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.
The TCP port for a proxy-based firewall.
This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.
The user name to use to authenticate with a proxy-based firewall.
The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.
A password used to authenticate to a proxy-based firewall.
This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | This indicates whether to use the system proxy settings or not. |
| ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
| ProxyPort | The TCP port the ProxyServer proxy is running on. |
| ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
| ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
This indicates whether to use the system proxy settings or not.
This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of a proxy to route HTTP traffic through.
The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.
If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.
By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.
The TCP port the ProxyServer proxy is running on.
The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.
The authentication type to use to authenticate to the ProxyServer proxy.
This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.
Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
The authentication type can be one of the following:
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
A user name to be used to authenticate to the ProxyServer proxy.
The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:
user@domain domain\user
A password to be used to authenticate to the ProxyServer proxy.
This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.
If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.
If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.
For SOCKS 5 authentication or tunneling, see FirewallType.
By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.
The SSL type to use when connecting to the ProxyServer proxy.
This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:
| AUTO | Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Core modules to be included in the log file. |
Core modules to be included in the log file.
Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.
See the Logging page for an overview.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
A path to the directory that contains the schema files defining tables, views, and stored procedures.
The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\\CData\\OneNote Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| GroupId | Specify this GroupId in order to access the OneNote documents for this group. |
| MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
| Other | These hidden properties are used only in specific use cases. |
| PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
| UserId | Specify this UserId in order to access the OneNote documents for this user. |
Specify this GroupId in order to access the OneNote documents for this group.
Specify this GroupId in order to access the OneNote documents for this group.
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
These hidden properties are used only in specific use cases.
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
This property indicates whether or not to include pseudo columns as columns to the table.
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
The value in seconds until the timeout error is thrown, canceling the operation.
If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout expires and the operation is not yet complete, the Sync App throws an exception.
A filepath pointing to the JSON configuration file containing your custom views.
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.
This User Defined View configuration file is formatted as follows:
For example:
{
"MyView": {
"query": "SELECT * FROM Notebooks WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.jsonNote that the specified path is not embedded in quotation marks.
Specify this UserId in order to access the OneNote documents for this user.
Specify this UserId in order to access the OneNote documents for this user.