Adding a Connection to Microsoft Planner

To add a connection to Microsoft Planner:

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

For required properties, see the Settings tab.

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

Connecting to Microsoft Planner

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

The authentication as an Azure Service Principal is handled via the OAuth Client Credentials flow. It does not involve direct user authentication. Instead, credentials are created for just the application itself. All tasks taken by the app are done without a default user context, but based on the assigned roles. The application access to the resources is controlled through the assigned roles' permissions.

Create an AzureAD App and an Azure Service Principal

When authenticating using an Azure Service Principal, you must create and register an Azure AD application with an Azure AD tenant. See Creating an Azure AD Application for more details.

In your App Registration in portal.azure.com, navigate to API Permissions and select the Microsoft Graph permissions. There are two distinct sets of permissions: Delegated permissions and Application permissions. The permissions used during client credential authentication are under Application Permissions.

Assign a role to the application

To access resources in your subscription, you must assign a role to the application.

1. Open the Subscriptions page by searching and selecting the Subscriptions service from the search bar.
2. Select the subscription to assign the application to.
3. Open the Access control (IAM) and select Add > Add role assignment to open the Add role assignment page.
4. Select Owner as the role to assign to your created Azure AD app.

Complete the Authentication Choose whether to use a client secret or a certificate and follow the relevant steps below.

Client Secret

Set these connection properties:

• AuthScheme: AzureServicePrincipal to use a client secret.
• InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• AzureTenant: The tenant you want to connect to.
• OAuthClientId: The client Id in your application settings.
• OAuthClientSecret: The client secret in your application settings.

Certificate

Set these connection properties:

• AuthScheme: AzureServicePrincipalCert to use a certificate.
• InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• AzureTenant: The tenant you want to connect to.
• OAuthJWTCert: The JWT Certificate store.
• OAuthJWTCertType: The type of the certificate store specified by OAuthJWTCert.

You are now ready to connect. Authentication with client credentials takes place automatically like any other connection, except there is no window opened prompting the user. Because there is no user context, there is no need for a browser popup. Connections take place and are handled internally.

Managed Service Identity (MSI)

If you are running Microsoft Planner 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.

This section details a selection of advanced features of the Microsoft Planner 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 Planner and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Logging

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

Customizing the SSL Configuration

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

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

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

Other Proxies

Set the following properties:

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

The Sync App models Microsoft Planner data like tasks, plans, and buckets as relational tables, allowing you to write SQL to query and modify Microsoft Planner data. Live connectivity to these objects means that any changes to your Microsoft Planner account are immediately reflected in the connection exposed by the Sync App.

Tables

The Tables section, which details standard SQL tables, and the Views section, which lists read-only SQL tables, contain samples of what you might have access to in your Microsoft Planner account.

The following tables and views are shipped with the Sync App:

Table	Description
Buckets	Defines custom columns for tasks, allowing users to categorize work into phases, task types, or departments for better organization.
PlanDetails	Stores metadata and additional settings related to a specific plan, enhancing its customization and management.
Plans	Represents individual plans, each associated with a group, to organize and track project-related tasks.
TaskDetails	Holds detailed information for tasks, including attributes such as priority, due dates, and custom fields.
Tasks	Manages individual tasks, providing functionality for planning, assigning, and tracking initiatives across various projects.
Groups	Represents the groups created automatically when a new plan is initiated, serving as the foundational organizational unit for tasks and plans.
TaskAssignments	Provides a unified view of all tasks assigned to various users, aiding in task tracking and accountability.
TaskComments	Captures discussions, notes, and comments related to tasks within a plan, fostering collaboration and communication.
Users	Tracks user-specific task views and preferences, enabling personalized task management experiences.

Stored Procedures

Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including updating task board formats and retrieving OAuth credentials.

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

Microsoft Planner Connector for CData Sync Tables

Name	Description
Buckets	Defines custom columns for tasks, allowing users to categorize work into phases, task types, or departments for better organization.
PlanDetails	Stores metadata and additional settings related to a specific plan, enhancing its customization and management.
Plans	Represents individual plans, each associated with a group, to organize and track project-related tasks.
TaskDetails	Holds detailed information for tasks, including attributes such as priority, due dates, and custom fields.
Tasks	Manages individual tasks, providing functionality for planning, assigning, and tracking initiatives across various projects.

Defines custom columns for tasks, allowing users to categorize work into phases, task types, or departments for better organization.

Table Specific Information

Select

The Sync App will use the Microsoft Planner API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• PlanId supports the '=' operator.
• BucketId supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Buckets WHERE PlanId = 'nETc1IDpYk3r3e317w8TxGmUAGFWC'
SELECT * FROM Buckets WHERE BucketId = 'qIguxctMLEGHYhmgSVGSNGUAAZOZ'

Insert

Required fields for an insert are: name and planId.
Optional: orderHint.

INSERT INTO Buckets (Name, PlanId) VALUES ('Advertising', 'xqQg5FS2LkCp935s-FIFm2QAFkHM')
INSERT INTO Buckets (Name, PlanId, orderHint) VALUES ('Advertising', 'xqQg5FS2LkCp935s-FIFm2QAFkHM', ' !')

Update

Microsoft Planner allows updates for the name and orderHint columns.

UPDATE Buckets SET Name = 'To do', orderHint = ' !' WHERE BucketId = 'rWpNKGmHukm84GaiDF_ZL2UAOlMj'

Delete

Buckets can be deleted by providing BucketId.

DELETE FROM Buckets WHERE BucketId = 'yHiJQjZK0kGVt4flhItk0mUANJwN'

Columns

Name	Type	ReadOnly	Description
BucketId [KEY]	String	False	A globally unique identifier assigned to each bucket, used for referencing and managing the bucket.
name	String	False	The descriptive name assigned to the bucket, typically used to categorize or label tasks.
orderHint	String	False	A value used to determine the order of buckets in a list view, ensuring a user-defined sequence.
planId	String	False	The unique identifier of the plan to which the bucket belongs links it to a specific project or context.
Etag	String	False	A unique value that identifies the current version of the bucket resource is used for concurrency control and updates.

Stores metadata and additional settings related to a specific plan, enhancing its customization and management.

Table Specific Information

Select

The Sync App will use the Microsoft Planner API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• PlanId supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM PlanDetails WHERE planId = 'nETc1IDpYkmb1E17w8TxGmUAGFWC'

INSERT

INSERT is not supported for this table.

Update

Microsoft Planner allows updates for the title, bucketId, percentComplete, assigneePriority, conversationThreadId, orderHint, dueDateTime and startDateTime columns.

UPDATE PlanDetails SET categoryDescriptions_category1 = 'Cat#1', categoryDescriptions_category2 = 'Cat#2', categoryDescriptions_category3 = 'Cat#3', categoryDescriptions_category4 = 'Cat#4', categoryDescriptions_category5 = 'Cat#5', categoryDescriptions_category6 = 'Cat#6'  WHERE PlanId = 'nETc1IDpYkmb1E17w8TxGmUAGFWC'

Delete

Delete is not supported for this table.

Columns

Name	Type	ReadOnly	Description
PlanId [KEY]	String	False	Unique identifier for the plan, used to distinguish it from other plans in the system.
categoryDescriptions_category1	String	False	Indicates if the task is associated with the pink category, commonly used for color-coded task organization.
categoryDescriptions_category10	String	False	Indicates if the task is associated with the gray category.
categoryDescriptions_category11	String	False	Indicates if the task is associated with the silver category.
categoryDescriptions_category12	String	False	Indicates if the task is associated with the brown category.
categoryDescriptions_category13	String	False	Indicates if the task is associated with the cranberry category.
categoryDescriptions_category14	String	False	Indicates if the task is associated with the orange category.
categoryDescriptions_category15	String	False	Indicates if the task is associated with the peach category.
categoryDescriptions_category16	String	False	Indicates if the task is associated with the marigold category.
categoryDescriptions_category17	String	False	Indicates if the task is associated with the light green category.
categoryDescriptions_category18	String	False	Indicates if the task is associated with the dark green category.
categoryDescriptions_category19	String	False	Indicates if the task is associated with the teal category.
categoryDescriptions_category2	String	False	Indicates if the task is associated with the red category, often symbolizing high-priority or critical tasks.
categoryDescriptions_category20	String	False	Indicates if the task is associated with the light blue category.
categoryDescriptions_category21	String	False	Indicates if the task is associated with the dark blue category.
categoryDescriptions_category22	String	False	Indicates if the task is associated with the lavender category.
categoryDescriptions_category23	String	False	Indicates if the task is associated with the plum category.
categoryDescriptions_category24	String	False	Indicates if the task is associated with the light gray category.
categoryDescriptions_category25	String	False	Indicates if the task is associated with the dark gray category.
categoryDescriptions_category3	String	False	Indicates if the task is associated with the yellow category, often symbolizing caution or tasks requiring attention.
categoryDescriptions_category4	String	False	Indicates if the task is associated with the green category, commonly used for tasks signaling progress or success.
categoryDescriptions_category5	String	False	Indicates if the task is associated with the blue category, often representing trust or stability.
categoryDescriptions_category6	String	False	Indicates if the task is associated with the purple category, typically used for strategic or creative tasks.
categoryDescriptions_category7	String	False	Indicates if the task is associated with the bronze category.
categoryDescriptions_category8	String	False	Indicates if the task is associated with the lime category.
categoryDescriptions_category9	String	False	Indicates if the task is associated with the aqua category.
sharedWith	String	False	Lists the files or entities with which the plan is shared, enabling collaboration and visibility.

Represents individual plans, each associated with a group, to organize and track project-related tasks.

Table Specific Information

Select

The Sync App will use the Microsoft Planner API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

If Scope = NoAdminConsent, List the data related to the groups that the user is a member of.

If Scope = AdminConsent, List all the data related to groups.

• PlanId supports the '=' operator.

For example, the following query is processed server side:

SELECT * FROM Plans WHERE PlanId = 'nETc1IDpYk3r3e317w8TxGmUAGFWC'

Insert

Required fields for an insert are: title and owner.

INSERT INTO Plans (title, owner) VALUES ('Plan#5', 'acc24236-0d62-4d30-9a7f-98cfbcd3a6e7')

Update

Microsoft Planner allows updates for the title and owner columns.

UPDATE Plans SET  title = 'Plan#1' WHERE PlanId = 'nETc1IDpYkmb1E17c4TxGmUAGFWC'

Columns

Name	Type	ReadOnly	Description
PlanId [KEY]	String	False	A globally unique identifier (GUID) representing the specific plan within the system.
container_containerId	String	False	The unique identifier of the container, such as a group or team, that hosts the plan.
container_type	String	False	Indicates the type of resource (for example, group, team) that serves as the container for this plan.
container_url	String	False	A URL that provides a direct reference to the container of the plan, enabling easy access or navigation.
createdBy_application_displayName	String	False	The display name of the application or user that initiated the creation of this plan.
createdBy_application_id	String	False	The unique identifier (ID) of the application or user responsible for creating the plan.
createdDateTime	Datetime	False	The exact date and time when the plan was created, recorded in ISO 8601 format.
owner	String	False	The unique identifier of the group or entity that owns and manages the plan.
title	String	False	The descriptive name or title assigned to the plan for identification and categorization.
details_id	String	True	A unique identifier linking to the details or metadata associated with the plan.
GroupId	String	False	The unique identifier for the group associated with this plan, often used for permissions and ownership.
Etag	String	False	A version control token used to track changes and ensure consistency for this resource.

Holds detailed information for tasks, including attributes such as priority, due dates, and custom fields.

Table Specific Information

Select

The Sync App will use the Microsoft Planner API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• TaskId supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM TaskDetails WHERE TaskId = '7POTl5DUfkOsgzptPrzdzGUAHy1z'

INSERT

INSERT is not supported for this table.

Update

Microsoft Planner allows updates for the title, bucketId, percentComplete, assigneePriority, conversationThreadId, orderHint, dueDateTime and startDateTime columns.

UPDATE TaskDetails SET Description = 'Task description', previewType = 'reference' WHERE TaskId = '7POTl5DUfkOsgzptPrzdzGUAHy1z'

Delete

Delete is not supported for this table.

Columns

Name	Type	ReadOnly	Description
CheckListId [KEY]	String	False	A unique identifier for the checklist, ensuring each checklist can be individually distinguished.
TaskId [KEY]	String	False	A unique identifier for the task associated with the checklist, linking it to its parent task.
isChecked	Bool	False	Indicates whether the checklist item is marked as completed (true) or pending (false).
checklist_lastModifiedBy_application_displayName	String	False	The display name of the application that last modified the checklist, providing traceability.
checklist_lastModifiedBy_application_id	String	False	The unique identifier of the application responsible for the last modification of the checklist, aiding in tracking changes.
lastModifiedDateTime	Datetime	False	The timestamp representing the most recent modification to the checklist, enabling version tracking.
orderHint	String	False	A hint value used to define the display order of checklist items relative to one another.
title	String	False	The title or name of the checklist item, summarizing its purpose or content.
description	String	False	A detailed description of the task, offering additional context or instructions.
previewType	String	False	Defines the type of preview displayed for the task, such as an image, link, or other content type.
references	String	False	A collection of related references or external resources linked to the task.
PlanId	String	False	A unique identifier for the plan to which the task belongs, ensuring proper association.

Manages individual tasks, providing functionality for planning, assigning, and tracking initiatives across various projects.

Table Specific Information

Select

The Sync App will use the Microsoft Planner API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• TaskId supports the '=' operator.
• PlanId supports the '=' operator.
• UserId supports the '=' operator.
• BucketId supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Tasks WHERE TaskId = 'BCrvyMoiLEafem-3RxIESmUAHbLK'
SELECT * FROM Tasks WHERE PlanId = 'nETc1IDpYk3r3e317w8TxGmUAGFWC'
SELECT * FROM Tasks WHERE UserId = '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe'
SELECT * FROM Tasks WHERE BucketId = 'qIguxctMLEGHYhmgSVGSNGUAAZOZ'

Insert

Required fields for an insert are: title and planId.
Optional: bucketId.

INSERT INTO Tasks (title, planId) VALUES ('test44', 'nETc1IDpYkmb1E17w8TxGmUAGFWC')
INSERT INTO Tasks (title, planId, bucketId) VALUES ('test44', 'nETc1IDpYkmb1E17w8TxGmUAGFWC', 'ZfzKVriNQ0yzR4IqJp-8FWUADq0Y')

Update

Microsoft Planner allows updates for the title, bucketId, percentComplete, assigneePriority, conversationThreadId, orderHint, dueDateTime and startDateTime columns.

UPDATE Tasks SET assigneePriority = '8377555 94446!', bucketId = 'rWpNKGmHukm84GaiDF_ZL2UAOlMj', conversationThreadId = 'AAQkADlmMzE1ZGIzLWY3OTctNDcyMy1iYmNlLWNlZmNlZTc5', dueDateTime = '2019-09-30T14:49:23', orderHint = '343d 454fd!', startDateTime = '2019-07-31T14:49:23.269', title = 'updatedTask', percentComplete = '35'  WHERE TaskId = '7POTl5DUfkOsgzptPrzdzGUAHy1z'

Delete

Tasks can be deleted by providing TaskId.

DELETE FROM Tasks WHERE TaskId = 'BCrvyMoiLEafem-3RxIESmUAHbLK'

Columns

Name	Type	ReadOnly	Description
TaskId [KEY]	String	False	A unique identifier assigned to each task, ensuring it can be distinctly referenced.
activeChecklistItemCount	Int	False	The count of checklist items associated with the task that are not marked as completed.
appliedCategories	String	False	A list of categories or tags that have been applied to this task for organizational purposes.
assigneePriority	String	False	A priority value used to determine the relative order of tasks in a list view for assignees.
assignments	String	False	A collection representing the users or groups assigned to work on this task.
bucketId	String	False	The unique identifier of the bucket within the plan where this task is grouped.
checklistItemCount	Int	False	The total number of checklist items that are part of this task, including completed and active items.
completedBy_application_displayName	String	False	The display name of the application that marked this task as completed.
completedBy_application_id	String	False	The unique identifier of the application that marked this task as completed.
completedDateTime	Datetime	False	The exact date and time when the task was marked as completed.
conversationThreadId	String	False	The identifier of the conversation thread linked to this task, if applicable.
createdBy_application_displayName	String	False	The display name of the application that created this task.
createdBy_application_id	String	False	The unique identifier of the application that created this task.
createdDateTime	Datetime	False	The date and time when the task was created.
dueDateTime	Datetime	False	The deadline date and time by which the task should be completed.
hasDescription	Bool	False	Indicates whether the task contains a detailed description (true) or not (false).
orderHint	String	False	A hint value used to determine the task's order relative to others in its list or view.
percentComplete	Int	False	The percentage indicating the extent to which the task has been completed.
planId	String	False	The unique identifier of the plan that this task belongs to.
previewType	String	False	Defines the type of visual preview (for example, image, document) displayed on the task.
priority	Int	False	An integer value representing the priority level of the task, with lower values indicating higher priority.
referenceCount	Int	False	The total count of external references, such as links or documents, associated with this task.
startDateTime	Datetime	False	The scheduled start date and time for this task.
title	String	False	The descriptive title or name of the task.
assignedToTaskBoardFormat_id	String	True	A unique identifier used for rendering the task in task board views when grouped by assignees.
bucketTaskBoardFormat_id	String	True	A unique identifier used for rendering the task in task board views when grouped by buckets.
details_id	String	True	The identifier for additional details associated with this task.
progressTaskBoardFormat_id	String	True	A unique identifier used for rendering the task in task board views when grouped by progress status.
UserId	String	False	The unique identifier of the user associated with this task.
Etag	String	False	An identifier for the specific version of the task resource, used for tracking changes.
GroupId	String	False	The unique identifier of the group associated with this task.

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 Planner Connector for CData Sync Views

Name	Description
Groups	Represents the groups created automatically when a new plan is initiated, serving as the foundational organizational unit for tasks and plans.
TaskAssignments	Provides a unified view of all tasks assigned to various users, aiding in task tracking and accountability.
TaskComments	Captures discussions, notes, and comments related to tasks within a plan, fostering collaboration and communication.
Users	Tracks user-specific task views and preferences, enabling personalized task management experiences.

Represents the groups created automatically when a new plan is initiated, serving as the foundational organizational unit for tasks and plans.

Table Specific Information

Select

The Sync App uses the Microsoft Planner API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Sync App.

If Scope = NoAdminConsent: Lists data related to the groups that the user is a member of.

If Scope = AdminConsent: Lists all data related to groups.

• Id supports the '=' operator.

For example, the following query is processed server-side:

SELECT * FROM Groups WHERE Id = 'nETc1IDpYkmb1E17w8TxGmUAGFWC'

Columns

Name	Type	Description
Id [KEY]	String	A unique identifier for the group, used as a primary key across systems.
deletedDateTime	Datetime	The timestamp indicating when the group was deleted, if applicable.
allowExternalSenders	Bool	Specifies whether individuals outside the organization can send messages to the group.
assignedLabels	String	A list of sensitivity label pairs applied to the group for classification and compliance.
assignedLicenses	String	A list of licenses assigned to the group, specifying its entitlements.
autoSubscribeNewMembers	Bool	Indicates whether new members are automatically subscribed to receive group email notifications.
classification	String	Defines the classification level for the group, such as confidential or public.
createdDateTime	Datetime	The date and time when the group was created.
description	String	An optional text description providing additional context about the group's purpose.
displayName	String	The display name of the group, commonly shown in user interfaces.
expirationDateTime	Datetime	The date and time when the group is set to expire, if applicable.
groupTypes	String	Indicates the type of group (for example, security or Microsoft 365) and its membership type.
hasMembersWithLicenseErrors	Bool	Indicates whether any members have licensing errors due to group-based license assignments.
hideFromAddressLists	Bool	Indicates whether the group is hidden from address lists in the organization.
hideFromOutlookClients	Bool	Specifies if the group is hidden from being displayed in Outlook clients.
isArchived	Bool	Indicates if the group is archived, typically for read-only access in associated teams.
isAssignableToRole	Bool	Specifies whether the group can be assigned to roles in Microsoft Entra (formerly Azure AD).
isSubscribedByMail	Bool	Indicates if the signed-in user is subscribed to receive email conversations from the group.
licenseProcessingState_state	String	Represents the current processing state of group-based license assignments.
mail	String	The primary email address associated with the group.
mailEnabled	Bool	Specifies whether the group is enabled to send and receive emails.
mailNickname	String	The mail alias for the group, often used as part of the email address.
membershipRule	String	The dynamic membership rule that defines group membership criteria.
membershipRuleProcessingState	String	Indicates whether the dynamic membership rules are actively being processed.
onPremisesDomainName	String	The domain name of the group as synchronized from an on-premises directory.
onPremisesLastSyncDateTime	Datetime	The date and time of the last synchronization with the on-premises directory.
onPremisesNetBiosName	String	The NetBIOS name of the group as synchronized from the on-premises directory.
onPremisesProvisioningErrors	String	Details of any provisioning errors encountered during synchronization from the on-premises directory.
onPremisesSamAccountName	String	The software asset management (SAM) account name of the group as synchronized from the on-premises directory.
onPremisesSecurityIdentifier	String	The security identifier (SID) of the group as synchronized from the on-premises directory.
onPremisesSyncEnabled	Bool	Indicates whether the group is actively synced with the on-premises directory.
preferredDataLocation	String	The preferred data residency location for the group's content.
preferredLanguage	String	The preferred language setting for the group, used for communication and display.
proxyAddresses	String	A list of email addresses associated with the group that redirect to the group mailbox.
renewedDateTime	Datetime	The timestamp indicating when the group was last renewed.
securityEnabled	Bool	Specifies whether the group is a security group used for access control.
securityIdentifier	String	The security identifier (SID) uniquely assigned to the group.
serviceProvisioningErrors	String	Details of any errors encountered during service provisioning for the group.
theme	String	The color theme associated with the group, used in user interfaces.
uniqueName	String	A unique identifier or alias that can be used as an alternate key for the group.
unseenCount	Int	The number of new posts in conversations since the user last accessed the group.
visibility	String	Defines the group's join policy and visibility settings (for example, public or private).
calendar_id	String	The unique identifier of the group's calendar.
createdOnBehalfOf_id	String	The unique identifier of the user or application that created the group.
drive_id	String	The unique identifier of the group's associated drive.
onenote_id	String	The unique identifier of the group's OneNote notebook is read-only.
photo_id	String	The unique identifier of the group's profile photo.
planner_id	String	The unique identifier of the group's associated planner.
team_id	String	The unique identifier of the Microsoft Teams entity associated with the group.

Provides a unified view of all tasks assigned to various users, aiding in task tracking and accountability.

Table Specific Information

Select

The Sync App uses the Microsoft Planner API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Sync App.

If Scope = NoAdminConsent: Lists data related to the groups that the user is a member of.

If Scope = AdminConsent: Lists all data related to groups.

• TaskId supports the '=' operator.
• PlanId supports the '=' and 'IN' operators.
• BucketId supports the '=' operator.

For example, the following queries are processed server-side:

SELECT * FROM TaskAssignments WHERE TaskId = 'BCrvyMoiLEafem-3RxIESmUAHbLK'
SELECT * FROM TaskAssignments WHERE PlanId = 'nETc1IDpYk3r3e317w8TxGmUAGFWC'
SELECT * FROM TaskAssignments WHERE PlanId IN ('nETc1IDpYk3r3e317w8TxGmUAGFWC', 'v8iK3uCb30C5I_ocMGu3SGUAHQLI', 't2eNwoPxpEqhZs38GwT1HWUADwjN')
SELECT * FROM TaskAssignments WHERE BucketId = 'qIguxctMLEGHYhmgSVGSNGUAAZOZ'

Columns

Name	Type	Description
TaskId [KEY]	String	A unique identifier for the task within the system, used to distinguish it from other tasks.
PlanId [KEY]	String	A unique identifier for the plan to which this task belongs, linking tasks to their respective plans.
BucketId	String	The identifier for the bucket within the plan that organizes tasks into groups or categories.
AssignedToUser [KEY]	String	The user ID of the person to whom the task is assigned, indicating responsibility for completing the task.
AssignedByUserId	String	The user ID of the person who assigned the task, used for tracking task assignments.
AssignedByUserName	String	The name of the person who assigned the task, providing a human-readable reference for the assigner.
AssignedDateTime	String	The date and time when the task was assigned, enabling tracking of assignment history.
OrderHint	String	A value used to determine the display order of assignees within a task, allowing for prioritized arrangement.

Captures discussions, notes, and comments related to tasks within a plan, fostering collaboration and communication.

Table Specific Information

Select

The Sync App uses the Microsoft Planner API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Sync App.

If Scope = NoAdminConsent: Lists data related to the groups that the user is a member of.

If Scope = AdminConsent: Lists all data related to groups.

• GroupId supports the '=' operator.
• ConversationThreadId supports the '=' operator.

For example, the following queries are processed server-side:

SELECT * FROM TaskComments
SELECT * FROM TaskComments WHERE GroupId = '73094928-3786-4246-a0d1-90c'
SELECT * FROM TaskComments WHERE ConversationThreadId = 'AAQkADBlMTk2ZmZjLTJlZmYtNGQ0Zi05ZmViLTQwNzM0MWM0NWU5ZAMkABAAWZ7-9ddvEUa7ZFI'
SELECT * FROM TaskComments WHERE ConversationThreadId = 'AAQkADBlMTk2ZmZjLTJlZmYtNGQ0Zi05ZmViLTQwNzM0MWM0NWU5ZAMkABAAWZ7-9ddvEUa7ZFI' and GroupId = '73094928-3786-4246-a0d1-90c'

Columns

Name	Type	Description
conversationId [KEY]	String	The unique identifier for the conversation associated with the task comment.
body_content	String	The main content or message body of the task comment.
body_contentType	String	The format type of the content in the message body (for example, plain text, HTML).
conversationThreadId	String	The unique identifier for the thread within the conversation.
from_emailAddress_address	String	The email address of the individual or entity that sent the message.
from_emailAddress_name	String	The display name of the individual or entity that sent the message.
hasAttachments	Bool	Indicates whether the task comment includes any attachments.
newParticipants	String	A list of new participants added to the conversation.
receivedDateTime	Datetime	The timestamp when the message was received, including date and time.
sender_emailAddress_address	String	The email address of the sender of the task comment.
sender_emailAddress_name	String	The display name of the sender of the task comment.
inReplyTo_id	String	The unique identifier of the message to which this comment is replying.
GroupId	String	The unique identifier of the group associated with the task comment.

Tracks user-specific task views and preferences, enabling personalized task management experiences.

Table Specific Information

Select

The Sync App uses the Microsoft Planner API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Sync App.

• Id supports the '=' operator.

For example, the following query is processed server-side:

SELECT * FROM Users WHERE UserId = '9523f1-aa0-4fe17-a9w7b-6860618adf'

Columns

Name	Type	Description
UserId [KEY]	String	Unique identifier assigned to each user in the system.
aboutMe	String	A brief personal description provided by the user, visible in their profile.
accountEnabled	Bool	Indicates whether the user's account is active and can be used for sign-in.
ageGroup	String	Specifies the age group classification of the user, often for compliance purposes.
assignedLicenses	String	A list of licenses assigned to the user, including those inherited through group memberships.
assignedPlans	String	Details of service plans that are enabled for the user.
authorizationInfo_certificateUserIds	String	A collection of certificate user IDs associated with authorization information for this user.
birthday	Datetime	The user's date of birth, if provided.
businessPhones	String	The phone numbers listed as business contact numbers for the user.
city	String	The city where the user is currently located or associated with.
companyName	String	The name of the company or organization the user belongs to.
consentProvidedForMinor	String	Indicates whether consent was obtained for processing data related to a minor.
country	String	The country or region where the user resides.
createdDateTime	Datetime	The timestamp when the user's account was created in the directory.
creationType	String	Defines how the user account was created, for example, via manual input, synchronization, or automation.
customSecurityAttributes	String	A customizable set of attributes for security-specific configurations assigned to the user.
department	String	The department or organizational unit where the user works.
deviceEnrollmentLimit	Int	The maximum number of devices the user is allowed to enroll.
displayName	String	The name displayed in the organization's address book for this user.
employeeHireDate	Datetime	The user's start date in their current role or organization.
employeeId	String	A unique identifier assigned to the user by their employer.
employeeLeaveDateTime	Datetime	The date and time when the user is expected to leave or has left the organization.
employeeOrgData_costCenter	String	The cost center associated with the user's organizational data.
employeeOrgData_division	String	The division or sub-unit within the organization associated with the user.
employeeType	String	Specifies the user's role type, such as full-time, part-time, or contractor.
externalUserState	String	Indicates the status of the invited user's account, for example, pending acceptance.
externalUserStateChangeDateTime	Datetime	The last timestamp when the external user state was updated.
faxNumber	String	The fax number associated with the user.
givenName	String	The user's first name or given name.
hireDate	Datetime	The date the user was hired by the organization.
identities	String	List of identity options (for example, email or username) the user can use to sign in.
imAddresses	String	The user's instant messaging (IM) or Voice over Internet Protocol (VoIP) addresses.
interests	String	A list of topics or areas of interest specified by the user.
isResourceAccount	Bool	Indicates whether this account is used as a resource account; reserved for future use.
jobTitle	String	The user's official job title or role in the organization.
lastPasswordChangeDateTime	Datetime	The most recent date and time the user's password was changed or set.
legalAgeGroupClassification	String	Defines the user's age group classification for compliance or legal purposes.
licenseAssignmentStates	String	Details of the state of license assignments for the user.
mail	String	The user's primary email address used for communication.
mailboxSettings_archiveFolder	String	The default folder used for archiving mail items.
mailboxSettings_automaticRepliesSetting_externalAudience	String	Specifies the audience for automatic reply messages sent externally.
mailboxSettings_automaticRepliesSetting_externalReplyMessage	String	The custom message sent as an automatic reply to external senders.
mailboxSettings_automaticRepliesSetting_internalReplyMessage	String	The custom message sent as an automatic reply to internal senders.
mailboxSettings_automaticRepliesSetting_scheduledEndDateTime_dateTime	String	The scheduled end date and time for automatic replies.
mailboxSettings_automaticRepliesSetting_scheduledEndDateTime_timeZone	String	The time zone for the scheduled end of automatic replies.
mailboxSettings_automaticRepliesSetting_status	String	The current status of the automatic replies setting.
mailboxSettings_dateFormat	String	The date format preference for the user's mailbox.
mailboxSettings_delegateMeetingMessageDeliveryOptions	String	Options for delivery of delegate meeting messages.
mailboxSettings_language_displayName	String	The display name for the user's preferred mailbox language.
mailboxSettings_language_locale	String	The locale setting for the user's mailbox language.
mailboxSettings_timeFormat	String	The preferred time format for the user's mailbox.
mailboxSettings_timeZone	String	The time zone associated with the user's mailbox.
mailboxSettings_userPurpose	String	The intended purpose of the user's mailbox.
mailboxSettings_workingHours_daysOfWeek	String	The days of the week specified as the user's working hours.
mailboxSettings_workingHours_endTime	Time	The end time for the user's working hours on a typical day.
mailboxSettings_workingHours_startTime	Time	The start time for the user's working hours on a typical day.
mailboxSettings_workingHours_timeZone_name	String	The name of the time zone for the user's working hours.
mailNickname	String	The email alias or nickname assigned to the user.
mobilePhone	String	The user's primary mobile phone number.
mySite	String	The URL to the user's personal site or workspace.
officeLocation	String	The physical office location associated with the user.
onPremisesDistinguishedName	String	The distinguished name (DN) of the user from the on-premises Active Directory.
onPremisesDomainName	String	The domain name synchronized from the on-premises directory.
onPremisesExtensionAttributes_extensionAttribute1	String	A custom extension attribute synchronized from the on-premises directory.
onPremisesExtensionAttributes_extensionAttribute10	String	Custom extension attribute 10 synchronized from the on-premises directory.
onPremisesExtensionAttributes_extensionAttribute11	String	Custom extension attribute 11 synchronized from the on-premises directory.
onPremisesExtensionAttributes_extensionAttribute12	String	Custom extension attribute 12 synchronized from the on-premises directory.
onPremisesExtensionAttributes_extensionAttribute13	String	Custom extension attribute 13 synchronized from the on-premises directory.
onPremisesExtensionAttributes_extensionAttribute14	String	Custom extension attribute 14 synchronized from the on-premises directory.
onPremisesExtensionAttributes_extensionAttribute15	String	Custom extension attribute 15 synchronized from the on-premises directory.
onPremisesExtensionAttributes_extensionAttribute2	String	Custom extension attribute 2 synchronized from the on-premises directory.
onPremisesExtensionAttributes_extensionAttribute3	String	Custom extension attribute 3 synchronized from the on-premises directory.
onPremisesExtensionAttributes_extensionAttribute4	String	Custom extension attribute 4 synchronized from the on-premises directory.
onPremisesExtensionAttributes_extensionAttribute5	String	Custom extension attribute 5 synchronized from the on-premises directory.
onPremisesExtensionAttributes_extensionAttribute6	String	Custom extension attribute 6 synchronized from the on-premises directory.
onPremisesExtensionAttributes_extensionAttribute7	String	Custom extension attribute 7 synchronized from the on-premises directory.
onPremisesExtensionAttributes_extensionAttribute8	String	Custom extension attribute 8 synchronized from the on-premises directory.
onPremisesExtensionAttributes_extensionAttribute9	String	Custom extension attribute 9 synchronized from the on-premises directory.
onPremisesImmutableId	String	An identifier used to associate the on-premises directory user with their cloud account.
onPremisesLastSyncDateTime	Datetime	The last date and time the user account was synchronized with the on-premises directory.
onPremisesProvisioningErrors	String	A record of errors encountered during on-premises synchronization.
onPremisesSamAccountName	String	The SAM account name synchronized from the on-premises directory.
onPremisesSecurityIdentifier	String	The security identifier (SID) for the user synchronized from on-premises.
onPremisesSyncEnabled	Bool	Indicates whether the user account is currently being synchronized with an on-premises directory.
onPremisesUserPrincipalName	String	The userPrincipalName synchronized from the on-premises directory.
otherMails	String	A list of alternate email addresses associated with the user.
passwordPolicies	String	Defines the password policies applied to the user, such as expiration rules.
passwordProfile_forceChangePasswordNextSignIn	Bool	Indicates whether the user must change their password at the next sign-in.
passwordProfile_forceChangePasswordNextSignInWithMfa	Bool	Indicates whether the user must change their password at the next sign-in with multi-factor authentication.
passwordProfile_password	String	The user's password details stored in the password profile.
pastProjects	String	A list of past projects the user has worked on.
postalCode	String	The postal code for the user's mailing address.
preferredDataLocation	String	The preferred geographic location for the user's data.
preferredLanguage	String	The user's preferred language for communication and system settings.
preferredName	String	The name the user prefers to be addressed by.
provisionedPlans	String	The plans that have been provisioned and activated for the user.
proxyAddresses	String	A list of email addresses and aliases associated with the user.
responsibilities	String	A list of tasks or duties assigned to the user.
schools	String	A list of schools or educational institutions attended by the user.
securityIdentifier	String	The unique security identifier (SID) assigned to the user.
serviceProvisioningErrors	String	Details of any service-specific errors encountered during provisioning.
showInAddressList	Bool	Specifies whether the user appears in the organization's address list.
signInActivity_lastNonInteractiveSignInDateTime	Datetime	The timestamp of the user's most recent non-interactive sign-in.
signInActivity_lastNonInteractiveSignInRequestId	String	The ID of the request for the last non-interactive sign-in.
signInActivity_lastSignInDateTime	Datetime	The timestamp of the user's most recent interactive sign-in.
signInActivity_lastSignInRequestId	String	The ID of the request for the last interactive sign-in.
signInSessionsValidFromDateTime	Datetime	Indicates that all tokens issued before this time are invalid.
skills	String	A list of skills or expertise provided by the user.
state	String	The state or province of the user's address.
streetAddress	String	The street address of the user's location.
surname	String	The user's last name or family name.
usageLocation	String	The two-letter country code indicating the user's location, often required for licensing.
userPrincipalName	String	The user's principal name used for sign-in (for example, email address).
userType	String	A classification of the user type, such as member or guest.
authentication_id	String	The unique identifier for the user's authentication details.
calendar_id	String	The identifier for the user's calendar.
cloudClipboard_id	String	The identifier for the user's cloud clipboard service.
drive_id	String	The identifier for the user's OneDrive storage.
employeeExperience_id	String	The identifier for the user's employee experience profile.
inferenceClassification_id	String	The identifier for the classification used for managing the relevance of the user's email messages.
insights_id	String	The identifier for the relationships between the user and other items.
manager_id	String	The identifier for the user's manager in the directory.
onenote_id	String	The identifier for the user's OneNote notebook.
outlook_id	String	The identifier for the user's Outlook profile.
photo_id	String	The identifier for the user's profile photo.
planner_id	String	The identifier for the user's Microsoft Planner.
presence_id	String	The identifier representing the user's presence status.
settings_id	String	The identifier for the user's settings profile.
teamwork_id	String	The identifier for the user's collaboration profile.
todo_id	String	The identifier for the user's Microsoft To-Do service.

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

Azure Authentication

---

Property	Description
AzureTenant	Identifies the Microsoft Planner 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
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
Scope	Specifies whether to enable admin consent scopes or default scopes for obtaining access and refresh tokens during authentication.
IncludeLabels	Specifies whether the labels associated with tasks in the Tasks table are included in the data retrieved from Microsoft Planner.
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.
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.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

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

Specifies the type of authentication to use when connecting to Microsoft Planner. 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.

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

Identifies the Microsoft Planner 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.

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.

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

---

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

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

Remarks

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

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

Remarks

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

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

Remarks

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

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

---

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

The JWT Certificate store.

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform-dependent.

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

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

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

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

The type of key store containing the JWT Certificate.

Remarks

This property can take one of the following values:

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

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

Remarks

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

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

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

---

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

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

Remarks

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

This property can take the following forms:

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

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

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

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

---

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

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

Remarks

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

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

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

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

Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to Microsoft Planner. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to Microsoft Planner. 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 Planner. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

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

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

Remarks

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

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

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

Remarks

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

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

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

Remarks

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

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

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

Remarks

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

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

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

---

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

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

Remarks

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

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

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

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

Remarks

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

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

Remarks

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

For other proxy types, see FirewallType.

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

Remarks

The authentication type can be one of the following:

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

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

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

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

Remarks

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

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

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

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

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

Remarks

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

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

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

For SOCKS 5 authentication or tunneling, see FirewallType.

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

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

Remarks

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

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

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

Remarks

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

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

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

---

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

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

Remarks

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

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

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

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

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

---

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

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\\MicrosoftPlanner Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:

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

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

Remarks

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

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

Remarks

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

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

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

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

Remarks

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

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

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

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

---

Property	Description
Scope	Specifies whether to enable admin consent scopes or default scopes for obtaining access and refresh tokens during authentication.
IncludeLabels	Specifies whether the labels associated with tasks in the Tasks table are included in the data retrieved from Microsoft Planner.
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.
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.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Specifies whether to enable admin consent scopes or default scopes for obtaining access and refresh tokens during authentication.

Remarks

Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.

When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested. When InitiateOAuth is set to either REFRESH or OFF, you can use either this property or the Scope input to change which scopes are requested.

This property controls the type of scopes used for authentication.

• AdminConsent: Enables admin consent scopes, which provide elevated permissions and require administrator approval. Use this setting when your application needs elevated permissions for advanced operations.
• NoAdminConsent: Uses default scopes that do not require admin consent. This setting is suitable for standard use cases with minimal permissions.

Alternatively, you can specify a custom space-delimited list of scopes to define specific permissions required by your application. This allows greater flexibility in tailoring the authentication process to your needs.

Specifies whether the labels associated with tasks in the Tasks table are included in the data retrieved from Microsoft Planner.

Remarks

Task labels provide additional metadata or categorization for tasks and can be useful for organizing or filtering tasks based on custom-defined tags. Set this property to true to retrieve labels associated with each task. By default, labels are not included, which may improve performance by reducing the amount of data retrieved.

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

Remarks

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

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

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

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

Remarks

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

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

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

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

Specifies the 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: "*=*"

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.

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