The CData Sync App provides a straightforward way to continuously pipeline your Microsoft Planner data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Microsoft Planner connector can be used from the CData Sync application to pull data from Microsoft Planner and move it to any of the supported destinations.
The Sync App leverages the MSPlanner API to enable bidirectional access to MSPlanner.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
Note: Microsoft has rebranded Azure AD as Entra ID. In topics that require the user to interact with the Entra ID Admin site, we use the same names Microsoft does. However, there are still CData connection properties whose names or values reference "Azure AD".
Microsoft Entra ID is a multi-tenant, cloud-based identity and access management platform. It supports OAuth-based authentication flows that enable the driver to access Microsoft Planner endpoints securely.
Authentication to Entra ID via a web application always requires that you first create and register a custom OAuth application. This enables your application to define its own redirect URI, manage credential scope, and comply with organization-specific security policies.
For full instructions on how to create and register a custom OAuth application, see Creating an Entra ID (Azure AD) Application.
After setting AuthScheme to AzureAD, the steps to authenticate vary, depending on the environment. For details on how to connect from desktop applications, web-based workflows, or headless systems, see the following sections.
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 application 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 Entra ID (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.
Client Secret
Set these connection properties:
Certificate
Set these connection properties:
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.
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.
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.
The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
For further information, see Query Processing.
By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
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.
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. |
The Microsoft Planner API supports several ways of accessing most entities. For example, you can fetch Tasks entries in these ways:
Each of these options retrieves a different collection of tasks and has different performance characteristics. For example, SELECT * FROM Tasks WHERE BucketId IN (SELECT BucketId FROM Buckets) fetches tasks using buckets, which requires fetching plans (buckets belong to plans), which requires fetching groups. On the other hand, SELECT * FROM Tasks WHERE UserId IN (SELECT UserId FROM Users) requests the tasks assigned to each individual user. Which one is faster depends upon how many users you have versus how complex your group and plan structure is.
If you do not get the data or performance you expect, review the table definitions to ensure you are using the right relationships to read data.
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.
| 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.
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.
For example, the following queries are processed server side:
SELECT * FROM Buckets WHERE PlanId = 'nETc1IDpYk3r3e317w8TxGmUAGFWC' SELECT * FROM Buckets WHERE BucketId = 'qIguxctMLEGHYhmgSVGSNGUAAZOZ'
If no filter is provided, the Sync App queries Plans and reads the buckets for each plan.
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', ' !')
Microsoft Planner allows updates for the name and orderHint columns.
UPDATE Buckets SET Name = 'To do', orderHint = ' !' WHERE BucketId = 'rWpNKGmHukm84GaiDF_ZL2UAOlMj'
Buckets can be deleted by providing BucketId.
DELETE FROM Buckets WHERE BucketId = 'yHiJQjZK0kGVt4flhItk0mUANJwN'
| 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.
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.
For example, the following queries are processed server side:
SELECT * FROM PlanDetails WHERE planId = 'nETc1IDpYkmb1E17w8TxGmUAGFWC'
If no filter is provided, the Sync App queries Plans and reads the details for each plan.
INSERT is not supported for this table.
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 is not supported for this table.
| 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.
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.
For example, the following query is processed server side:
SELECT * FROM Plans WHERE PlanId = 'nETc1IDpYk3r3e317w8TxGmUAGFWC'
If no filter is provided, the Sync App queries Groups and reads the plans for each group.
Required fields for an insert are: title and owner.
INSERT INTO Plans (title, owner) VALUES ('Plan#5', 'acc24236-0d62-4d30-9a7f-98cfbcd3a6e7')
Microsoft Planner allows updates for the title and owner columns.
UPDATE Plans SET title = 'Plan#1' WHERE PlanId = 'nETc1IDpYkmb1E17c4TxGmUAGFWC'
| 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.
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.
For example, the following queries are processed server side:
SELECT * FROM TaskDetails WHERE TaskId = '7POTl5DUfkOsgzptPrzdzGUAHy1z'
If no filter is provided, the Sync App queries Tasks and reads the details for each task.
INSERT is not supported for this table.
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 is not supported for this table.
| 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.
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.
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'
If no filter is provided, the Sync App behaves differently based on AuthScheme. Authenticating as a user reads the user's assigned tasks. When authenticating as a service principal, the Sync App instead queries Users and reads tasks assigned to every user.
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')
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'
Tasks can be deleted by providing TaskId.
DELETE FROM Tasks WHERE TaskId = 'BCrvyMoiLEafem-3RxIESmUAHbLK'
| 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.
| Name | Description |
| GroupMembers | Provides a detailed view of group memberships, listing all members of each group within the organization. |
| 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. |
Provides a detailed view of group memberships, listing all members of each group within the organization.
Query the GroupMembers table by retrieving everything from MS Planner or by specifying the GroupId with = and IN operators. You can filter results by GroupId and MemberId.
For example, the following queries are processed server side:
SELECT * FROM GroupMembers WHERE GroupId IN ('4729c5e5-f923-4435-8a41-44423d42ea79', 'acabe397-8370-4c31-aeb7-2d7ae6b8cda1')
SELECT * FROM GroupMembers WHERE GroupId = '4729c5e5-f923-4435-8a41-44423d42ea79'
| Name | Type | Description |
| GroupId [KEY] | String | The unique identifier of the group, representing a specific collection of users or entities in Azure Active Directory. |
| MemberId [KEY] | String | The unique identifier of a user or entity that belongs to the specified group in Azure Active Directory. |
Represents the groups created automatically when a new plan is initiated, serving as the foundational organizational unit for tasks and plans.
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.
For example, the following query is processed server-side:
SELECT * FROM Groups WHERE Id = 'nETc1IDpYkmb1E17w8TxGmUAGFWC'
| 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. |
| 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.
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.
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'
If no filter is provided, the Sync App behaves differently based on AuthScheme. Authenticating as a user reads the assignments for the user's assigned tasks. When authenticating as a service principal, the Sync App instead queries Tasks and reads the assignments for each task.
| 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.
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.
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'
If no filter is provided, the Sync App queries Tasks and reads the comments for each task.
| 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.
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.
For example, the following query is processed server-side:
SELECT * FROM Users WHERE UserId = '9523f1-aa0-4fe17-a9w7b-6860618adf'
| 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. |
| 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. |
Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT/UPDATE/DELETE operations with Microsoft Planner.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Microsoft Planner, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
| GetAdminConsentURL | Generates the URL required for an admin to grant your application access to an organization's domain. Necessary for custom OAuth configurations. |
| UpdateAssignedToTaskBoardTaskFormat | Formats and displays tasks in the 'Assigned To' view of the Task Board, organizing them by the users responsible for each task. |
| UpdateBucketTaskBoardFormat | Formats and displays tasks in the 'Buckets' view of the Task Board, showing tasks grouped by their designated bucket categories. |
| UpdateProgressTaskBoardFormat | Formats and displays tasks in the 'Progress' view of the Task Board, arranging them by their completion status (for example, Not Started, In Progress, Complete). |
Generates the URL required for an admin to grant your application access to an organization's domain. Necessary for custom OAuth configurations.
| Name | Type | Required | Description |
| CallbackUrl | String | False | The redirect URL to which Microsoft Entra (formerly Azure AD) will send the user after they authorize your application. Ensure this matches the Reply URL specified in your Azure AD app settings to avoid authorization errors. |
| State | String | False | A unique string used to maintain state between the authorization request and callback. This is typically used for mitigating cross-site request forgery (CSRF) attacks. |
| Scope | String | False | A list of space-separated permissions requested by the application. The default permissions include 'offline_access' for refresh tokens and specific Microsoft Graph API permissions for group and user data. |
| Name | Type | Description |
| URL | String | The generated authorization URL to be entered into a web browser, allowing the admin to grant consent and authorize your application. |
Fetches the OAuth Access Token, which is used to authenticate and authorize API calls made to Microsoft Planner.
| Name | Type | Required | Description |
| AuthMode | String | False | Specifies the authentication mode to use for obtaining the access token. Use 'App' for scenarios involving desktop applications and 'Web' for web-based applications, ensuring proper alignment with the application type.
The allowed values are APP, WEB. The default value is APP. |
| Scope | String | False | Defines a space-separated list of permissions the application is requesting from the user. For 'OAuthGrantType=CODE', the default scope includes 'offline_access https://graph.microsoft.com/User.ReadBasic.All', granting basic user profile access and offline refresh capabilities. For 'OAuthGrantType=CLIENT', the scope defaults to 'https://graph.microsoft.com/.default', leveraging permissions already configured for the app in Azure AD. |
| CallbackUrl | String | False | The URL where the user will be redirected after authorizing the application. This must exactly match the 'Reply URL' configured in the Azure AD application settings to ensure a successful authentication process. |
| Verifier | String | False | The unique verifier string issued by Azure AD after the user authorizes the application. This value is returned as a parameter to the callback URL and is essential for completing the authentication workflow. |
| State | String | False | An optional arbitrary string provided by the app to maintain state between the request and callback. A successful roundtrip of this string confirms that the authentication process was initiated by your application. |
| Prompt | String | False | Controls the user interaction during authentication. Default is 'select_account', prompting the user to choose an account. Other options include 'None' for silent authentication, 'login' to force credential input, or 'consent' to display the permissions consent dialog. |
| Name | Type | Description |
| OAuthAccessToken | String | The access token issued by Azure AD, used for authenticated communication with Office 365 APIs. This token is required to perform authorized actions on behalf of the user. |
| ExpiresIn | String | The duration, in seconds, for which the access token remains valid. A value of -1 indicates that the token does not expire, although such cases are uncommon and depend on Azure AD configuration. |
| OAuthRefreshToken | String | The refresh token provided by Azure AD, allowing the application to obtain a new access token without requiring user interaction. This token is essential for maintaining long-lived sessions. |
Retrieves the OAuth Authorization URL, allowing the client to direct the user's browser to the authorization server and initiate the OAuth process.
| Name | Type | Required | Description |
| Scope | String | False | Specifies the permissions being requested from the user during the OAuth flow. For 'CODE' grant type, this typically includes permissions like 'offline_access' and 'https://graph.microsoft.com/User.ReadBasic.All' for user-related access. For 'CLIENT' grant type, the '.default' scope automatically uses the permissions pre-configured in your Azure AD app. |
| CallbackUrl | String | False | The URL to which the user will be redirected after successfully authorizing the application. Ensure this URL exactly matches one of the configured Reply URLs in the Azure AD app registration settings. |
| State | String | False | A unique value used to maintain state between the authorization request and callback. This value is typically used to prevent cross-site request forgery (CSRF) attacks and should match the state sent in the initial authorization request. |
| Prompt | String | False | Determines the type of user interaction required during the authentication process. Options include 'select_account' to prompt for account selection, 'None' to suppress prompts, 'login' to force credential entry, and 'consent' to explicitly display the permissions consent dialog. |
| Name | Type | Description |
| URL | String | The dynamically generated authorization URL that the user can navigate to in their browser. This URL initiates the OAuth flow and enables the user to grant permissions to your application. |
Refreshes an expired OAuth Access Token to maintain continuous authenticated access to Microsoft Planner resources without requiring reauthorization from the user.
| Name | Type | Required | Description |
| OAuthRefreshToken | String | True | The token used to refresh the user's access, obtained during the initial authorization process. Required for generating a new access token. |
| Name | Type | Description |
| OAuthAccessToken | String | The newly generated OAuth Access Token returned by Azure AD. Use this token to authenticate and authorize subsequent API requests to the service. |
| OAuthRefreshToken | String | A newly issued OAuth Refresh Token that can be used to request another access token when the current one expires. |
| ExpiresIn | String | The duration, in seconds, for which the access token remains valid before it expires. |
Formats and displays tasks in the 'Assigned To' view of the Task Board, organizing them by the users responsible for each task.
| Name | Type | Required | Description |
| TaskId | String | True | The unique identifier of the task being updated in the task board format. |
| UserId | String | True | The unique identifier of the user being assigned to the task. |
| OrderHint | String | True | A string used to determine the position of the task within the task board. |
Formats and displays tasks in the 'Buckets' view of the Task Board, showing tasks grouped by their designated bucket categories.
| Name | Type | Required | Description |
| TaskId | String | True | The unique identifier for the task to be updated. |
| OrderHint | String | True | A hint used to determine the task's position in the task board, typically for sorting or ordering purposes. |
Formats and displays tasks in the 'Progress' view of the Task Board, arranging them by their completion status (for example, Not Started, In Progress, Complete).
| Name | Type | Required | Description |
| TaskId | String | True | The unique identifier for the task to be updated. Typically a globally unique identifier (GUID) or primary key. |
| OrderHint | String | True | A hint indicating the order or position of the task on the task board. Used for sorting or display purposes. |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| AuthScheme | Specifies the type of authentication to use when connecting to Microsoft Planner. If this property is left blank, the default authentication is used. |
| Property | Description |
| AzureTenant | Identifies the Microsoft Planner tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID. |
| AzureEnvironment | Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added. |
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Property | Description |
| OAuthJWTCert | Supplies the name of the client certificate's JWT Certificate store. |
| OAuthJWTCertType | Identifies the type of key store containing the JWT Certificate. |
| OAuthJWTCertPassword | Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank. |
| OAuthJWTCertSubject | Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| Scope | Specifies whether to enable admin consent scopes or default scopes for obtaining access and refresh tokens during authentication. |
| DefaultGroups | Determines whether to use the /me/memberOf or /groups endpoint for user authentication. |
| DefaultUser | Determines whether to use the /me or /users endpoint for user authentication. |
| GroupId | Specify a default GroupId. |
| 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 number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
| UserId | Specify a default UserId. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| AuthScheme | Specifies the type of authentication to use when connecting to Microsoft 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.
AuthScheme values include:
For information about creating a custom application to authenticate with Azure AD, see Creating an Entra ID (Azure AD) Application.
For information about creating a custom application to authenticate with Azure AD Service Principal, see Creating a Service Principal App in Entra ID (Azure AD).
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. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID. |
| AzureEnvironment | Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added. |
Identifies the Microsoft Planner tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID.
A tenant is a digital container for your organization's users and resources, managed through Microsoft Entra ID (formerly Azure AD). Each tenant is associated with a unique directory ID, and often with a custom domain (for example, microsoft.com or contoso.onmicrosoft.com).
To find the directory (tenant) ID in the Microsoft Entra Admin Center, navigate to Microsoft Entra ID > Properties and copy the value labeled "Directory (tenant) ID".
This property is required in the following cases:
You can provide the tenant value in one of two formats:
Specifying the tenant explicitly ensures that the authentication request is routed to the correct directory, which is especially important when a user belongs to multiple tenants or when using service principal–based authentication.
If this value is omitted when required, authentication may fail or connect to the wrong tenant. This can result in errors such as unauthorized or resource not found.
Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.
Required if your Azure account is part of a different network than the Global network, such as China, USGOVT, or USGOVTDOD.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
This property is required in two cases:
(When the driver provides embedded OAuth credentials, this value may already be provided by the Sync App and thus not require manual entry.)
OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.
OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.
While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.
For more information on how this property is used when configuring a connection, see Establishing a Connection.
Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.
The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.
OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.
Notes:
For more information on how this property is used when configuring a connection, see Establishing a Connection
This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthJWTCert | Supplies the name of the client certificate's JWT Certificate store. |
| OAuthJWTCertType | Identifies the type of key store containing the JWT Certificate. |
| OAuthJWTCertPassword | Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank. |
| OAuthJWTCertSubject | Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate. |
Supplies the name of the client certificate's JWT Certificate store.
The OAuthJWTCertType field specifies the type of the certificate store specified in OAuthJWTCert. If the store is password-protected, use OAuthJWTCertPassword to supply the password..
OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, the CData Sync App initiates a search for a certificate. For further information, see OAuthJWTCertSubject.
Designations of certificate stores are platform-dependent.
Notes
Identifies the type of key store containing the JWT Certificate.
| Value | Description | Notes |
| USER | A certificate store owned by the current user. | Only available in Windows. |
| MACHINE | A machine store. | Not available in Java or other non-Windows environments. |
| PFXFILE | A PFX (PKCS12) file containing certificates. | |
| PFXBLOB | A string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. | |
| JKSFILE | A Java key store (JKS) file containing certificates. | Only available in Java. |
| JKSBLOB | A string (base-64-encoded) representing a certificate store in Java key store (JKS) format. | Only available in Java. |
| PEMKEY_FILE | A PEM-encoded file that contains a private key and an optional certificate. | |
| PEMKEY_BLOB | A string (base64-encoded) that contains a private key and an optional certificate. | |
| PUBLIC_KEY_FILE | A file that contains a PEM- or DER-encoded public key certificate. | |
| PUBLIC_KEY_BLOB | A string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. | |
| SSHPUBLIC_KEY_FILE | A file that contains an SSH-style public key. | |
| SSHPUBLIC_KEY_BLOB | A string (base-64-encoded) that contains an SSH-style public key. | |
| P7BFILE | A PKCS7 file containing certificates. | |
| PPKFILE | A file that contains a PPK (PuTTY Private Key). | |
| XMLFILE | A file that contains a certificate in XML format. | |
| XMLBLOB | Astring that contains a certificate in XML format. | |
| BCFKSFILE | A file that contains an Bouncy Castle keystore. | |
| BCFKSBLOB | A string (base-64-encoded) that contains a Bouncy Castle keystore. |
Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
This property specifies the password needed to open a password-protected certificate store. To determine if a password is necessary, refer to the documentation or configuration for your specific certificate store.
Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.
The value of this property is used to locate a matching certificate in the store. The search process works as follows:
You can set the value to '*' to automatically select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For example: CN=www.server.com, OU=test, C=US, [email protected].
Common fields include:
| Field | Meaning |
| CN | Common Name. This is commonly a host name like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, enclose it in quotes. For example: "O=ACME, Inc.".
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space- or colon-separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space- or colon-separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
The following table provides port number information for each of the supported protocols.
| Protocol | Default Port | Description |
| TUNNEL | 80 | The port where the Sync App opens a connection to Microsoft 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.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the TCP port to be used for a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Identifies the user ID of the account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the password of the user account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).
This connection property takes precedence over other proxy settings. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.
For other proxy types, see FirewallType.
Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
Supported authentication types :
For all values other than NONE, you must also set the ProxyUser and ProxyPassword connection properties.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyUser |
| BASIC | The username of a user registered with the proxy server. |
| DIGEST | The username of a user registered with the proxy server. |
| NEGOTIATE | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NTLM | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NONE | Do not set the ProxyPassword connection property. |
Note: The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the username specified in your system proxy settings.
Specifies the password of the user specified in the ProxyUser connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyPassword |
| BASIC | The password associated with the proxy server user specified in ProxyUser. |
| DIGEST | The password associated with the proxy server user specified in ProxyUser. |
| NEGOTIATE | The password associated with the Windows user account specified in ProxyUser. |
| NTLM | The password associated with the Windows user account specified in ProxyUser. |
| NONE | Do not set the ProxyPassword connection property. |
For SOCKS 5 authentication or tunneling, see FirewallType.
Note: The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the password specified in your system proxy settings.
Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :
| AUTO | Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note: The Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.
Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.
When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;
By default, logged operations from all modules are included.
You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP
To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res
Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.
The available modules and submodules are:
| Module Name | Module Description | Submodules |
| INFO | General Information. Includes the connection string, product version (build number), and initial connection messages. |
|
| EXEC | Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well. |
|
| HTTP | HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages. |
|
| WSDL | Messages pertaining to the generation of WSDL/XSD files. | — |
| SSL | SSL certificate messages. |
|
| AUTH | Authentication related failure/success messages. |
|
| SQL | Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages. |
|
| META | Metadata cache and schema messages. |
|
| FUNC | Information related to executing SQL functions. |
|
| TCP | Incoming and outgoing raw bytes on TCP transport layer messages. |
|
| FTP | Messages pertaining to the File Transfer Protocol. |
|
| SFTP | Messages pertaining to the Secure File Transfer Protocol. |
|
| POP | Messages pertaining to data transferred via the Post Office Protocol. |
|
| SMTP | Messages pertaining to data transferred via the Simple Mail Transfer Protocol. |
|
| CORE | Messages relating to various internal product operations not covered by other modules. | — |
| DEMN | Messages related to SQL remoting. | — |
| CLJB | Messages about bulk data uploads (cloud job). |
|
| SRCE | Miscellaneous messages produced by the product that don't belong in any other module. | — |
| TRANCE | Advanced messages concerning low-level product operations. | — |
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is %APPDATA%\\CData\\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 .
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.
If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.
If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| Scope | Specifies whether to enable admin consent scopes or default scopes for obtaining access and refresh tokens during authentication. |
| DefaultGroups | Determines whether to use the /me/memberOf or /groups endpoint for user authentication. |
| DefaultUser | Determines whether to use the /me or /users endpoint for user authentication. |
| GroupId | Specify a default GroupId. |
| 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 number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
| UserId | Specify a default UserId. |
Specifies whether to enable admin consent scopes or default scopes for obtaining access and refresh tokens during authentication.
Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.
When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested.
When InitiateOAuth is set to either REFRESH or OFF, you can change which scopes are requested using either this property or the Scope input.
This property controls the type of scopes used for authentication.
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.
Determines whether to use the /me/memberOf or /groups endpoint for user authentication.
Determines whether to use the /me/memberOf or /groups endpoint for user authentication.
Supported values are:
Determines whether to use the /me or /users endpoint for user authentication.
Determines whether to use the /me or /users endpoint for user authentication.
Supported values are:
Specify a default GroupId.
Specify a default GroupId.
Specifies whether the labels associated with tasks in the Tasks table are included in the data retrieved from Microsoft Planner.
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 number of rows returned for queries that do not include either aggregation or GROUP BY.
The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)
Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.
Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.
| Property | Description |
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT=True | Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time). |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
This property allows you to define which pseudocolumns the Sync App exposes as table columns.
To specify individual pseudocolumns, use the following format:
Table1=Column1;Table1=Column2;Table2=Column3
To include all pseudocolumns for all tables use:
*=*
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.
Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.
Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Tasks WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
You can use this property to define multiple views in a single file and specify the filepath.
For example:
UserDefinedViews=C:\Path\To\UserDefinedViews.jsonWhen you specify a view in UserDefinedViews, the Sync App only sees that view.
For further information, see User Defined Views.
Specify a default UserId.
Specify a default UserId.
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.