Garoon への接続を追加

Garoon への接続を追加するには：

1. アプリケーションコンソールで、接続ページに移動します。
2. 接続の追加パネルで、追加したい接続のアイコンを選択します。
3. Garoon アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからGaroon コネクタをダウンロードおよびインストールします。

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

Garoon への接続

認証値に加えて、下記のパラメータを使いGaroon に接続しデータを取得します。

• Url：アカウントのURL。

NOTE：サポートされているバージョンで許容されるURL 形式は以下のとおりです。

• Cloud 版：https://(subdomain).cybozu.com
• Package 版（Windows 環境）：http://(server IP address or host name)/scripts/(installation identifier)/grn.exe
• Package 版（Linux 環境）：http://(server IP address or host name)/cgi-bin/(installation identifier)/grn.cgi

Garoon への認証

Garoon は、以下の認証メソッドをサポートしています。

パスワード

Garoon への認証には、以下を設定する必要があります。

• User：アカウントのユーザー名。
• Password：アカウントのパスワード。
• AuthScheme：AuthScheme をPassword に設定。

追加のセキュリティ

これまでに説明した認証スキームに加えて、Garoon はBasic 認証ヘッダーおよびSSL 証明書の形で追加のセキュリティを提供します。

Basic

Basic 認証を使用しているGaroon 環境では、追加のBasic 資格情報を渡す必要があります。そのためには、次を設定してください。

• BasicAuthUser - Basic ログイン名。
• BasicAuthPassword - Basic パスワード。

クライアントSSL

認証情報に加えて、リクエストの受け入れにSSL 証明書が必須となるようGaroon を設定することができます。そのためには、次を設定してください。

• SSLClientCert - SSL 証明書の証明書を含むファイル。または、クライアント証明書のための証明書ストア名。
• SSLClientCertType - 証明書の種類。
• SSLClientCertSubject - （オプション）証明書ストアで証明書を検索する際に、ストア内でこのプロパティの値を含むサブジェクトを検索します。
• SSLClientCertPassword - 証明書ストアでパスワードが必要とされる場合、このプロパティを使用してパスワードを指定し、証明書ストアにアクセスできます。

このセクションでは、Garoon Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。

SSL の設定

SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、Garoon にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくは、クエリ処理 を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングに必要なのは2つの接続プロパティだけですが、より詳細なロギングをサポートする多くの機能があり、LogModules 接続プロパティを使用してロギングする情報のサブセットを指定することができます。

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

クライアントSSL 証明書

Garoon Sync App はクライアント証明書の設定もサポートしています。次を設定すれば、クライアント証明書を使って接続できます。

• SSLClientCert：クライアント証明書のための証明書ストア名。
• SSLClientCertType：TLS / SSL クライアント証明書を格納するキーストアの種類。
• SSLClientCertPassword：TLS / SSL クライアント証明書のパスワード。
• SSLClientCertSubject：TLS / SSL クライアント証明書のサブジェクト。

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

• ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
• ProxyPort：プロキシサーバーが起動しているTCP ポート。
• ProxyAuthScheme：プロキシサーバーに対して認証する際にSync App が使用する認証方法。
• ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
• ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

概要

このセクションでは、利用可能なAPI オブジェクトを示し、Garoon API へのSQL の実行について詳しく説明します。

主要機能

• Sync App はドキュメント、フォルダ、およびグループなどのGaroon エンティティをリレーショナルビューとしてモデル化し、SQL を記述してGaroon データをクエリできるようにします。
• ストアドプロシージャを使用するとGaroon の操作を実行できます。
• これらのオブジェクトへのライブ接続により、Sync App を使用するとGaroon アカウントへのあらゆる変更が即座に反映されます。

テーブル

テーブル では、利用可能なテーブルを説明します。テーブルは、Events、NotificationItems、UserPresence を静的にモデル化するように定義されています。

ビュー

ビュー では、利用可能なビューを説明します。ビューは、EventAttendees、Users、およびRequests などを静的にモデル化するように定義されています。

ストアドプロシージャ

ストアドプロシージャ は、Garoon のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、オブジェクトのダウンロードやエンベロープの移動など、Garoon の操作を実行できます。

Sync App はGaroon のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

Garoon Connector for CData Sync テーブル

Name	Description
Events	予定をクエリ、作成、変更、および削除します。
NotificationItems	通知項目をクエリ、作成、変更します。
UserPresence	在籍情報をクエリおよび変更します。

予定をクエリ、作成、変更、および削除します。

Select

Sync App は Garoon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。

• DateTime は<、<=、=、>= および > 演算子をサポートします。
• TargetType は'=' 演算子をサポートします。
• Target は'=' 演算子をサポートします。

NOTE： Target フィールドとTargetType フィールドは、クエリで両方使用する必要があります（つまり、Target フィールドがクエリで指定されている場合、TargetType フィールドも必須であり、その逆も同様です）。 例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM Events WHERE DateTime >= '2019-11-22 00:00:00.0'
SELECT * FROM Events WHERE DateTime > '2019-11-22 00:00:00.0'
SELECT * FROM Events WHERE targetType = 'user' AND target = '4'

Update

ReadOnly がfalse のカラムを更新できます。

UPDATE Events 
SET EventMenu = 'test', Subject = 'test', Notes = 'TEMPORARY', visibilityType = 'PRIVATE', useAttendanceCheck = false, CompanyInfoName = 'CompanyName', CompanyInfoZipCode = 'CompanyZipCode',
 CompanyInfoAddress = 'CompanyAddress', CompanyInfoRoute = 'CompanyRoute', CompanyInfoRouteTime = '2020', CompanyInfoRouteFare = '223', CompanyInfoPhone = '24342232342' , 
 StartDateTime = '2019-01-28T06:51:24Z', StartTimeZone = 'Asia/Tokyo', EndDateTime = '2019-01-28T06:51:24Z', EndTimeZone = 'Asia/Tokyo', isAllDay = true, isStartOnly = false, AdditionalItemsItemValue = 'test'
 WHERE Id = 35

テンポラリテーブルの使用：

INSERT INTO Watchers#TEMP (Code, Type) VALUES ('User1', 'USER')
INSERT INTO Watchers#TEMP (Code, Type) VALUES ('User2', 'USER')
INSERT INTO Watchers#TEMP (Code, Type) VALUES ('User3', 'USER')
UPDATE Events SET Watchers = 'Watchers#TEMP' WHERE Id = 35

集計の使用：

UPDATE Events SET Watchers = '[
    {
      "type": "USER",
      "code": "c000001"
    }
  ]', visibilityType = 'SET_PRIVATE_WATCHERS' WHERE Id = 35
UPDATE Events SET Attendees = '[
    {
      "type": "USER",
      "code": "c000001"
    }
  ]' WHERE Id = 35
  UPDATE Events SET facilities = '[
    {
      "code": "F001"
    }
  ]' WHERE Id = 35

Insert

Event を追加するには、次のカラムの組み合わせの少なくとも1つを指定する必要があります。
a) EventType、StartDateTime、StartTimeZone、EndDateTime、EndTimeZone およびFacilities カラム。
b) EventType、StartDateTime、StartTimeZone、EndDateTime、EndTimeZone およびAttendees カラム。
c) EventType、StartDateTime、StartTimeZone、IsStartOnly(true) およびFacilities カラム。
d) EventType、StartDateTime、StartTimeZone、IsStartOnly(true) およびAttendees カラム。

テンポラリテーブルの使用：

INSERT INTO EventAttendees#TEMP (Code, Type) VALUES ('User', 'USER')
INSERT INTO Events (EventType, StartDateTime, StartTimeZone, IsStartOnly, Attendees) VALUES ('REGULAR', '2020-09-27T14:00:00+09:00', 'Asia/Tokyo', true, 'EventAttendees#TEMP')

INSERT INTO EventFacilities#TEMP (Code) VALUES ('FacilityGroupsFacility1')
INSERT INTO Events (EventType, StartDateTime, StartTimeZone, EndDateTime, EndTimeZone, Facilities) VALUES ('REGULAR', '2020-09-17T14:00:00', 'Asia/Tokyo', '2020-09-17T15:00:00', 'Asia/Tokyo', 'EventFacilities#TEMP')

添付ファイル付きのイベントを挿入します。（添付ファイルのコンテンツにはBase64 エンコードが必要です。）

INSERT INTO EventAttendees#TEMP (Code, Type) VALUES ('Endri', 'USER')
INSERT INTO EventAttachments#TEMP (name, contentType, content) VALUES ('test1.txt', 'plain/text', 'dGVzdA==')
INSERT INTO EventAttachments#TEMP (name, contentType, content) VALUES ('test2.txt', 'plain/text', 'dGVrdrdr33zdA==')
INSERT INTO Events (EventType, StartDateTime, StartTimeZone, isStartOnly, Attendees, Attachments ) VALUES ('REGULAR', '2020-09-27T14:00:00+09:00', 'Asia/Tokyo', true, 'EventAttendees#TEMP', 'EventAttachments#TEMP')

集計の使用：

INSERT INTO Events (EventType, StartDateTime, StartTimeZone, EndDateTime, EndTimeZone, IsStartOnly, Facilities) VALUES ('REGULAR', '2020-09-27T14:00:00', 'Asia/Tokyo', '2020-09-27T15:00:00', 'Asia/Tokyo', false, '[
    {
      "code": "F001"
    }
  ]')

Delete

イベントのId を指定することでイベントを削除できます。

DELETE FROM Events WHERE Id = 34

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	予定の構成ID。
EventId	Int	True	予定ID。
CreatorId	Int	True	登録者のユーザーID。
CreatorCode	String	True	登録者のログイン名。
CreatorName	String	True	登録者の表示名。
CreatedAt	Datetime	True	予定の作成日時。
UpdaterId	Int	True	更新者ID。
UpdaterCode	String	True	更新者のログイン名。
UpdaterName	String	True	更新者の表示名。
UpdatedAt	Datetime	True	予定の更新日時。
EventType	String	False	予定のタイプ。
EventMenu	String	False	予定メニュー。
Subject	String	False	タイトル。
Notes	String	False	メモ。
VisibilityType	String	False	公開設定のタイプ。
UseAttendanceCheck	Boolean	False	出欠確認を使用しているかどうか。
Attachments	String	True	予定の添付ファイル。
Attendees	String	False	参加者のリスト。
AttendeesCandidate	String	True	参加者の候補リスト。
CompanyInfoName	String	False	会社名。
CompanyInfoZipCode	String	False	郵便番号。
CompanyInfoAddress	String	False	住所。
CompanyInfoRoute	String	False	路線の経路。
CompanyInfoRouteTime	String	False	路線の所要時間。
CompanyInfoRouteFare	String	False	路線の運賃。
CompanyInfoPhone	String	False	電話番号。
StartDateTime	Datetime	False	予定の開始日時。
StartTimeZone	String	False	開始タイムゾーン。
EndDateTime	Datetime	False	予定の終了日時。
EndTimeZone	String	False	終了タイムゾーン。
IsAllDay	Boolean	False	True に設定すると、終日の予定になります。
IsStartOnly	Boolean	False	True に設定すると、開始のみの予定になります。
OriginalStartTimeZone	String	True	予定の登録または更新時にstart.timeZone または repeatInfo.timeZone プロパティに設定されたタイムゾーン。
OriginalEndTimeZone	String	True	予定の登録または更新時にend.timeZone または repeatInfo.timeZone プロパティに設定されたタイムゾーン。
Watchers	String	False	予定の公開先のリスト。
WatchersCandidate	String	True	公開先の候補リスト。
Facilities	String	False	施設のリスト。
FacilitiesCandidate	String	True	施設の候補リスト。
FacilityUsingPurpose	String	False	施設の利用目的。
FacilityReservationInfo	String	True	施設予約情報。
FacilityUsageRequests	String	True	施設の利用申請のリスト。
RepeatInfo	String	True	繰り返し予定情報。
TemporaryEventCandidates	String	True	期間予定情報。
RepeatId	String	True	繰り返し予定ID。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
DateTime	Datetime	検索対象の日時をRFC3339 形式で指定します。サポートされる演算子は =、<、>、<=、>= です。
TargetType	String	ユーザー、組織、施設で結果を絞り込むには、タイプを指定します。 使用できる値は次のとおりです。user, organization, facility
Target	String	ユーザーID、組織ID、施設ID で結果を絞り込むにはID を指定します。

通知項目をクエリ、作成、変更します。

ビュー固有の情報

Garoon は、このビューをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。

Upsert

NotificationItem を追加/更新するには、少なくともNotificationKey、Operation、Url、Title、App およびDestinations（Code、Type およびId）カラムを指定する必要があります。
Note：アプリでは、値に外部通知コードを指定する必要があります。
クエリで既存のNotificationKey が指定されている場合、API は既存のレコードを更新します。指定されていない場合は、新しいレコードが作成されます。

テンポラリテーブルの使用：

INSERT INTO Destinations#TEMP (Code, Type, id) VALUES ('cybozu', 'USER', 2)
UPSERT INTO NotificationItems (NotificationKey, Operation, Url, Title, App, Destinations) VALUES ('15', 'remove', 'https://developer.cybozu.io/hc/ja/articles/360026939911', 'Sample title', 'Concur', 'Destinations#TEMP')

集計の使用：

UPSERT INTO NotificationItems (NotificationKey, Operation, Url, Title, App, Destinations) VALUES ('15', 'remove', 'https://developer.cybozu.io/hc/ja/articles/360026939911', 'Sample title', 'Concur', '[
    {
      "type": "USER",
      "code": "userCode",
      "id": "1"
    }
  ]')

Columns

Name	Type	ReadOnly	Description
NotificationKey [KEY]	String	True	Garoon 通知キー。
ModuleId [KEY]	String	True	Garoon のモジュールのID。
CreatorId	Int	True	通知の作成者のGaroon のユーザーID。
CreatorCode	String	True	通知の作成者のGaroon のユーザー名。
CreatorName	String	True	通知の作成者のGaroon のユーザーログイン名。
CreatedAt	Datetime	True	通知の作成日時。
Operation	String	True	通知操作の概要。次の3つの値から1つを指定できます：add、modify、remove。
Url	String	True	通知に含まれるURL。
Title	String	True	通知タイトル。
Body	String	True	通知本文。
Icon	String	True	通知アイコン。サンプルアイコンまたはURI を指定できます。
IsRead	Boolean	True	通知が既読かどうか。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
Destinations	String	通知の宛先リスト。カラムは挿入に使用され、データを返しません。
App	String	Garoon のアプリケーションの管理で設定されている「外部通知コード」を指定します。

在籍情報をクエリおよび変更します。

Select

Sync App は Garoon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でSync App 内部で処理されます。

• Id = 演算子をサポートします。
• コード = 演算子をサポートします。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM UserPresence WHERE Id = 24 
SELECT * FROM UserPresence WHERE Code = 'admin'

Update

ReadOnly がfalse のカラムを更新できます。

UPDATE UserPresence SET StatusCode = 'attend', Notes = 'Sample note' WHERE Id = 2

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Int	True	Garoon ユーザー ID。
Name	String	True	Garoon ユーザーの表示名。
Code	String	True	Garoon ユーザーのログイン名。
UpdatedAt	Datetime	True	在籍情報の更新日時。形式はISO8601 UTC タイムゾーンです。
Notes	String	False	メモ。
StatusCode	String	False	在籍情報のステータスコード。
StatusName	String	True	在籍情報のステータス名。

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

Garoon Connector for CData Sync ビュー

Name	Description
EventAttachments	予定の添付ファイルに関する情報をクエリします。
EventAttendees	予定の参加者に関する情報をクエリします。
EventFacilities	予定の施設に関する情報をクエリします。
EventWatchers	予定の公開先に関する情報をクエリします。
Facilities	施設に関する情報をクエリします。
FacilityGroups	施設グループに関する情報をクエリします。
Files	申請のファイルに関する情報をクエリします。
Organizations	組織に関する情報をクエリします。
OrganizationUsers	組織に所属するユーザーに関する情報をクエリします。
RequestItems	申請項目に関する情報をクエリします。
Requests	申請に関する情報をクエリします。
RequestSteps	申請ステップに関する情報をクエリします。
Users	ユーザーに関する情報をクエリします。

予定の添付ファイルに関する情報をクエリします。

ビュー固有の情報

Sync App はGaroon API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。

• TargetType は'=' 演算子をサポートします。
• Target は'=' 演算子をサポートします。

NOTE： Target フィールドとTargetType フィールドは、クエリで両方使用する必要があります（つまり、Target フィールドがクエリで指定されている場合、TargetType フィールドも必須であり、その逆も同様です）。 例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM EventAttachments WHERE TargetType = 'user' AND Target = '4'

Columns

Name	Type	Description
EventId [KEY]	Int	予定ID。
EventStartDateTime [KEY]	Datetime	予定の開始日時。
EventEndDateTime [KEY]	Datetime	予定の終了日時。
AttachmentId [KEY]	Int	添付ファイルID。
Name	String	添付ファイル名。
Size	Int	添付ファイルのサイズ。
ContentType	String	添付ファイルのコンテンツタイプ。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
TargetType	String	ユーザー、組織、施設で結果を絞り込むには、タイプを指定します。 使用できる値は次のとおりです。user, organization, facility
Target	String	ユーザーID、組織ID、施設ID で結果を絞り込むにはID を指定します。

予定の参加者に関する情報をクエリします。

ビュー固有の情報

Sync App はGaroon API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。

• TargetType は'=' 演算子をサポートします。
• Target は'=' 演算子をサポートします。

NOTE： Target フィールドとTargetType フィールドは、クエリで両方使用する必要があります（つまり、Target フィールドがクエリで指定されている場合、TargetType フィールドも必須であり、その逆も同様です）。 例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM EventAttendees WHERE TargetType = 'organization' AND Target = '4'

Columns

Name	Type	Description
EventId [KEY]	Int	予定ID。
EventStartDateTime [KEY]	Datetime	予定の開始日時。
EventEndDateTime [KEY]	Datetime	予定の終了日時。
AttendeeId [KEY]	Int	参加者のユーザーID。
Name	String	参加者の表示名。
Code	String	参加者コード。
Type	String	参加者のタイプ。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
TargetType	String	ユーザー、組織、施設で結果を絞り込むには、タイプを指定します。 使用できる値は次のとおりです。user, organization, facility
Target	String	ユーザーID、組織ID、施設ID で結果を絞り込むにはID を指定します。

予定の施設に関する情報をクエリします。

ビュー固有の情報

Sync App はGaroon API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。

• TargetType は'=' 演算子をサポートします。
• Target は'=' 演算子をサポートします。

NOTE： Target フィールドとTargetType フィールドは、クエリで両方使用する必要があります（つまり、Target フィールドがクエリで指定されている場合、TargetType フィールドも必須であり、その逆も同様です）。 例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM EventFacilities WHERE TargetType = 'facility' AND Target = '4'

Columns

Name	Type	Description
EventId [KEY]	Int	予定ID。
EventStartDateTime [KEY]	Datetime	予定の開始日時。
EventEndDateTime [KEY]	Datetime	予定の終了日時。
FacilityId [KEY]	Int	施設ID。
Name	String	施設名。
Code	String	施設コード。
Notes	String	施設のメモ。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
TargetType	String	ユーザー、組織、施設で結果を絞り込むには、タイプを指定します。 使用できる値は次のとおりです。user, organization, facility
Target	String	ユーザーID、組織ID、施設ID で結果を絞り込むにはID を指定します。

予定の公開先に関する情報をクエリします。

ビュー固有の情報

Sync App はGaroon API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。

• TargetType は'=' 演算子をサポートします。
• Target は'=' 演算子をサポートします。

NOTE： Target フィールドとTargetType フィールドは、クエリで両方使用する必要があります（つまり、Target フィールドがクエリで指定されている場合、TargetType フィールドも必須であり、その逆も同様です）。 例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM EventWatchers WHERE TargetType = 'user' AND Target = '4'

Columns

Name	Type	Description
EventId [KEY]	Int	予定ID。
EventStartDateTime [KEY]	Datetime	予定の開始日時。
EventEndDateTime [KEY]	Datetime	予定の終了日時。
WatcherId [KEY]	Int	公開先のユーザーID。
Name	String	公開先の表示名。
Code	String	公開先のコード。
Type	String	公開先のタイプ。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
TargetType	String	ユーザー、組織、施設で結果を絞り込むには、タイプを指定します。 使用できる値は次のとおりです。user, organization, facility
Target	String	ユーザーID、組織ID、施設ID で結果を絞り込むにはID を指定します。

施設に関する情報をクエリします。

Select

Sync App はGaroon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でSync App 内部で処理されます。

• Id ORDER BY 演算子をサポートします。
• FacilityGroupId = 演算子をサポートします。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM Facilities ORDER BY id
SELECT Code FROM Facilities
SELECT Id, Subject FROM Events ORDER BY startDateTime DESC LIMIT 2
SELECT * FROM Facilities WHERE FacilityGroupId = 1

Columns

Name	Type	Description
Id [KEY]	Int	施設ID。
Name	String	施設名。
Code	String	施設コード。
Notes	String	施設のメモ。
FacilityGroupId	Int	施設グループ。

施設グループに関する情報をクエリします。

ビュー固有の情報

Garoon は、このビューをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。

Columns

Name	Type	Description
Id [KEY]	Int	施設グループID。
Name	String	施設グループ名。
Code	String	施設グループコード。
Notes	String	施設グループのメモ。
ParentFacilityGroupId	Int	親施設グループID。
ChildFacilityGroups	String	子施設グループID。

申請のファイルに関する情報をクエリします。

Select

Sync App は Garoon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でSync App 内部で処理されます。

• Id = 演算子をサポートします。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM Files WHERE Id = 1

Columns

Name	Type	Description
Id [KEY]	Int	ファイルID。
Name	String	ファイル名。
ContentType	String	ファイルのコンテンツタイプ。
Size	Int	ファイルのサイズ。

組織に関する情報をクエリします。

ビュー固有の情報

Garoon は、このビューをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。

Columns

Name	Type	Description
Id [KEY]	Int	組織ID。
Name	String	組織名。
Code	String	組織コード。
ParentOrganization	Int	親組織ID。
ChildOrganizations	String	子組織ID。

組織に所属するユーザーに関する情報をクエリします。

Select

Sync App は Garoon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でSync App 内部で処理されます。

• OrganizationId = 演算子をサポートします。

例えば、次のクエリはサーバー側で処理されます。

SELECT OrganizationId, UserId FROM OrganizationUsers WHERE OrganizationId = 24 

Columns

Name	Type	Description
OrganizationId	Int	Garoon 組織ID。
UserId [KEY]	Int	Garoon ユーザーID。
Name	String	Garoon ユーザーの表示名。
Code	String	Garoon ユーザーのログイン名。

申請項目に関する情報をクエリします。

Select

Sync App は Garoon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でSync App 内部で処理されます。

• FormId = 演算子をサポートします。
• StatusType = および IN 演算子をサポートします。
• ApprovedAt <、<=、=、>= および > 演算子をサポートします。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM RequestItems WHERE FormId = 3
SELECT * FROM RequestItems WHERE StatusType = 'REJECTED'
SELECT * FROM RequestItems WHERE StatusType IN ('REJECTED', 'UNPROCESSING')
SELECT * FROM RequestItems WHERE ApprovedAt = '2017-09-01 06:32:57.0'
SELECT * FROM RequestItems WHERE ApprovedAt >= '2017-09-01 06:32:57.0'

Columns

Name	Type	Description
RequestId [KEY]	Int	申請ID。
FormId	Int	申請フォームID。
StatusType	String	申請のステータス。
ItemId [KEY]	String	項目ID。
ItemName	String	項目名。
Type	String	項目のタイプ。
Value	String	項目の値。
Single_Line_Text_Value	String	項目の単一行テキスト値。
Multi_Line_Text_Value	String	項目の複数行テキスト値。
Number_Value	Decimal	項目の数値。
Calc_Value	Decimal	項目の計算値。
Date_Value	String	項目の日付の値。
DATETIME_Value	String	項目の日時の値。
Radio_Button_Value	String	項目のラジオボタン。
Drop_Down_Value	String	項目のドロップダウンの値。
Check_Box_Value	String	項目のチェックボックスの値。
Route_Navi_Value	String	項目の路線ナビ連携の値。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
ApprovedAt	Datetime	最終承認日時をRFC3339 形式で指定します。サポートされる演算子は =、<、>、<=、>= です。

申請に関する情報をクエリします。

Select

Sync App は Garoon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でSync App 内部で処理されます。

• FormId = 演算子をサポートします。
• StatusType = および IN 演算子をサポートします。
• ApprovedAt <、<=、=、>= および > 演算子をサポートします。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM Requests WHERE FormId = 3
SELECT * FROM Requests WHERE StatusType = 'REJECTED'
SELECT * FROM Requests WHERE StatusType IN ('REJECTED', 'UNPROCESSING')
SELECT * FROM Requests WHERE ApprovedAt = '2017-09-01 06:32:57.0'
SELECT * FROM Requests WHERE ApprovedAt >= '2017-09-01 06:32:57.0'

Columns

Name	Type	Description
Id [KEY]	Int	申請ID。
StatusName	String	申請のステータス名。
StatusType	String	ステータスのタイプ。
CreatedAt	Datetime	申請の作成日時。形式はISO8601 UTC タイムゾーンです。
UpdatedAt	Datetime	申請の更新日時。形式はISO8601 UTC タイムゾーンです。
ProcessingStepCode	String	経路ステップのステップコード。
Name	String	申請フォーム名。
Number	String	申請番号。
IsUrgent	Boolean	優先度が指定されているかどうか。
ApplicantId	Int	申請者ID。
ApplicantCode	String	申請者コード。
ApplicantName	String	申請者のプロキシID。
ApplicantProxyId	Int	申請者のプロキシコード。
ApplicantProxyCode	String	申請者のプロキシ名。
ApplicantProxyName	String	申請者の表示名。
FormId	Int	申請フォームID。
FormName	String	申請フォームの表示名。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
ApprovedAt	Datetime	最終承認日時をRFC3339 形式で指定します。サポートされる演算子は =、<、>、<=、>= です。

申請ステップに関する情報をクエリします。

Select

Sync App は Garoon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でSync App 内部で処理されます。

• FormId = 演算子をサポートします。
• StatusType = および IN 演算子をサポートします。
• ApprovedAt <、<=、=、>= および > 演算子をサポートします。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM RequestSteps WHERE FormId = 3
SELECT * FROM RequestSteps WHERE StatusType = 'REJECTED'
SELECT * FROM RequestSteps WHERE StatusType IN ('REJECTED', 'UNPROCESSING')
SELECT * FROM RequestSteps WHERE ApprovedAt = '2017-09-01 06:32:57.0'
SELECT * FROM RequestSteps WHERE ApprovedAt >= '2017-09-01 06:32:57.0'

Columns

Name	Type	Description
RequestId	Int	申請ID。
FormId	Int	申請フォームID。
StatusType	String	申請のステータス。
StepId [KEY]	Int	ステップのId。
StepName	String	ステップ名。
IsApprovalStep	Boolean	承認ステップかどうか。
Requirement	String	ステップのタイプ。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
ApprovedAt	Datetime	最終承認日時をRFC3339 形式で指定します。サポートされる演算子は =、<、>、<=、>= です。

ユーザーに関する情報をクエリします。

ビュー固有の情報

Garoon は、このビューをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。

Columns

Name	Type	Description
Id [KEY]	Int	ユーザーID。
Name	String	ユーザー名。
Code	String	ユーザーコード。

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

Authentication

---

プロパティ	説明
URL	Garoon アカウントのURL。
User	認証するGaroon ユーザーアカウントのユーザーID を指定します。
Password	認証するユーザーアカウントのパスワードを指定します。
BasicAuthUser	Basic 認証を使用するドメインに必要な追加のユーザー名。
BasicAuthPassword	Basic 認証を使用するドメインに必要な追加のパスワード。

SSL

---

プロパティ	説明
SSLClientCert	SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。
SSLClientCertType	SSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。
SSLClientCertPassword	TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。
SSLClientCertSubject	TLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Firewall

---

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

Proxy

---

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

Schema

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

Miscellaneous

---

プロパティ	説明
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Pagesize	Garoon から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

---

プロパティ	説明
URL	Garoon アカウントのURL。
User	認証するGaroon ユーザーアカウントのユーザーID を指定します。
Password	認証するユーザーアカウントのパスワードを指定します。
BasicAuthUser	Basic 認証を使用するドメインに必要な追加のユーザー名。
BasicAuthPassword	Basic 認証を使用するドメインに必要な追加のパスワード。

Garoon アカウントのURL。

解説

'https://cyp344.cybozu.com' 形式のGaroon アカウントのURL。

認証するGaroon ユーザーアカウントのユーザーID を指定します。

解説

認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。

認証するユーザーアカウントのパスワードを指定します。

解説

認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。

Basic 認証を使用するドメインに必要な追加のユーザー名。

解説

Basic 認証が有効なドメインに接続するために使用するBasic 認証のユーザー名。このフィールドは、BasicAuthPassword とともに、Garoon サーバーへのユーザー認証を実現するために使用されます。

Basic 認証を使用するドメインに必要な追加のパスワード。

解説

Basic 認証が有効なドメインに接続するために使用するBasic 認証のパスワード。このフィールドは、BasicAuthUser とともに、Garoon サーバーへのユーザー認証を実現するために使用されます。

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

---

プロパティ	説明
SSLClientCert	SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。
SSLClientCertType	SSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。
SSLClientCertPassword	TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。
SSLClientCertSubject	TLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。

解説

このプロパティは、SSL クライアント認証のためのクライアント証明書ストアを指定します。 このプロパティは、証明書ストアの種類を定義するSSLClientCertType、およびパスワードで保護されたストア用のパスワードを指定するSSLClientCertPassword と一緒に使用します。 SSLClientCert が設定され、SSLClientCertSubject が設定されている場合、ドライバーは指定されたサブジェクトに一致する証明書を検索します。

証明書ストアの指定はプラットフォームによって異なります。 Windowsでは、証明書ストアはMY（個人証明書）などの名前で識別されますが、Java では、証明書ストアは通常、証明書とオプションの秘密キーを含むファイルです。

Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。

MY	個人証明書と関連付けられた秘密キーを格納している証明書ストア。
CA	証明機関の証明書。
ROOT	ルート証明書。
SPC	ソフトウェア発行元証明書。

PFXFile タイプの場合、このプロパティをファイル名に設定します。PFXBlob タイプの場合は、このプロパティをPKCS12 形式のファイルのバイナリコンテンツに設定します。

SSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。

解説

このプロパティは、クライアント証明書を指定するために使用されるキーストアの形式と場所を決定します。 サポートされている値には、プラットフォーム固有およびユニバーサルなキーストア形式があります。 有効な値と使用方法は以下のとおりです。

USER - デフォルト	Windows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。この種類はJava では利用できませんので注意してください。
MACHINE	Windows の場合、この証明書ストアがシステムストアであることを指定します。この種類はJava では利用できませんので注意してください。
PFXFILE	この証明書ストアは、証明書を含むPFX（PKCS12）ファイルの名前です。
PFXBLOB	この証明書ストアは、PFX（PKCS12）形式の証明書ストアを表すBase-64でエンコードされた文字列です。
JKSFILE	この証明書ストアは、証明書を含むJava key store（JKS）ファイルの名前です。この種類はJava でのみ利用できますので注意してください。
JKSBLOB	この証明書ストアは、Java key store（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エンコード）です。

TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。

解説

このプロパティは、パスワードで保護された証明書ストアを開くために必要なパスワードを指定します。 このプロパティは、PFX やJKS タイプのストアによく推奨されるように、復号化のためにパスワードを必要とする証明書ストアを使用する場合に必要です。

証明書ストアの種類がパスワードを必要としない場合（Windows のUSER やMACHINE など）、このプロパティは空白のままにできます。 認証エラーを回避するため、パスワードが指定された証明書ストアに関連付けられたものと一致していることを確認してください。

TLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。

解説

このプロパティは、サブジェクトに基づいてロードするクライアント証明書を決定します。Sync App は、指定されたサブジェクトに完全に一致する証明書を検索します。 完全に一致するものが見つからない場合、Sync App はサブジェクトの値を含む証明書を検索します。 一致する証明書がない場合、証明書は選択されません。

サブジェクトは、識別名フィールドと値のカンマ区切りリストという標準の形式に従うべきです。 例えば、CN=www.server.com, OU=Test, C=US です。一般的なフィールドには以下のものが含まれます。

フィールド	説明
CN	共通名。一般的には、www.server.com のようなホスト名です。
O	法人名
OU	法人の部署名
L	法人の住所（市町村名）
S	法人の住所（都道府県）
C	国名
E	E メールアドレス

Note： フィールドにカンマなどの特殊文字が含まれている場合は、値を引用符で囲む必要があります。例：CN="Example, Inc.", C=US。

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

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

---

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Note：デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。

次の表は、サポートされている各プロトコルのポート番号情報です。

プロトコル	デフォルトポート	説明
TUNNEL	80	Sync App がGaroon への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。
SOCKS4	1080	Sync App がGaroon への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	Sync App がGaroon にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールで使用するTCP ポートを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。

---

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。

解説

この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします（プロキシサーバーの詳細を手動で入力する必要はありません）。

この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。

クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。

その他のプロキシタイプについては、FirewallType を参照してください。

ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。

解説

認証タイプは次のいずれかです。

• BASIC：Sync App はHTTP BASIC 認証を行います。
• DIGEST：Sync App はHTTP DIGEST 認証を行います。
• NTLM：Sync App はNTLM トークンを取得します。
• NEGOTIATE：Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
• NONE：ProxyServer が認証を必要としない場合に設定します。

"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 接続プロパティは設定しないでください。

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 を参照してください。

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 は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

解説

このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。 ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。 各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。

例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。 複数のモジュールを含めるには、次のように名前をセミコロンで区切ります：INFO;EXEC;SSL。

Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。 利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。

利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログ の「高度なログの記録」セクションを参照してください。

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。

解説

Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は%APPDATA%\\CData\\Garoon 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 プロパティの全リストを提供します。

---

プロパティ	説明
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Pagesize	Garoon から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

集計やGROUP BY を使用しないクエリで返される最大行数を指定します。

解説

このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。

特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

解説

このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティをセミコロン区切りのリストで定義できます。

Note： 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット

DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

Garoon から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。

解説

クエリする特定のオブジェクトやサービスエンドポイントの結果を最適化するために、デフォルトのページサイズを調整したい場合があります。 ページサイズを大きくするとパフォーマンスが向上するかもしれませんが、ページあたりのメモリ消費量が増える可能性もあることに注意してください。

テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。

解説

このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"

すべてのテーブルのすべての擬似カラムを含めるには、次のようにします："*=*"

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

解説

このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

解説

このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。

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

このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 例：UserDefinedViews=C:\Path\To\UserDefinedViews.json。 このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

詳しくは、ユーザー定義ビュー を参照してください。