Establishing a Connection

Adding a Connection to Microsoft Office 365

To add a connection to Microsoft Office 365:

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

For required properties, see the Settings tab.

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

Authenticating to Microsoft Office 365

Microsoft Office 365 uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.

Azure AD

Azure AD is Microsoft’s multi-tenant, cloud-based directory and identity management service. It is user-based authentication that requires that you set AuthScheme to AzureAD.

Authentication to Azure AD over a Web application always requires the creation of a custom OAuth application .

For details about creating a custom OAuth application, see Creating an Azure AD Application.

Azure Service Principal

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 an Azure AD App with Service Principal.

Managed Service Identity (MSI)

If you are running Microsoft Office 365 on an Azure VM and want to automatically obtain Managed Service Identity (MSI) credentials to connect, set AuthScheme to AzureMSI.

User-Managed Identities

To obtain a token for a managed identity, use the OAuthClientId property to specify the managed identity's client_id.

If your VM has multiple user-assigned managed identities, you must also specify OAuthClientId.

Administrative Tasks

The CData Sync App can be used to perform administrative tasks. This can be done by specifying the UserId column to execute CUD operations.

The UserId Column

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 contact for another user:

INSERT INTO Contacts (displayName, CompanyName, UserId) VALUES ('Bill', 'Bob Co', '12345')

The above request will have the overall effect of attempting to add a contact under the resource at /users/12345/contacts. When UserId is not specified, the resources affected will instead be modified under /users/me/contacts. 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.

Advanced Features

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

User Defined Views

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

SSL Configuration

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

Firewall and Proxy

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

Query Processing

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

For further information, see Query Processing.

Logging

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

SSL Configuration

Customizing the SSL Configuration

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

To specify another certificate, see the SSLServerCert connection property.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

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

Other Proxies

Set the following properties:

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

Data Model

The Sync App models the Microsoft Office 365 API as relational tables. Any changes to the remote data are immediately reflected in your queries; the table definitions are dynamically retrieved. When you connect, the Sync App connects to Microsoft Office 365 and gets the list of tables and the metadata for the tables by calling the appropriate Web services.

API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.

Tables

Tables shows definitions from a sample Office 365 site. The actual data model will be obtained dynamically based on your user credentials and Office 365 site.

Stored Procedures

Stored Procedures are function-like interfaces to Office365. They can be used to search, update, and modify information in Office365.

Tables

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

Microsoft Office 365 Connector for CData Sync Tables


Name	Description
Calendars	This table is dynamic and maps to the corresponding field in the API.
Contacts	The Office365 table Contacts.
Conversations	The Office365 table Conversations.
Events	This field is dynamic and maps to the corresponding field in the API.
Files	The Office365 table Files.
Groups	The Office365 table Groups.
Messages	The Office365 table Messages.
Tasks	The Office365 table Tasks.
Users	Read, Insert, Update and Delete a User.

Calendars

This table is dynamic and maps to the corresponding field in the API.

Table Specific Information

Select

You can query Calendars by specifying an Id or selecting all:

SELECT * FROM Calendars WHERE Id = 'your Calendar Id goes here'

Select a certain column from the entity and filter by that column:

SELECT id FROM Calendars WHERE name LIKE 'Calendar%'

Insert

Specify a Name as a minimum in order to create a new Calendar:

INSERT INTO Calendars (Name) VALUES ('John')

Note: In case of client credentials, UserId is required in order to create a new Calendar:

INSERT INTO Calendars (Name, UserId) VALUES ('Test123', '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe');

Columns


Name	Type	ReadOnly	References	Description
id [KEY]	String	True		This field is dynamic and maps to the corresponding field in the API.
Etag	String	False		This field is dynamic and maps to the corresponding field in the API.
allowedOnlineMeetingProviders	String	False		This field is dynamic and maps to the corresponding field in the API.
canEdit	Bool	False		This field is dynamic and maps to the corresponding field in the API.
canShare	Bool	False		This field is dynamic and maps to the corresponding field in the API.
canViewPrivateItems	Bool	False		This field is dynamic and maps to the corresponding field in the API.
changeKey	String	False		This field is dynamic and maps to the corresponding field in the API.
color	String	False		This field is dynamic and maps to the corresponding field in the API.
defaultOnlineMeetingProvider	String	False		This field is dynamic and maps to the corresponding field in the API.
hexColor	String	False		This field is dynamic and maps to the corresponding field in the API.
isDefaultCalendar	Bool	False		This field is dynamic and maps to the corresponding field in the API.
isRemovable	Bool	False		This field is dynamic and maps to the corresponding field in the API.
isTallyingResponses	Bool	False		This field is dynamic and maps to the corresponding field in the API.
name	String	False		This field is dynamic and maps to the corresponding field in the API.
owner_address	String	False		This field is dynamic and maps to the corresponding field in the API.
owner_name	String	False		This field is dynamic and maps to the corresponding field in the API.
UserId [KEY]	String	False		The UserId column for the table Calendars.

Contacts

The Office365 table Contacts.

Table Specific Information

Select

You can query Contacts by specifying an Id or selecting all:

SELECT * FROM Contacts WHERE Id = 'your Contact Id goes here'

Select a certain column from the entity and filter by that column:

SELECT GivenName FROM Contacts WHERE GivenName LIKE 'John%'

Insert

Specify a GivenName and a Surname as a minimum in order to create a new Contact:

INSERT INTO Contacts (GivenName, Surname) VALUES ('John', 'Smith')

Note: In case of client credentials, UserId is required in order to create a new Contact:

INSERT INTO Contacts (GivenName, Surname, UserId) VALUES ('John', 'Smith', '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe')

Columns


Name	Type	ReadOnly	References	Description
id [KEY]	String	True		The contact's unique identifier.
Etag	String	False
categories	String	False		The categories associated with the contact.
changeKey	String	False		Identifies the version of the contact. This changes every time the contact is changed.
createdDateTime	Datetime	False		The time the contact was created.
lastModifiedDateTime	Datetime	False		The time the contact was last modified.
assistantName	String	False		The name of the contact's assistant.
birthday	Datetime	False		The contact's birthday.
businessAddress_city	String	False		The city of the contact's business address.
businessAddress_countryOrRegion	String	False		The country or region of the contact's business address.
businessAddress_postalCode	String	False		The postal code of the contact's business address.
businessAddress_state	String	False		The state of the contact's business address.
businessAddress_street	String	False		The street of the contact's business address.
businessHomePage	String	False		The business home page of the contact.
businessPhones	String	False		The contact's business phone numbers.
children	String	False		The names of the contact's children.
companyName	String	False		The name of the contact's company.
department	String	False		The department of the contact.
displayName	String	False		The contact's display name.
emailAddresses	String	False		A collection of email address associated with the contact.
fileAs	String	False		The name the contact is filed under.
generation	String	False		The generation of the contact.
givenName	String	False		The given name of the contact.
homeAddress_city	String	False		The city of the contact's home address.
homeAddress_countryOrRegion	String	False		The country or region of the contact's home address.
homeAddress_postalCode	String	False		The postal code of the contact's home address.
homeAddress_state	String	False		The state of the contact's home address.
homeAddress_street	String	False		The street of the contact's home address.
homePhones	String	False		The contact's home phone numbers
imAddresses	String	False		The contact's instant messaging (IM) address.
initials	String	False		The initials of the contact.
jobTitle	String	False		The contact's job title.
manager	String	False		The name of the contact's manager.
middleName	String	False		The contact's middle name.
mobilePhone	String	False		The mobile phone number of the contact.
nickName	String	False		The contact's nickname.
officeLocation	String	False		The location of the contact's address.
otherAddress_city	String	False		The city of the customer's other address.
otherAddress_countryOrRegion	String	False		The country or region of the customer's other address.
otherAddress_postalCode	String	False		The postal code of the customer's other address
otherAddress_state	String	False		The state of the customer's other address.
otherAddress_street	String	False		The street of the customer's other address.
parentFolderId	String	False		The ID of the contact's parent folder.
personalNotes	String	False		The user's notes about the contact.
profession	String	False		The contact's profession.
spouseName	String	False		The name of the contact's spouse/partner.
surname	String	False		The contact's surname.
title	String	False		The contact's title.
yomiCompanyName	String	False		The phonetic Japanese company name of the contact.
yomiGivenName	String	False		The phonetic Japanese given name (first name) of the contact.
yomiSurname	String	False		The phonetic Japanese surname (last name) of the contact.
UserId [KEY]	String	False		The contact's user ID.

Conversations

The Office365 table Conversations.

Table Specific Information

Select

The GroupId is required to get group Conversations.

SELECT * FROM Conversations WHERE GroupId = 'your GroupId goes here'

You can also get group Conversations by using the GroupId and the Conversation Id.

SELECT * FROM Conversations WHERE Id = 'conversation Id here' AND GroupId = 'your GroupId goes here'

Insert

Specify GroupId, Topic, Content, and NewParticipants to create a new Conversation. NewParticipants is a complex type. Its format is as follows: 'name1, email1; name2, email2'.

INSERT INTO Conversations (GroupId, Topic, Content, NewParticipants) VALUES ('GroupId here', 'This is a test topic.', 'Hi, How Are you?', 'someone, [email protected]')

Columns


Name	Type	ReadOnly	References	Description
id [KEY]	String	True		The id column for the table Conversations.
Etag	String	False
hasAttachments	Bool	False		The hasAttachments column for the table Conversations.
lastDeliveredDateTime	Datetime	False		The lastDeliveredDateTime column for the table Conversations.
preview	String	False		The preview column for the table Conversations.
topic	String	False		The topic column for the table Conversations.
uniqueSenders	String	False		The uniqueSenders column for the table Conversations.
GroupId [KEY]	String	False		The GroupId column for the table Conversations.
Content	String	False		The Content column for the table Conversations.
NewParticipants	String	False		The NewParticipants column for the table Conversations.

Events

This field is dynamic and maps to the corresponding field in the API.

Table Specific Information

Select

The 'me' property is used by default to return events.

You can use the UserId in the WHERE clause to override this when searching for Events.

SELECT * FROM Events WHERE UserId = 'abc123' AND Subject LIKE '%test%'

The GroupId can be a calendar type Id or a group Id. For example:

SELECT * FROM Events WHERE GroupId = 'enter your group Id here'

Insert

To create a new event, start and end are required, including the timezone.

INSERT INTO Events (Subject, Body_Content, Start_DateTime, Start_TimeZone, End_DateTime, End_TimeZone) VALUES ('New Test Event', 'Event created using Office365Provider', '2016-01-01T10:00:00', 'UTC', '2016-01-01T11:00:00', 'UTC')

Note: By default this statement will create your event under the default calendar.

Note: In case of client credentials, UserId is required in order to create a new Event:

INSERT INTO Events (Subject, Body_Content, Start_DateTime, Start_TimeZone, End_DateTime, End_TimeZone, UserId) VALUES ('New Test Event', 'Event created using Office365Provider', '2016-01-01T10:00:00', 'UTC', '2016-01-01T11:00:00', 'UTC', '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe')

Columns


Name	Type	ReadOnly	References	Description
id [KEY]	String	True		This field is dynamic and maps to the corresponding field in the API.
Etag	String	False		This field is dynamic and maps to the corresponding field in the API.
categories	String	False		This field is dynamic and maps to the corresponding field in the API.
changeKey	String	False		This field is dynamic and maps to the corresponding field in the API.
createdDateTime	Datetime	False		This field is dynamic and maps to the corresponding field in the API.
lastModifiedDateTime	Datetime	False		This field is dynamic and maps to the corresponding field in the API.
allowNewTimeProposals	Bool	False		This field is dynamic and maps to the corresponding field in the API.
attendees	String	False		This field is dynamic and maps to the corresponding field in the API.
body_content	String	False		This field is dynamic and maps to the corresponding field in the API.
body_contentType	String	False		This field is dynamic and maps to the corresponding field in the API.
bodyPreview	String	False		This field is dynamic and maps to the corresponding field in the API.
end_dateTime	Datetime	False		This field is dynamic and maps to the corresponding field in the API.
end_timeZone	String	False		This field is dynamic and maps to the corresponding field in the API.
hasAttachments	Bool	False		This field is dynamic and maps to the corresponding field in the API.
hideAttendees	Bool	False		This field is dynamic and maps to the corresponding field in the API.
iCalUId	String	False		This field is dynamic and maps to the corresponding field in the API.
importance	String	False		This field is dynamic and maps to the corresponding field in the API.
isAllDay	Bool	False		This field is dynamic and maps to the corresponding field in the API.
isCancelled	Bool	False		This field is dynamic and maps to the corresponding field in the API.
isDraft	Bool	False		This field is dynamic and maps to the corresponding field in the API.
isOnlineMeeting	Bool	False		This field is dynamic and maps to the corresponding field in the API.
isOrganizer	Bool	False		This field is dynamic and maps to the corresponding field in the API.
isReminderOn	Bool	False		This field is dynamic and maps to the corresponding field in the API.
location_address_city	String	False		This field is dynamic and maps to the corresponding field in the API.
location_address_countryOrRegion	String	False		This field is dynamic and maps to the corresponding field in the API.
location_address_postalCode	String	False		This field is dynamic and maps to the corresponding field in the API.
location_address_state	String	False		This field is dynamic and maps to the corresponding field in the API.
location_address_street	String	False		This field is dynamic and maps to the corresponding field in the API.
location_coordinates_accuracy	Double	False		This field is dynamic and maps to the corresponding field in the API.
location_coordinates_altitude	Double	False		This field is dynamic and maps to the corresponding field in the API.
location_coordinates_altitudeAccuracy	Double	False		This field is dynamic and maps to the corresponding field in the API.
location_coordinates_latitude	Double	False		This field is dynamic and maps to the corresponding field in the API.
location_coordinates_longitude	Double	False		This field is dynamic and maps to the corresponding field in the API.
location_displayName	String	False		This field is dynamic and maps to the corresponding field in the API.
location_locationEmailAddress	String	False		This field is dynamic and maps to the corresponding field in the API.
location_locationType	String	False		This field is dynamic and maps to the corresponding field in the API.
location_locationUri	String	False		This field is dynamic and maps to the corresponding field in the API.
location_uniqueId	String	False		This field is dynamic and maps to the corresponding field in the API.
location_uniqueIdType	String	False		This field is dynamic and maps to the corresponding field in the API.
locations	String	False		This field is dynamic and maps to the corresponding field in the API.
onlineMeeting_conferenceId	String	False		This field is dynamic and maps to the corresponding field in the API.
onlineMeeting_joinUrl	String	False		This field is dynamic and maps to the corresponding field in the API.
onlineMeeting_phones	String	False		This field is dynamic and maps to the corresponding field in the API.
onlineMeeting_quickDial	String	False		This field is dynamic and maps to the corresponding field in the API.
onlineMeeting_tollFreeNumbers	String	False		This field is dynamic and maps to the corresponding field in the API.
onlineMeeting_tollNumber	String	False		This field is dynamic and maps to the corresponding field in the API.
onlineMeetingProvider	String	False		This field is dynamic and maps to the corresponding field in the API.
onlineMeetingUrl	String	False		This field is dynamic and maps to the corresponding field in the API.
organizer_emailAddress_address	String	False		This field is dynamic and maps to the corresponding field in the API.
organizer_emailAddress_name	String	False		This field is dynamic and maps to the corresponding field in the API.
originalEndTimeZone	String	False		This field is dynamic and maps to the corresponding field in the API.
originalStart	Datetime	False		This field is dynamic and maps to the corresponding field in the API.
originalStartTimeZone	String	False		This field is dynamic and maps to the corresponding field in the API.
recurrence_pattern_dayOfMonth	Int	False		This field is dynamic and maps to the corresponding field in the API.
recurrence_pattern_daysOfWeek	String	False		This field is dynamic and maps to the corresponding field in the API.
recurrence_pattern_firstDayOfWeek	String	False		This field is dynamic and maps to the corresponding field in the API.
recurrence_pattern_index	String	False		This field is dynamic and maps to the corresponding field in the API.
recurrence_pattern_interval	Int	False		This field is dynamic and maps to the corresponding field in the API.
recurrence_pattern_month	Int	False		This field is dynamic and maps to the corresponding field in the API.
recurrence_pattern_type	String	False		This field is dynamic and maps to the corresponding field in the API.
recurrence_range_endDate	Datetime	False		This field is dynamic and maps to the corresponding field in the API.
recurrence_range_numberOfOccurrences	Int	False		This field is dynamic and maps to the corresponding field in the API.
recurrence_range_recurrenceTimeZone	String	False		This field is dynamic and maps to the corresponding field in the API.
recurrence_range_startDate	Datetime	False		This field is dynamic and maps to the corresponding field in the API.
recurrence_range_type	String	False		This field is dynamic and maps to the corresponding field in the API.
reminderMinutesBeforeStart	Int	False		This field is dynamic and maps to the corresponding field in the API.
responseRequested	Bool	False		This field is dynamic and maps to the corresponding field in the API.
responseStatus_response	String	False		This field is dynamic and maps to the corresponding field in the API.
responseStatus_time	Datetime	False		This field is dynamic and maps to the corresponding field in the API.
sensitivity	String	False		This field is dynamic and maps to the corresponding field in the API.
seriesMasterId	String	False		This field is dynamic and maps to the corresponding field in the API.
showAs	String	False		This field is dynamic and maps to the corresponding field in the API.
start_dateTime	Datetime	False		This field is dynamic and maps to the corresponding field in the API.
start_timeZone	String	False		This field is dynamic and maps to the corresponding field in the API.
subject	String	False		This field is dynamic and maps to the corresponding field in the API.
transactionId	String	False		This field is dynamic and maps to the corresponding field in the API.
type	String	False		This field is dynamic and maps to the corresponding field in the API.
webLink	String	False		This field is dynamic and maps to the corresponding field in the API.
UserId	String	False		This field is dynamic and maps to the corresponding field in the API.
GroupId	String	False		This field is dynamic and maps to the corresponding field in the API.

Files

The Office365 table Files.

Table Specific Information

Select

Retrieve files by using the UserId or File Id (Id) for instance, or simply filter by a certain column:

SELECT * FROM Files WHERE UserId = 'MyUserId'

SELECT Name, LastModifiedDateTime FROM Files WHERE Name LIKE 'test%'

To work for Folder-level files, we need to specify the parentReference_path in the query.

 
SELECT * FROM files WHERE parentReference_path = '/drives/b!3LIvU2zISEqicGlWkgVknKxKT-q7gM5IqlBJ4w4MZqaX6BQc_vtwQpnqaldXkH9I/root:/Test_Shubham';

INSERT

INSERT operation is not supported for this table.

Note: See UploadFile (or CreateFolder to create a folder) to insert and update content to a file.

Columns


Name	Type	ReadOnly	References	Description
id [KEY]	String	True		The id column for the table Files.
Etag	String	False		The Etag column for the table Files.
createdBy_application_displayName	String	False		The createdBy_application_displayName column for the table Files.
createdBy_application_id	String	False		The createdBy_application_id column for the table Files.
createdDateTime	Datetime	False		The createdDateTime column for the table Files.
description	String	False		The description column for the table Files.
lastModifiedBy_application_displayName	String	False		The lastModifiedBy_application_displayName column for the table Files.
lastModifiedBy_application_id	String	False		The lastModifiedBy_application_id column for the table Files.
lastModifiedDateTime	Datetime	False		The lastModifiedDateTime column for the table Files.
name	String	False		The name column for the table Files.
parentReference_driveId	String	False		The parentReference_driveId column for the table Files.
parentReference_driveType	String	False		The parentReference_driveType column for the table Files.
parentReference_id	String	False		The parentReference_id column for the table Files.
parentReference_name	String	False		The parentReference_name column for the table Files.
parentReference_path	String	False		The parentReference_path column for the table Files.
parentReference_shareId	String	False		The parentReference_shareId column for the table Files.
parentReference_sharepointIds_listId	String	False		The parentReference_sharepointIds_listId column for the table Files.
parentReference_sharepointIds_listItemId	String	False		The parentReference_sharepointIds_listItemId column for the table Files.
parentReference_sharepointIds_listItemUniqueId	String	False		The parentReference_sharepointIds_listItemUniqueId column for the table Files.
parentReference_sharepointIds_siteId	String	False		The parentReference_sharepointIds_siteId column for the table Files.
parentReference_sharepointIds_siteUrl	String	False		The parentReference_sharepointIds_siteUrl column for the table Files.
parentReference_sharepointIds_tenantId	String	False		The parentReference_sharepointIds_tenantId column for the table Files.
parentReference_sharepointIds_webId	String	False		The parentReference_sharepointIds_webId column for the table Files.
parentReference_siteId	String	False		The parentReference_siteId column for the table Files.
webUrl	String	False		The webUrl column for the table Files.
audio_album	String	False		The audio_album column for the table Files.
audio_albumArtist	String	False		The audio_albumArtist column for the table Files.
audio_artist	String	False		The audio_artist column for the table Files.
audio_bitrate	Long	False		The audio_bitrate column for the table Files.
audio_composers	String	False		The audio_composers column for the table Files.
audio_copyright	String	False		The audio_copyright column for the table Files.
audio_disc	Int	False		The audio_disc column for the table Files.
audio_discCount	Int	False		The audio_discCount column for the table Files.
audio_duration	Long	False		The audio_duration column for the table Files.
audio_genre	String	False		The audio_genre column for the table Files.
audio_hasDrm	Bool	False		The audio_hasDrm column for the table Files.
audio_isVariableBitrate	Bool	False		The audio_isVariableBitrate column for the table Files.
audio_title	String	False		The audio_title column for the table Files.
audio_track	Int	False		The audio_track column for the table Files.
audio_trackCount	Int	False		The audio_trackCount column for the table Files.
audio_year	Int	False		The audio_year column for the table Files.
content	String	False		The content column for the table Files.
cTag	String	False		The cTag column for the table Files.
deleted_state	String	False		The deleted_state column for the table Files.
file_hashes_crc32Hash	String	False		The file_hashes_crc32Hash column for the table Files.
file_hashes_quickXorHash	String	False		The file_hashes_quickXorHash column for the table Files.
file_hashes_sha1Hash	String	False		The file_hashes_sha1Hash column for the table Files.
file_hashes_sha256Hash	String	False		The file_hashes_sha256Hash column for the table Files.
file_mimeType	String	False		The file_mimeType column for the table Files.
file_processingMetadata	Bool	False		The file_processingMetadata column for the table Files.
fileSystemInfo_createdDateTime	Datetime	False		The fileSystemInfo_createdDateTime column for the table Files.
fileSystemInfo_lastAccessedDateTime	Datetime	False		The fileSystemInfo_lastAccessedDateTime column for the table Files.
fileSystemInfo_lastModifiedDateTime	Datetime	False		The fileSystemInfo_lastModifiedDateTime column for the table Files.
folder_childCount	Int	False		The folder_childCount column for the table Files.
folder_view_sortBy	String	False		The folder_view_sortBy column for the table Files.
folder_view_sortOrder	String	False		The folder_view_sortOrder column for the table Files.
folder_view_viewType	String	False		The folder_view_viewType column for the table Files.
image_height	Int	False		The image_height column for the table Files.
image_width	Int	False		The image_width column for the table Files.
location_altitude	Double	False		The location_altitude column for the table Files.
location_latitude	Double	False		The location_latitude column for the table Files.
location_longitude	Double	False		The location_longitude column for the table Files.
package_type	String	False		The package_type column for the table Files.
pendingOperations_pendingContentUpdate_queuedDateTime	Datetime	False		The pendingOperations_pendingContentUpdate_queuedDateTime column for the table Files.
photo_cameraMake	String	False		The photo_cameraMake column for the table Files.
photo_cameraModel	String	False		The photo_cameraModel column for the table Files.
photo_exposureDenominator	Double	False		The photo_exposureDenominator column for the table Files.
photo_exposureNumerator	Double	False		The photo_exposureNumerator column for the table Files.
photo_fNumber	Double	False		The photo_fNumber column for the table Files.
photo_focalLength	Double	False		The photo_focalLength column for the table Files.
photo_iso	Int	False		The photo_iso column for the table Files.
photo_orientation	Int	False		The photo_orientation column for the table Files.
photo_takenDateTime	Datetime	False		The photo_takenDateTime column for the table Files.
publication_level	String	False		The publication_level column for the table Files.
publication_versionId	String	False		The publication_versionId column for the table Files.
remoteItem_createdBy_application_displayName	String	False		The remoteItem_createdBy_application_displayName column for the table Files.
remoteItem_createdBy_application_id	String	False		The remoteItem_createdBy_application_id column for the table Files.
remoteItem_createdDateTime	Datetime	False		The remoteItem_createdDateTime column for the table Files.
remoteItem_file_hashes_crc32Hash	String	False		The remoteItem_file_hashes_crc32Hash column for the table Files.
remoteItem_file_hashes_quickXorHash	String	False		The remoteItem_file_hashes_quickXorHash column for the table Files.
remoteItem_file_hashes_sha1Hash	String	False		The remoteItem_file_hashes_sha1Hash column for the table Files.
remoteItem_file_hashes_sha256Hash	String	False		The remoteItem_file_hashes_sha256Hash column for the table Files.
remoteItem_file_mimeType	String	False		The remoteItem_file_mimeType column for the table Files.
remoteItem_file_processingMetadata	Bool	False		The remoteItem_file_processingMetadata column for the table Files.
remoteItem_fileSystemInfo_createdDateTime	Datetime	False		The remoteItem_fileSystemInfo_createdDateTime column for the table Files.
remoteItem_fileSystemInfo_lastAccessedDateTime	Datetime	False		The remoteItem_fileSystemInfo_lastAccessedDateTime column for the table Files.
remoteItem_fileSystemInfo_lastModifiedDateTime	Datetime	False		The remoteItem_fileSystemInfo_lastModifiedDateTime column for the table Files.
remoteItem_folder_childCount	Int	False		The remoteItem_folder_childCount column for the table Files.
remoteItem_folder_view_sortBy	String	False		The remoteItem_folder_view_sortBy column for the table Files.
remoteItem_folder_view_sortOrder	String	False		The remoteItem_folder_view_sortOrder column for the table Files.
remoteItem_folder_view_viewType	String	False		The remoteItem_folder_view_viewType column for the table Files.
remoteItem_id	String	False		The remoteItem_id column for the table Files.
remoteItem_image_height	Int	False		The remoteItem_image_height column for the table Files.
remoteItem_image_width	Int	False		The remoteItem_image_width column for the table Files.
remoteItem_lastModifiedDateTime	Datetime	False		The remoteItem_lastModifiedDateTime column for the table Files.
remoteItem_name	String	False		The remoteItem_name column for the table Files.
remoteItem_package_type	String	False		The remoteItem_package_type column for the table Files.
remoteItem_parentReference_driveId	String	False		The remoteItem_parentReference_driveId column for the table Files.
remoteItem_parentReference_driveType	String	False		The remoteItem_parentReference_driveType column for the table Files.
remoteItem_parentReference_id	String	False		The remoteItem_parentReference_id column for the table Files.
remoteItem_parentReference_name	String	False		The remoteItem_parentReference_name column for the table Files.
remoteItem_parentReference_path	String	False		The remoteItem_parentReference_path column for the table Files.
remoteItem_parentReference_shareId	String	False		The remoteItem_parentReference_shareId column for the table Files.
remoteItem_parentReference_sharepointIds_listId	String	False		The remoteItem_parentReference_sharepointIds_listId column for the table Files.
remoteItem_parentReference_sharepointIds_listItemId	String	False		The remoteItem_parentReference_sharepointIds_listItemId column for the table Files.
remoteItem_parentReference_sharepointIds_listItemUniqueId	String	False		The remoteItem_parentReference_sharepointIds_listItemUniqueId column for the table Files.
remoteItem_parentReference_sharepointIds_siteId	String	False		The remoteItem_parentReference_sharepointIds_siteId column for the table Files.
remoteItem_parentReference_sharepointIds_siteUrl	String	False		The remoteItem_parentReference_sharepointIds_siteUrl column for the table Files.
remoteItem_parentReference_sharepointIds_tenantId	String	False		The remoteItem_parentReference_sharepointIds_tenantId column for the table Files.
remoteItem_parentReference_sharepointIds_webId	String	False		The remoteItem_parentReference_sharepointIds_webId column for the table Files.
remoteItem_parentReference_siteId	String	False		The remoteItem_parentReference_siteId column for the table Files.
remoteItem_shared_scope	String	False		The remoteItem_shared_scope column for the table Files.
remoteItem_shared_sharedDateTime	Datetime	False		The remoteItem_shared_sharedDateTime column for the table Files.
remoteItem_size	Long	False		The remoteItem_size column for the table Files.
remoteItem_specialFolder_name	String	False		The remoteItem_specialFolder_name column for the table Files.
remoteItem_video_audioBitsPerSample	Int	False		The remoteItem_video_audioBitsPerSample column for the table Files.
remoteItem_video_audioChannels	Int	False		The remoteItem_video_audioChannels column for the table Files.
remoteItem_video_audioSamplesPerSecond	Int	False		The remoteItem_video_audioSamplesPerSecond column for the table Files.
remoteItem_video_bitrate	Int	False		The remoteItem_video_bitrate column for the table Files.
remoteItem_video_duration	Long	False		The remoteItem_video_duration column for the table Files.
remoteItem_video_fourCC	String	False		The remoteItem_video_fourCC column for the table Files.
remoteItem_video_frameRate	Double	False		The remoteItem_video_frameRate column for the table Files.
remoteItem_video_height	Int	False		The remoteItem_video_height column for the table Files.
remoteItem_video_width	Int	False		The remoteItem_video_width column for the table Files.
remoteItem_webDavUrl	String	False		The remoteItem_webDavUrl column for the table Files.
remoteItem_webUrl	String	False		The remoteItem_webUrl column for the table Files.
searchResult_onClickTelemetryUrl	String	False		The searchResult_onClickTelemetryUrl column for the table Files.
shared_owner_application_displayName	String	False		The shared_owner_application_displayName column for the table Files.
shared_owner_application_id	String	False		The shared_owner_application_id column for the table Files.
shared_scope	String	False		The shared_scope column for the table Files.
shared_sharedDateTime	Datetime	False		The shared_sharedDateTime column for the table Files.
sharepointIds_listId	String	False		The sharepointIds_listId column for the table Files.
sharepointIds_listItemId	String	False		The sharepointIds_listItemId column for the table Files.
sharepointIds_listItemUniqueId	String	False		The sharepointIds_listItemUniqueId column for the table Files.
sharepointIds_siteId	String	False		The sharepointIds_siteId column for the table Files.
sharepointIds_siteUrl	String	False		The sharepointIds_siteUrl column for the table Files.
sharepointIds_tenantId	String	False		The sharepointIds_tenantId column for the table Files.
sharepointIds_webId	String	False		The sharepointIds_webId column for the table Files.
size	Long	False		The size column for the table Files.
specialFolder_name	String	False		The specialFolder_name column for the table Files.
video_audioBitsPerSample	Int	False		The video_audioBitsPerSample column for the table Files.
video_audioChannels	Int	False		The video_audioChannels column for the table Files.
video_audioFormat	String	False		The video_audioFormat column for the table Files.
video_audioSamplesPerSecond	Int	False		The video_audioSamplesPerSecond column for the table Files.
video_bitrate	Int	False		The video_bitrate column for the table Files.
video_duration	Long	False		The video_duration column for the table Files.
video_fourCC	String	False		The video_fourCC column for the table Files.
video_frameRate	Double	False		The video_frameRate column for the table Files.
video_height	Int	False		The video_height column for the table Files.
video_width	Int	False		The video_width column for the table Files.
webDavUrl	String	False		The webDavUrl column for the table Files.
UserId	String	False		The UserId column for the table Files.

Groups

The Office365 table Groups.

Table Specific Information

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 and the Group.ReadWrite.All permissions. This can be done at https://apps.dev.microsoft.com, or in the App Registrations panel at http://portal.azure.com. See Creating an Azure AD Application 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

Note that if your organization has multiple tenants, you may replace the /common/ in the url with the tenant id to indicate which tenant to grant permissions for.

Select

Retrieve all groups, specify a GroupId (Id), or simply filter by a certain column:

SELECT * FROM Groups WHERE Id = 'Group Id here'
SELECT Id, Description, DisplayName FROM Groups WHERE DisplayName = 'test'

Insert

The following are required to create a new Security Group:

INSERT INTO Groups (DisplayName, MailEnabled, MailNickname, SecurityEnabled) VALUES ('Test group', false, 'test', true)

Columns


Name	Type	ReadOnly	References	Description
id [KEY]	String	True		The unique identifier for the group.
Etag	String	False
deletedDateTime	Datetime	False
allowExternalSenders	Bool	False		Indicates if people external to the organization can send messages to the group.
assignedLabels	String	False
assignedLicenses	String	False
autoSubscribeNewMembers	Bool	False		Indicates if new members added to the group will be auto-subscribed to receive email notifications.
classification	String	False
createdDateTime	Datetime	False
description	String	False		An optional description for the group.
displayName	String	False		The display name for the group.
expirationDateTime	Datetime	False
groupTypes	String	False		Specifies the type of group to create. Possible values are Unified to create an Office 365 group, or DynamicMembership for dynamic groups. For all other group types, like security-enabled groups and email-enabled security groups, do not set this property.
hasMembersWithLicenseErrors	Bool	False
hideFromAddressLists	Bool	False
hideFromOutlookClients	Bool	False
isArchived	Bool	False
isSubscribedByMail	Bool	False		Indicates whether the current user is subscribed to receive email conversations.
licenseProcessingState_state	String	False
mail	String	False		The SMTP address for the group.
mailEnabled	Bool	False		Specifies whether the group is mail-enabled. If the securityEnabled property is also true, the group is a mail-enabled security group; otherwise, the group is a Microsoft Exchange distribution group.
mailNickname	String	False		The mail alias for the group, unique in the organization.
membershipRule	String	False
membershipRuleProcessingState	String	False
onPremisesDomainName	String	False
onPremisesLastSyncDateTime	Datetime	False		Indicates the last time at which the group was synced with the on-premises directory.
onPremisesNetBiosName	String	False
onPremisesProvisioningErrors	String	False
onPremisesSamAccountName	String	False
onPremisesSecurityIdentifier	String	False		Contains the on-premises security identifier (SID) for the group that was synchronized from on-premises to the cloud.
onPremisesSyncEnabled	Bool	False		True if this group is synced from an on-premises directory; false if this group was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory.
preferredDataLocation	String	False
preferredLanguage	String	False
proxyAddresses	String	False		The proxy addresses for the table Groups.
renewedDateTime	Datetime	False
securityEnabled	Bool	False		Specifies whether the group is a security group. If the mailEnabled property is also true, the group is a mail-enabled security group; otherwise it is a security group. Must be false for Office 365 groups.
securityIdentifier	String	False
theme	String	False
unseenCount	Int	False		Count of posts that the current user has not seen since his last visit.
visibility	String	False		Specifies the visibility of an Office 365 group. The possible values are: Private, Public, HiddenMembership, or empty (which is interpreted as Public).

Messages

The Office365 table Messages.

Table Specific Information

Select

You can retrieve all from Messages, specify a Message (Id), UserId, or ParentFolderId, or you can filter results by a certain column:

SELECT * FROM Messages WHERE Id = 'MyMessageId'

SELECT * FROM Messages WHERE UserId = 'MyUserId'

SELECT * FROM Messages WHERE ParentFolderId = 'MyParentfolderId' 
SELECT * FROM Messages WHERE ParentFolderId = 'Drafts'
SELECT DisplayName, Id FROM Users WHERE DisplayName LIKE 'John%'

Insert

After the INSERT, a new Message will be created in the User's Drafts folder.

INSERT INTO Messages (Subject, Body_Content, UserId) VALUES ('New test Email', 'Test Email created.', 'User Id goes here')

Note: To send the mail, see SendMail.

Update

To update a message:

UPDATE Messages SET Subject = 'Email Updated', Body_Content = 'New Body Content' WHERE Id = 'MyMessageId'

Preserving HTML Formatting

If you are executing an INSERT or UPDATE and your message has HTML in its body_content, you must set body_contentType to 'html'.

UPDATE Messages SET body_content = '<my html document>', body_contentType = 'html'

If you don't set body_contentType to 'html', the HTML content of the message (such as elements and tags) will be visible in the body of the resulting email as plaintext instead of being processed as HTML.

Known Issues

This table may return an inconsistent number of results. That is, it can return a number of rows for one query and a different numbers of rows in subsequent queries, even when your messages remain unchanged. This means that some messages may be missing when querying this table.

This is a known bug in the Microsoft Graph API.

There is a workaround that allows the Sync App to retrieve all messages, but it comes with a tradeoff: 'events' and 'contacts' data will be returned along with 'messages' data. When using this workaround, you must use filtering to distinguish between message and non-message rows.

To enable this workaround, add "ClientSidePaging=true;" (without quotation marks) in the value of the Other connection property.

Columns


Name	Type	ReadOnly	References	Description
id [KEY]	String	True		The id column of the Messages table.
Etag	String	False		The Etag column of the Messages table.
categories	String	False		The categories column of the Messages table.
changeKey	String	False		The changeKey column of the Messages table.
createdDateTime	Datetime	False		The createdDateTime column of the Messages table.
lastModifiedDateTime	Datetime	False		The lastModifiedDateTime column of the Messages table.
bccRecipients	String	False		The bccRecipients column of the Messages table.
body_content	String	False		The body_content column of the Messages table.
body_contentType	String	False		The body_contentType column of the Messages table.
bodyPreview	String	False		The bodyPreview column of the Messages table.
ccRecipients	String	False		The ccRecipients column of the Messages table.
conversationId	String	False		The conversationId column of the Messages table.
conversationIndex	Binary	False		The conversationIndex column of the Messages table.
flag_completedDateTime_dateTime	Datetime	False		The flag_completedDateTime_dateTime column of the Messages table.
flag_completedDateTime_timeZone	String	False		The flag_completedDateTime_timeZone column of the Messages table.
flag_flagStatus	String	False		The flag_flagStatus column of the Messages table.
from_emailAddress_address	String	False		The from_emailAddress_address column of the Messages table.
from_emailAddress_name	String	False		The from_emailAddress_name column of the Messages table.
hasAttachments	Bool	False		The hasAttachments column of the Messages table.
importance	String	False		The importance column of the Messages table.
inferenceClassification	String	False		The inferenceClassification column of the Messages table.
internetMessageHeaders	String	False		The internetMessageHeaders column of the Messages table.
internetMessageId	String	False		The internetMessageId column of the Messages table.
isDeliveryReceiptRequested	Bool	False		The isDeliveryReceiptRequested column of the Messages table.
isDraft	Bool	False		The isDraft column of the Messages table.
isRead	Bool	False		The isRead column of the Messages table.
isReadReceiptRequested	Bool	False		The isReadReceiptRequested column of the Messages table.
parentFolderId	String	False		The parentFolderId column of the Messages table.
receivedDateTime	Datetime	False		The receivedDateTime column of the Messages table.
replyTo	String	False		The replyTo column of the Messages table.
sender_emailAddress_address	String	False		The sender_emailAddress_address column of the Messages table.
sender_emailAddress_name	String	False		The sender_emailAddress_name column of the Messages table.
sentDateTime	Datetime	False		The sentDateTime column of the Messages table.
subject	String	False		The subject column of the Messages table.
toRecipients	String	False		The toRecipients column of the Messages table.
uniqueBody_content	String	False		The uniqueBody_content column of the Messages table.
uniqueBody_contentType	String	False		The uniqueBody_contentType column of the Messages table.
webLink	String	False		The webLink column of the Messages table.
UserId	String	False		The UserId column of the Messages table.
IsEventMessage	Bool	False		he column to distinguish if the messages is with calendar/event invites

Tasks

The Office365 table Tasks.

Table Specific Information

Tasks requires the Groups and Tasks permissions from the Microsoft Graph. For this reason, you must create your own OAuth App. Please see Creating an Azure AD Application for more details.

Select

By default, if no criteria is specified, only Tasks personally assigned to you will show up. For example:

SELECT * FROM Tasks

To bring back tasks across the organization, provide the specific plans ids, or use a subselect for the plan id. For example:

SELECT * FROM Tasks WHERE PlanId IN (SELECT Id FROM Plans)

Insert

To insert a Task, the associated plan must be specified:

INSERT INTO Tasks (Title, PlanId) VALUES ('My Title', '99999999-eeeeeeeee')

Update

To update a Task, both the Id and Etag must be specified:

UPDATE Tasks SET Title = 'New Title' WHERE Id = 'xxxxxx-AAAAAAAAAAA' AND Etag = 'W/\"XXXXXXQEBAQEBAQEBAQEBAQEBARCc=\"'

Delete

To delete a Task, both the Id and Etag must be specified:

DELETE FROM Tasks WHERE Id = 'xxxxxx-AAAAAAAAAAA' AND Etag = 'W/\"XXXXXXQEBAQEBAQEBAQEBAQEBARCc=\"'

Columns


Name	Type	ReadOnly	References	Description
activeChecklistItemCount	Int	False
appliedCategories	String	False
assigneePriority	String	False
assignments	String	False
bucketId	String	False
checklistItemCount	Int	False
completedBy_application_displayName	String	False
completedBy_application_id	String	False
completedDateTime	Datetime	False
conversationThreadId	String	False
createdBy_application_displayName	String	False
createdBy_application_id	String	False
createdDateTime	Datetime	False
dueDateTime	Datetime	False
hasDescription	Bool	False
orderHint	String	False
percentComplete	Int	False
planId	String	False
previewType	String	False
priority	Int	False
referenceCount	Int	False
startDateTime	Datetime	False
title	String	False
Etag	String	False
Id [KEY]	String	False

Users

Read, Insert, Update and Delete a User.

Table Specific Information

Select

Query the Users table by retrieving everything from Users, specifying a Id, or filtering by a column:

SELECT * FROM Users WHERE Id = '616391f0-32d8-4127-8f25-aa55771d6617'

SELECT DisplayName, Id FROM Users WHERE DisplayName LIKE 'John%'

Insert

The following are required to create a new organizational User:

INSERT INTO Users (AccountEnabled, DisplayName, MailNickname, UserPrincipalName, PasswordProfile_ForceChangePasswordNextSignIn, PasswordProfile_Password) VALUES (false, 'John Smith', 'JohnS', '[email protected]', true, '123password')

Columns


Name	Type	ReadOnly	References	Description
id [KEY]	String	True
deletedDateTime	Datetime	False
accountEnabled	Bool	False
businessPhones	String	False
city	String	False
companyName	String	False
country	String	False
createdDateTime	Datetime	False
department	String	False
displayName	String	False
employeeHireDate	Datetime	False
employeeId	String	False
employeeLeaveDateTime	Datetime	False
employeeOrgData_costCenter	String	False
employeeOrgData_division	String	False
employeeType	String	False
givenName	String	False
identities	String	False
imAddresses	String	False
isResourceAccount	Bool	False
jobTitle	String	False
lastPasswordChangeDateTime	Datetime	False
mail	String	False
mailNickname	String	False
mobilePhone	String	False
officeLocation	String	False
onPremisesDistinguishedName	String	False
onPremisesDomainName	String	False
onPremisesExtensionAttributes_extensionAttribute1	String	False
onPremisesExtensionAttributes_extensionAttribute10	String	False
onPremisesExtensionAttributes_extensionAttribute11	String	False
onPremisesExtensionAttributes_extensionAttribute12	String	False
onPremisesExtensionAttributes_extensionAttribute13	String	False
onPremisesExtensionAttributes_extensionAttribute14	String	False
onPremisesExtensionAttributes_extensionAttribute15	String	False
onPremisesExtensionAttributes_extensionAttribute2	String	False
onPremisesExtensionAttributes_extensionAttribute3	String	False
onPremisesExtensionAttributes_extensionAttribute4	String	False
onPremisesExtensionAttributes_extensionAttribute5	String	False
onPremisesExtensionAttributes_extensionAttribute6	String	False
onPremisesExtensionAttributes_extensionAttribute7	String	False
onPremisesExtensionAttributes_extensionAttribute8	String	False
onPremisesExtensionAttributes_extensionAttribute9	String	False
onPremisesImmutableId	String	False
onPremisesLastSyncDateTime	Datetime	False
onPremisesProvisioningErrors	String	False
onPremisesSamAccountName	String	False
onPremisesSecurityIdentifier	String	False
onPremisesSyncEnabled	Bool	False
onPremisesUserPrincipalName	String	False
otherMails	String	False
passwordProfile_forceChangePasswordNextSignIn	Bool	False
passwordProfile_forceChangePasswordNextSignInWithMfa	Bool	False
passwordProfile_password	String	False
postalCode	String	False
preferredLanguage	String	False
securityIdentifier	String	False
state	String	False
streetAddress	String	False
surname	String	False
userPrincipalName	String	False
userType	String	False

Views

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

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

Microsoft Office 365 Connector for CData Sync Views


Name	Description
CalendarView	Retrieve the ccurrences, exceptions, and single instances of events in a calendar view defined by a time range, from the user's default calendar, or from some other calendar of the user's.
EventAttachments	EventAttachments View for Office365 data provider.
EventOccurrences	Usage information for the operation EventOccurrences.rsd.
MessageAttachments	MessageAttachments View for Office365 data provider.
Plans	The Office365 table Plans.

CalendarView

Retrieve the ccurrences, exceptions, and single instances of events in a calendar view defined by a time range, from the user's default calendar, or from some other calendar of the user's.

Table Specific Information

Select

Get the occurrences, exceptions, and single instances of events in a calendar view defined by a time range, from the user's default calendar, or from some other calendar of the user's. By default only the event occurrences from the user's default calendar in the range of the last 30 days will be returned. You can filter results by CalendarId, UserId, Start_DateTime, End_DateTime.

For example the following queries will be processed server side:

SELECT * FROM CalendarView WHERE Start_DateTime >= '2019-12-10 15:00' AND End_DateTime <= '2020-01-10 14:30'

SELECT * FROM CalendarView WHERE CalendarId = 'AQMkAGRlMWQ5MDg0LWI5ZTQtNDk2Yi1hOTQ1LTU4YzFmMzEwZjlhMgBGAAAD-FjxR3cIwE6TEGSCVtIHcwcAQyR2Iw3coEOaUD1BLt0tnAAAAwcAAABDJHYjDdygQ5pQPUEu3S2cAAACC_IAAAA='

SELECT * FROM CalendarView WHERE CalendarId = 'AQMkAGRlMWQ5MDg0LWI5ZTQtNDk2Yi1hOTQ1LTU4YzFmMzEwZjlhMgBGAAAD-FjxR3cIwE6TEGSCVtIHcwcAQyR2Iw3coEOaUD1BLt0tnAAAAwcAAABDJHYjDdygQ5pQPUEu3S2cAAACC_IAAAA=' AND UserId = 'a98f25b5-5da1-4937-8729-c0d03026caa0' AND Start_DateTime >= '2019-12-15 08:00' AND End_DateTime <= '2020-01-14 08:00'

Columns

References Description String String String String Datetime Datetime Bool String String String String Datetime String Bool Bool String String Bool Bool Bool Bool Bool Bool String String String String String Double Double Double Double Double String String String String String String String String String String String String String String String String String String Datetime String Int String String String Int Int String Datetime Int String Datetime String Int Bool String Datetime String String String Datetime String String String String String String String />


Name	Type style="white-space:nowrap">id
Etag
categories
changeKey
createdDateTime
lastModifiedDateTime
allowNewTimeProposals
attendees
body_content
body_contentType
bodyPreview
end_dateTime
end_timeZone
hasAttachments
hideAttendees
iCalUId
importance
isAllDay
isCancelled
isDraft
isOnlineMeeting
isOrganizer
isReminderOn
location_address_city
location_address_countryOrRegion
location_address_postalCode
location_address_state
location_address_street
location_coordinates_accuracy
location_coordinates_altitude
location_coordinates_altitudeAccuracy
location_coordinates_latitude
location_coordinates_longitude
location_displayName
location_locationEmailAddress
location_locationType
location_locationUri
location_uniqueId
location_uniqueIdType
locations
onlineMeeting_conferenceId
onlineMeeting_joinUrl
onlineMeeting_phones
onlineMeeting_quickDial
onlineMeeting_tollFreeNumbers
onlineMeeting_tollNumber
onlineMeetingProvider
onlineMeetingUrl
organizer_emailAddress_address
organizer_emailAddress_name
originalEndTimeZone
originalStart
originalStartTimeZone
recurrence_pattern_dayOfMonth
recurrence_pattern_daysOfWeek
recurrence_pattern_firstDayOfWeek
recurrence_pattern_index
recurrence_pattern_interval
recurrence_pattern_month
recurrence_pattern_type
recurrence_range_endDate
recurrence_range_numberOfOccurrences
recurrence_range_recurrenceTimeZone
recurrence_range_startDate
recurrence_range_type
reminderMinutesBeforeStart
responseRequested
responseStatus_response
responseStatus_time
sensitivity
seriesMasterId
showAs
start_dateTime
start_timeZone
subject
transactionId
type
webLink
UserId
CalendarId

EventAttachments

EventAttachments View for Office365 data provider.

Columns


Name	Type	References	Description
eventId	String	Events.Id
id [KEY]	String
contentType	String
isInline	Bool
lastModifiedDateTime	Datetime
name	String
size	Int

EventOccurrences

Usage information for the operation EventOccurrences.rsd.

Table Specific Information

Select

You can query EventOccurrences by specifying the Event Id, StartDatetime and EndDateTime. EventId is a required field, instead StartDatetime and EndDateTime have a default range of the last 30 days. If you query filtering only by EventId and the specific event does not exist within this time range, you will get empty results.

SELECT * FROM [EventOccurrences] WHERE id = 'event id' AND StartDateTime = '2018/01/01' AND EndDateTime = '2018/12/31'

By default, if StartDateTime and EndDateTime filters are not specified, only the event occurrences from the user's default calendar in the range of the last 30 days will be returned. Otherwise, the query will get the Occurrences of the Event during the period specified by StartDateTime and EndDateTime.

Columns


Name	Type	References	Description
GroupId	String
UserId	String
Events_id [KEY]	String	Events.id
id [KEY]	String
categories	String
changeKey	String
createdDateTime	Datetime
lastModifiedDateTime	Datetime
allowNewTimeProposals	Bool
attendees	String
body_content	String
body_contentType	String
bodyPreview	String
end_dateTime	Datetime
end_timeZone	String
hasAttachments	Bool
hideAttendees	Bool
iCalUId	String
importance	String
isAllDay	Bool
isCancelled	Bool
isDraft	Bool
isOnlineMeeting	Bool
isOrganizer	Bool
isReminderOn	Bool
location_address_city	String
location_address_countryOrRegion	String
location_address_postalCode	String
location_address_state	String
location_address_street	String
location_coordinates_accuracy	Double
location_coordinates_altitude	Double
location_coordinates_altitudeAccuracy	Double
location_coordinates_latitude	Double
location_coordinates_longitude	Double
location_displayName	String
location_locationEmailAddress	String
location_locationType	String
location_locationUri	String
location_uniqueId	String
location_uniqueIdType	String
locations	String
onlineMeeting_conferenceId	String
onlineMeeting_joinUrl	String
onlineMeeting_phones	String
onlineMeeting_quickDial	String
onlineMeeting_tollFreeNumbers	String
onlineMeeting_tollNumber	String
onlineMeetingProvider	String
onlineMeetingUrl	String
organizer_emailAddress_address	String
organizer_emailAddress_name	String
originalEndTimeZone	String
originalStart	Datetime
originalStartTimeZone	String
recurrence_pattern_dayOfMonth	Int
recurrence_pattern_daysOfWeek	String
recurrence_pattern_firstDayOfWeek	String
recurrence_pattern_index	String
recurrence_pattern_interval	Int
recurrence_pattern_month	Int
recurrence_pattern_type	String
recurrence_range_endDate	Datetime
recurrence_range_numberOfOccurrences	Int
recurrence_range_recurrenceTimeZone	String
recurrence_range_startDate	Datetime
recurrence_range_type	String
reminderMinutesBeforeStart	Int
responseRequested	Bool
responseStatus_response	String
responseStatus_time	Datetime
sensitivity	String
seriesMasterId	String
showAs	String
start_dateTime	Datetime
start_timeZone	String
subject	String
transactionId	String
type	String
webLink	String

MessageAttachments

MessageAttachments View for Office365 data provider.

Columns


Name	Type	References	Description
messageId	String	Messages.Id
id [KEY]	String
contentType	String
isInline	Bool
lastModifiedDateTime	Datetime
name	String
size	Int

Plans

The Office365 table Plans.

Table Specific Information

Using Plans requires access to Groups permissions. This requires Admin approval. For this reason, you must use your own OAuth App to add the Groups permissions and from the Microsoft Graph. See Creating an Azure AD Application for more details.

Select

All plans in MS Planner exist as a part of a group. In order to retrieve the list of available plans, you must retrieve a list of available plans per group. If no GroupId is specified, then the following WHERE condition will be appended to any query:

GroupId IN (SELECT Id FROM Groups)

Columns


Name	Type	References	Description
container_containerId	String
container_type	String
container_url	String
createdBy_application_displayName	String
createdBy_application_id	String
createdDateTime	Datetime
owner	String
title	String
GroupId	String
Id [KEY]	String

Data Type Mapping

Data Type Mappings

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 Office 365 (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

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

Property	Description
AuthScheme	Specifies the type of authentication to use when connecting to Microsoft Office 365. If this property is left blank, the default authentication is used.

Azure Authentication

Property	Description
AzureTenant	Identifies the Microsoft Office 365 tenant being used to access data, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional).
AzureEnvironment	Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.

OAuth

Property	Description
OAuthVersion	The version of OAuth being used.
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
OAuthGrantType	Specifies the grant type for the chosen OAuth flow. This value should be the same as the grant_type that was set during OAuth custom application creation.

JWT OAuth

Property	Description
OAuthJWTCert	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubject	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.

SSL

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

Firewall

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

Proxy

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

Logging

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

Schema

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

Miscellaneous

Property	Description
DirectoryRetrievalDepth	Specify how many folders deep you want to get results for Files table. The resources directly in the root are located at depth 0. The resources one folder deeper are located at depth 1 and so on. You can specify the value -1 to get all the data in a drive no matter the depth they're in.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize	Specifies the maximum number of results to return from Microsoft Office 365, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UseClientSidePaging	Whether or not the CData ADO.NET Provider for Microsoft Office 365 should use client side paging.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Authentication

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 Office 365. If this property is left blank, the default authentication is used.

AuthScheme

Specifies the type of authentication to use when connecting to Microsoft Office 365. If this property is left blank, the default authentication is used.

Remarks

AzureAD: Perform Azure Active Directory (user-based) OAuth authentication.
AzureMSI: Automatically obtain Azure AD Managed Service Identity credentials when running on an Azure VM.
AzureServicePrincipal: Authenticate as an Azure Service Principal (role-based, application-based) using a Client Secret.
AzureServicePrincipalCert: Authenticate as an Azure Service Principal (role-based, application-based) using a Certificate.

For information about creating a custom application to authenticate with Azure AD, see Creating an Azure AD Application.

For information about creating a custom application to authenticate with Azure AD Service Principal, see Creating an Azure AD App with Service Principal.

Azure Authentication

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 Office 365 tenant being used to access data, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional).
AzureEnvironment	Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.

AzureTenant

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

Remarks

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

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

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

AzureEnvironment

Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.

Remarks

Required if your Azure account is part of a different network than the Global network, such as China, USGOVT, or USGOVTDOD.

OAuth

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

Property	Description
OAuthVersion	The version of OAuth being used.
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
OAuthGrantType	Specifies the grant type for the chosen OAuth flow. This value should be the same as the grant_type that was set during OAuth custom application creation.

OAuthVersion

The version of OAuth being used.

Remarks

The version of OAuth being used. The following options are available: 1.0,2.0

OAuthClientId

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

Remarks

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

OAuthClientSecret

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

Remarks

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

OAuthGrantType

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

Remarks

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

JWT OAuth

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

Property	Description
OAuthJWTCert	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubject	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.

OAuthJWTCert

The JWT Certificate store.

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform-dependent.

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


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

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

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

OAuthJWTCertType

The type of key store containing the JWT Certificate.

Remarks

This property can take one of the following values:


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

OAuthJWTCertPassword

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

Remarks

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

OAuthJWTCertSubject

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.

Remarks

The value of this property is used to locate a matching certificate in the store. The search process works as follows:

If an exact match for the subject is found, the corresponding certificate is selected.
If no exact match is found, the store is searched for certificates whose subjects contain the property value.
If no match is found, no certificate is selected.

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

SSL

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.

SSLServerCert

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

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:


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

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

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

Firewall

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.

FirewallType

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

Remarks

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

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

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

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


Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to Microsoft Office 365. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to Microsoft Office 365. 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 Office 365. 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.

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.

Remarks

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

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

FirewallPort

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

Remarks

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

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

FirewallUser

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

Remarks

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

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

FirewallPassword

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

Remarks

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

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

Proxy

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

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

ProxyAutoDetect

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

Remarks

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

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

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

ProxyServer

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

Remarks

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

ProxyPort

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

Remarks

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

For other proxy types, see FirewallType.

ProxyAuthScheme

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

Remarks

The authentication type can be one of the following:

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

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

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

ProxyUser

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

Remarks

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

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


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

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

ProxyPassword

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

Remarks

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

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


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

For SOCKS 5 authentication or tunneling, see FirewallType.

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

ProxySSLType

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

Remarks

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


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

ProxyExceptions

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

Remarks

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

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

Logging

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.

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.

Remarks

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

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

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

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

Schema

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 .

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.

Remarks

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

If left unspecified, the default location is %APPDATA%\\CData\\Office365 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

BrowsableSchemas

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

Remarks

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

Tables

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

Remarks

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

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Views

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

Remarks

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

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

Miscellaneous

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

Property	Description
DirectoryRetrievalDepth	Specify how many folders deep you want to get results for Files table. The resources directly in the root are located at depth 0. The resources one folder deeper are located at depth 1 and so on. You can specify the value -1 to get all the data in a drive no matter the depth they're in.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize	Specifies the maximum number of results to return from Microsoft Office 365, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UseClientSidePaging	Whether or not the CData ADO.NET Provider for Microsoft Office 365 should use client side paging.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

DirectoryRetrievalDepth

Specify how many folders deep you want to get results for Files table. The resources directly in the root are located at depth 0. The resources one folder deeper are located at depth 1 and so on. You can specify the value -1 to get all the data in a drive no matter the depth they're in.

Remarks

This property must be set in the connection string or the driver will use a default of DirectoryRetrievalDepth=5.

MaxRows

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

Remarks

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

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

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

Other

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

Remarks

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

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

Specify multiple properties in a semicolon-separated list.

Integration and Formatting


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

Pagesize

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

Remarks

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

PseudoColumns

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

Remarks

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

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

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

Timeout

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

Remarks

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

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

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

UseClientSidePaging

Whether or not the CData ADO.NET Provider for Microsoft Office 365 should use client side paging.

Remarks

Some sources do not support server side paging. In these cases, set UseClientSidePaging to true. Otherwise, leave it as false. Setting UseClientSidePaging to true on a source that already supports paging can cause incomplete results.

UserDefinedViews

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

Remarks

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

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

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

Refer to User Defined Views for more information.

Microsoft Office 365 Connector for CData Sync

Microsoft Office 365 Connector for CData Sync

Overview

Microsoft Office 365 Version Support

Establishing a Connection

Adding a Connection to Microsoft Office 365

Authenticating to Microsoft Office 365

Azure AD

Azure Service Principal

Managed Service Identity (MSI)

User-Managed Identities

Administrative Tasks

The UserId Column

Advanced Features

User Defined Views

SSL Configuration

Firewall and Proxy

Query Processing

Logging

SSL Configuration

Customizing the SSL Configuration

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Tables

Stored Procedures

Tables

Microsoft Office 365 Connector for CData Sync Tables

Calendars

Table Specific Information

Select

Insert

Columns

Contacts

Table Specific Information

Select

Insert

Columns

Conversations

Table Specific Information

Select

Insert

Columns

Events

Table Specific Information

Select

Insert

Columns

Files

Table Specific Information

Select

INSERT

Columns

Groups

Table Specific Information

Select

Insert

Columns

Messages

Table Specific Information

Select

Insert

Update

Preserving HTML Formatting

Known Issues

Columns

Tasks

Table Specific Information

Select

Insert

Update

Delete

Columns

Users

Table Specific Information

Select

Insert

Columns