CData Sync App は、Microsoft Planner データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Microsoft Planner コネクタはCData Sync アプリケーションから使用可能で、Microsoft Planner からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App はMSPlanner API を使用してMSPlanner への双方向アクセスを実現します。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
Note:Microsoft はAzure AD をEntra ID にリブランドしました。ユーザーがEntra ID 管理サイトを操作する必要があるトピックでは、Microsoft が使用している名称と同じものを使用します。ただし、名前または値が"Azure AD" を参照しているCData 接続プロパティは、依然として存在します。
Microsoft Entra ID は、マルチテナント型のクラウドベースのID およびアクセス管理プラットフォームです。 OAuth ベースの認証フローに対応しており、ドライバーによるMicrosoft Planner エンドポイントへのセキュアなアクセスを実現します。
Web アプリケーションを介したEntra ID への認証には、必ずはじめにカスタムOAuth アプリケーションを作成して登録する必要があります。 これにより、アプリケーションは独自のリダイレクトURI を定義し、クレデンシャルのスコープを管理し、組織固有のセキュリティポリシーに準拠することができるようになります。
カスタムOAuth アプリケーションの作成および登録方法の詳細については、Entra ID(Azure AD)アプリケーションの作成 を参照してください。
AuthScheme をAzureAD に設定した後の認証手順は、環境によって異なります。 デスクトップアプリケーション、Web ベースのワークフロー、またはヘッドレスシステムから接続する方法の詳細については、以下のセクションを参照してください。
Azure サービスプリンシパルとしての認証は、OAuth クライアントクレデンシャルフローを介して処理されます。直接のユーザー認証は行われません。代わりに、クレデンシャルはアプリケーション自体のためだけに作成されます。アプリケーションで実行されるすべてのタスクは、デフォルトユーザーコンテキストなしで実行されます。リソースへのアプリケーションのアクセスは、割り当てられたロールの権限によって制御されます。
AzureAD アプリとAzure サービスプリンシパルの作成
Azure サービスプリンシパルを使用して認証する場合、Azure AD テナントにAzure AD アプリケーションを作成して登録する必要があります。詳しくは、Entra ID(Azure AD)アプリケーションの作成 を参照してください。
portal.azure.com の[アプリの登録]で[API のアクセス許可]に移動し、Microsoft Graph アクセス許可を選択します。アクセス許可には2つの異なるアクセス許可セットがあります。委任されたアクセス許可とアプリケーションの許可です。クライアントの資格情報認証時に使用されるアクセス許可は、[アプリケーションの許可]の下にあります。
アプリケーションへのロールの割り当て
サブスクリプションのリソースにアクセスするには、アプリケーションにロールを割り当てる必要があります。
クライアントシークレット
次の接続プロパティを設定します。
証明書
次の接続プロパティを設定します。
これで接続する準備が整いました。クライアント資格情報での認証は、他の接続同様に自動的に行われますが、ユーザーにプロンプトするウィンドウは表示されません。ユーザーコンテキストがないため、ブラウザのポップアップは必要ないからです。接続が行われ、内部的に処理されます。
Azure VM 上でMicrosoft Planner を実行しており、マネージドID(MSI)認証情報を自動的に取得して接続したい場合は、AuthScheme を AzureMSI に設定します。
VM に複数のユーザーが割り当てられたマネージドID がある場合は、OAuthClientId も指定する必要があります。
このセクションでは、Microsoft Planner Sync App の高度な機能を厳選して説明します。
Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
詳しくは、クエリ処理 を参照してください。
デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
Sync App はtasks、plans、およびbuckets などのMicrosoft Planner データをリレーショナルテーブルとしてモデル化し、SQL を記述してMicrosoft Planner データをクエリおよび変更できるようにします。これらのオブジェクトへのライブ接続により、Microsoft Planner アカウントへのあらゆる変更はSync App によって公開される接続に即座に反映されます。
テーブル セクションには標準SQL テーブルの詳細が、ビュー セクションには読み取り専用SQL テーブルの一覧が記載されています。これらには、Microsoft Planner アカウントでのアクセスを想定したサンプルが含まれています。
以下のテーブルおよびビューはSync App に同梱されています。
| テーブル | 説明 |
| 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.
Sync App はMicrosoft Planner のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| 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. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| 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. |
ストアドプロシージャはファンクションライクなインターフェースで、Microsoft Planner の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずSync App の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにMicrosoft Planner から関連するレスポンスデータを返します。
| 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.
使用できる値は次のとおりです。APP, WEB デフォルト値は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. |
| プロパティ | 説明 |
| AuthScheme | Microsoft Planner に接続する際に使用する認証の種類を指定します。このプロパティが空白の場合は、デフォルトの認証が使用されます。 |
| プロパティ | 説明 |
| AzureTenant | データにアクセスするために使用されているMicrosoft Planner テナントを識別します。テナントのドメイン名(例: contoso.onmicrosoft.com )またはディレクトリ(テナント)ID のいずれかを受け付けます。 |
| AzureEnvironment | 接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。 |
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ) |
| プロパティ | 説明 |
| OAuthJWTCert | クライアント証明書のJWT 証明書ストアの名前を指定します。 |
| OAuthJWTCertType | JWT 証明書を格納しているキーストアの種類を指定します。 |
| OAuthJWTCertPassword | パスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。 |
| OAuthJWTCertSubject | ストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。 |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。 |
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| 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 | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| Other | 特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
| UserId | Specify a default UserId. |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| AuthScheme | Microsoft Planner に接続する際に使用する認証の種類を指定します。このプロパティが空白の場合は、デフォルトの認証が使用されます。 |
Microsoft Planner に接続する際に使用する認証の種類を指定します。このプロパティが空白の場合は、デフォルトの認証が使用されます。
AuthScheme には以下が含まれます。
Azure AD で認証するためのカスタムアプリケーションの作成方法については、Entra ID(Azure AD)アプリケーションの作成 を参照してください。
Azure AD サービスプリンシパルで認証するためのカスタムアプリケーションの作成方法については、Entra ID(Azure AD)でのサービスプリンシパルアプリの作成 を参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なAzure Authentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| AzureTenant | データにアクセスするために使用されているMicrosoft Planner テナントを識別します。テナントのドメイン名(例: contoso.onmicrosoft.com )またはディレクトリ(テナント)ID のいずれかを受け付けます。 |
| AzureEnvironment | 接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。 |
データにアクセスするために使用されているMicrosoft Planner テナントを識別します。テナントのドメイン名(例: contoso.onmicrosoft.com )またはディレクトリ(テナント)ID のいずれかを受け付けます。
テナントとは、Microsoft Entra ID(旧称:Azure AD)を通じて管理される、組織のユーザーやリソースのためのデジタルコンテナです。 各テナントには一意のディレクトリID が関連付けられており、多くの場合、カスタムドメイン(例:microsoft.com やcontoso.onmicrosoft.com)も関連付けられています。
Microsoft Entra 管理センターでディレクトリ(テナント)ID を確認するには、Microsoft Entra ID -> プロパティに移動し、「ディレクトリ(テナント)ID」と表示されている値をコピーします。
このプロパティは以下の場合に必要です。
テナントの値は、2つの形式のいずれかで指定できます。
テナントを明示的に指定することで、認証リクエストが正しいディレクトリにルーティングされるようになります。これは、ユーザーが複数のテナントに所属している場合や、サービスプリンシパルベースの認証を使用する場合に特に重要です。
この値が必要な場面で省略されると、認証に失敗したり、誤ったテナントに接続されたりする可能性があります。その結果、認可されていないまたはリソースが見つからないといったエラーが発生する可能性があります。
接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。
Azure アカウントがGlobal ネットワークとは異なるネットワーク(China、USGOVT、USGOVTDOD など)の一部である場合は、必要です。
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ) |
カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
このプロパティは2つのケースで必要となります:
(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにSync App によって設定されており、手動で入力する必要がないことがあります。)
OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。
クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。
クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。
Notes:
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なJWT OAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthJWTCert | クライアント証明書のJWT 証明書ストアの名前を指定します。 |
| OAuthJWTCertType | JWT 証明書を格納しているキーストアの種類を指定します。 |
| OAuthJWTCertPassword | パスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。 |
| OAuthJWTCertSubject | ストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。 |
クライアント証明書のJWT 証明書ストアの名前を指定します。
OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword を使用してパスワードを指定します。
OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値が設定され、かつOAuthJWTCertSubject が設定されている場合、CData Sync App は証明書の検索を開始します。 詳しくは、OAuthJWTCertSubject を参照してください。
証明書ストアの指定はプラットフォームに依存します。
注記
JWT 証明書を格納しているキーストアの種類を指定します。
| 値 | 説明 | 注記 |
| USER | 現在のユーザーが所有する証明書ストア。 | Windows のみ使用可能です。 |
| MACHINE | マシンストア。 | Java やその他の非Windows 環境では使用できません。 |
| PFXFILE | 証明書を含むPFX(PKCS12)ファイル。 | |
| PFXBLOB | PFX(PKCS12)形式の証明書ストアをbase-64 でエンコードした文字列。 | |
| JKSFILE | 証明書を含むJava キーストア(JKS)ファイル。 | Java 専用。 |
| JKSBLOB | Java キーストア(JKS)形式の証明書ストアをbase-64 でエンコードした文字列。 | Java 専用。 |
| PEMKEY_FILE | 秘密鍵とオプションの証明書を含むPEM でエンコードされたファイル。 | |
| PEMKEY_BLOB | 秘密鍵とオプションの証明書をbase-64 でエンコードした文字列。 | |
| PUBLIC_KEY_FILE | PEM またはDER でエンコードされた公開鍵証明書を含むファイル。 | |
| PUBLIC_KEY_BLOB | PEM またはDER でエンコードされた公開鍵証明書をbase-64 でエンコードした文字列。 | |
| SSHPUBLIC_KEY_FILE | SSH 形式の公開鍵を含むファイル。 | |
| SSHPUBLIC_KEY_BLOB | SSH 形式の公開鍵ををbase-64 でエンコードした文字列。 | |
| P7BFILE | 証明書を含むPKCS7 ファイル。 | |
| PPKFILE | PuTTY 秘密キー(PPK)を含むファイル。 | |
| XMLFILE | XML 形式の証明書を含むファイル。 | |
| XMLBLOB | XML 形式の証明書を含む文字列。 | |
| BCFKSFILE | Bouncy Castle キーストアを含むファイル。 | |
| BCFKSBLOB | Bouncy Castle キーストアを含む文字列(base-64エンコード)。 |
パスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
このプロパティは、パスワードで保護された証明書ストアを開くために必要なパスワードを指定します。 パスワードが必要かどうかを判断するには、ご利用の証明書ストアのドキュメントまたは設定を参照してください。
ストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。
このプロパティの値は、ストアで一致する証明書を検索するために使用されます。検索プロセスは以下のように動作します。
値を '*' に設定すると、ストアの先頭の証明書が自動的に選択されます。 証明書のサブジェクトは識別名フィールドおよび値のカンマ区切りのリストです。 例:CN=www.server.com, OU=test, C=US, [email protected]。
一般的なフィールドには以下のものが含まれます。
| フィールド | 説明 |
| CN | 共通名。一般的には、www.server.com のようなホスト名です。 |
| O | 法人名 |
| OU | 法人の部署名 |
| L | 法人の住所(市町村名) |
| S | 法人の住所(都道府県) |
| C | 国名 |
| E | E メールアドレス |
フィールド値にカンマが含まれる場合は、引用符で囲んでください。例:"O=ACME, Inc."。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
TLS/SSL 接続を使用している場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。このプロパティに値を指定すると、マシンによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
| 説明 | 例 |
| フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| 証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
| 公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| MD5 Thumbprint(hex 値はスペースまたはコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
| SHA1 Thumbprint(hex 値はスペースまたはコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
Note:デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。
次の表は、サポートされている各プロトコルのポート番号情報です。
| プロトコル | デフォルトポート | 説明 |
| TUNNEL | 80 | Sync App がMicrosoft Planner への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。 |
| SOCKS4 | 1080 | Sync App がMicrosoft Planner への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | Sync App がMicrosoft Planner にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで使用するTCP ポートを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。 |
provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。
この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を構成する場合は、ProxyAutoDetect をFalse に設定します。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。
ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。
クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたProxyServer ポートを通じてのみHTTP トラフィックをルーティングします。
ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。
その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
サポートされる認証の種類:
NONE 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyUser に設定する値 |
| BASIC | プロキシサーバーに登録されているユーザーのユーザー名。 |
| DIGEST | プロキシサーバーに登録されているユーザーのユーザー名。 |
| NEGOTIATE | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NTLM | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
Note:Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。 ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。
ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyPassword に設定する値 |
| BASIC | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| DIGEST | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| NEGOTIATE | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NTLM | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
Note:Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。 ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。
ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。
| AUTO | デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。 |
| ALWAYS | 接続は、常にSSL 有効となります。 |
| NEVER | 接続は、SSL 有効になりません。 |
| TUNNEL | 接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Note:Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。 この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。
Sync App は、実行する各操作の詳細を Logfile 接続プロパティで指定されたログファイルに書き込みます。
ログに記録される各操作は、モジュールと呼ばれるカテゴリに分類されます。各モジュールには対応する短いコードがあり、個々の Sync App の操作がどのモジュールに属するかを示すラベルとして使用されます。
この接続プロパティにモジュールコードをセミコロン区切りのリストで設定すると、指定したモジュールに属する操作のみがログファイルに書き込まれます。この設定は今後のログ記録にのみ適用され、既存のログファイルの内容には影響しません。例: INFO;EXEC;SSL;META;
デフォルトでは、すべてのモジュールの操作がログに含まれます。
モジュールを明示的に除外するには、先頭に「-」を付けます。例: -HTTP
サブモジュールにフィルターを適用するには、<モジュール名>.<サブモジュール名> の構文で指定します。たとえば、次の値を設定すると、Sync App は HTTP モジュールに属するアクションのみをログに記録し、さらに HTTP モジュールの Res サブモジュールに属するアクションを除外します: HTTP;-HTTP.Res
Verbosity 接続プロパティによるログファイルのフィルタリングは、この接続プロパティによるフィルタリングよりも優先されます。そのため、Verbosity 接続プロパティで指定したレベルよりも高い詳細レベルの操作は、この接続プロパティで指定したモジュールに属していても、ログファイルには出力されません。
使用可能なモジュールとサブモジュールは次のとおりです。
| モジュール名 | モジュールの説明 | サブモジュール |
| INFO | 一般情報。接続文字列、製品バージョン(ビルド番号)、および初期接続メッセージが含まれます。 |
|
| EXEC | クエリ実行。ユーザーが記述した SQL クエリ、解析済み SQL クエリ、正規化済み SQL クエリの実行メッセージが含まれます。クエリおよびクエリページの成功/失敗メッセージもここに表示されます。 |
|
| HTTP | HTTP プロトコルメッセージ。HTTP リクエスト/レスポンス(POST メッセージを含む)、および Kerberos 関連のメッセージが含まれます。 |
|
| WSDL | WSDL/XSD ファイルの生成に関するメッセージ。 | — |
| SSL | SSL 証明書メッセージ。 |
|
| AUTH | 認証関連の失敗/成功メッセージ。 |
|
| SQL | SQL トランザクション、SQL 一括転送メッセージ、および SQL 結果セットメッセージが含まれます。 |
|
| META | メタデータキャッシュとスキーマメッセージ。 |
|
| FUNC | SQL 関数の実行に関連する情報。 |
|
| TCP | TCP トランスポートレイヤーメッセージでの送受信生バイト。 |
|
| FTP | File Transfer Protocol に関するメッセージ。 |
|
| SFTP | Secure File Transfer Protocol に関するメッセージ。 |
|
| POP | Post Office Protocol 経由で転送されるデータに関するメッセージ。 |
|
| SMTP | Simple Mail Transfer Protocol 経由で転送されるデータに関するメッセージ。 |
|
| CORE | 他のモジュールでカバーされていない、さまざまな製品内部操作に関連するメッセージ。 | — |
| DEMN | SQL リモーティングに関連するメッセージ。 | — |
| CLJB | 一括データアップロード(クラウドジョブ)に関するメッセージ。 |
|
| SRCE | 他のモジュールに属さない、製品が生成するその他のメッセージ。 | — |
| TRANCE | 低レベルの製品操作に関する高度なメッセージ。 | — |
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は%APPDATA%\\CData\\MicrosoftPlanner Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます:
| プラットフォーム | %APPDATA% |
| Windows | APPDATA 環境変数の値 |
| Linux | ~/.config |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。
レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| 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 | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| Other | 特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
| UserId | Specify a default UserId. |
Specifies whether to enable admin consent scopes or default scopes for obtaining access and refresh tokens during authentication.
スコープは、認証ユーザーがどのようなアクセス権を持つかを定義するために設定されます。例えば、読み取り、読み取りと書き込み、機密情報への制限付きアクセスなどです。システム管理者は、スコープを使用して機能またはセキュリティクリアランスによるアクセスを選択的に有効化できます。
InitiateOAuth がGETANDREFRESH に設定されている場合、要求するスコープを変更したい場合はこのプロパティを使用する必要があります。
InitiateOAuth がREFRESH またはOFF のいずれかに設定されている場合、このプロパティまたはScope 入力を使用して、要求するスコープを変更できます。
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.
集計やGROUP BY を含まないクエリで返される最大行数を指定します。
このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)
MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。
特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
このプロパティにより、シニアユーザーはサポートチームのアドバイスに基づいて、特定の状況に対応する隠しプロパティを設定できます。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Note:特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。
| プロパティ | 説明 |
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT=True | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換します。デフォルト値はFalse(ローカルタイムを使用)です。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。
Table1=Column1;Table1=Column2;Table2=Column3
すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:
*=*
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。
タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。
Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
UserDefinedViews を使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。
次に例を示します。
{
"MyView": {
"query": "SELECT * FROM Tasks WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。
次に例を示します。
UserDefinedViews=C:\Path\To\UserDefinedViews.jsonUserDefinedViews でビューを指定すると、Sync App はそのビューだけを参照します。
詳しくは、ユーザー定義ビュー を参照してください。
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.