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

必須プロパティは［設定］タブにリストされています。［Advanced］タブには、通常は必要ない接続プロパティが表示されます。

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 に設定。

Additional Security

In addition to the mentioned authentication schemes, Garoon offers additional security in the form of both an additional Basic Auth header, and an SSL Certificate.

Basic

Garoon environments using basic authentication will need to pass additional basic credentials. To do so, specify the following:

• BasicAuthUser - The basic login name.
• BasicAuthPassword - The basic password.

クライアントSSL

In addition to your authentication information, Garoon may be configured to require an SSL certificate to accept requests. To do so, set the following:

• SSLClientCert - The file containing the certificate of the SSL Cert. Or alternatively, the name of the certificate store for the client certificate.
• SSLClientCertType - The type of certificate.
• SSLClientCertSubject - (Optional) If searching for a certificate in the certificate store, the store is searched for subjects containing the value of the property.
• SSLClientCertPassword - If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store.

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

ユーザー定義ビュー

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

SSL の設定

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

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

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

クエリ処理

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

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

ログ

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

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

クライアントSSL 証明書

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

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

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

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

• プロキシベースのファイヤーウォールを使用するには、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 テーブルのクエリは、リレーショナルデータベースのテーブルのクエリと同じです。時には特別なケースもあります。例えば、テーブルの特定のカラムデータを取得するために特定のカラムをWHERE 句に含める必要がある場合などです。これは通常、特定のカラムを取得するために行ごとに個別のリクエストを行う必要がある場合に必要です。これらの特別な状況は、以下にリンクされているテーブルページの上部に明確に文書化されています。

Garoon Connector for CData Sync テーブル

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

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

Select

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

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

NOTE： Target and TargetType fields should be used together in the query (i.e If target field is specified in the query, targetType field is also mandatory and vice versa). 例えば、次のクエリはサーバー側で処理されます。

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	期間予定情報。
AdditionalItemsItemValue	String	False	予定のAPI用連携項目の値。
RepeatId	String	True	繰り返し予定ID。

Pseudo-Columns

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

Name	Type	Description
DateTime	Datetime	検索対象の日時をRFC3339 形式で指定します。サポートされる演算子は =、<、>、<=、>= です。
TargetType	String	Specify the type to narrow down the results by user, organization or facility. 使用できる値は次のとおりです。user, organization, facility
Target	String	Specify the ID to narrow down the results by user Id, organization Id or facility 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	在籍情報のステータス名。

ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。

ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。

ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。

Garoon Connector for CData Sync ビュー

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

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

ビュー固有の情報

The Sync App will use the Garoon 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.

• TargetType supports '=' operator.
• Target supports '=' operator.

NOTE: Target and TargetType fields should be used together in the query (i.e If target field is specified in the query, targetType field is also mandatory and vice versa). For example, the following queries are processed server side:

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	Specify the type to narrow down the results by user, organization or facility. 使用できる値は次のとおりです。user, organization, facility
Target	String	Specify the ID to narrow down the results by user Id, organization Id or facility Id.

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

ビュー固有の情報

The Sync App will use the Garoon 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.

• TargetType supports '=' operator.
• Target supports '=' operator.

NOTE: Target and TargetType fields should be used together in the query (i.e If target field is specified in the query, targetType field is also mandatory and vice versa). For example, the following queries are processed server side:

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	Specify the type to narrow down the results by user, organization or facility. 使用できる値は次のとおりです。user, organization, facility
Target	String	Specify the ID to narrow down the results by user Id, organization Id or facility Id.

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

ビュー固有の情報

The Sync App will use the Garoon 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.

• TargetType supports '=' operator.
• Target supports '=' operator.

NOTE: Target and TargetType fields should be used together in the query (i.e If target field is specified in the query, targetType field is also mandatory and vice versa). For example, the following queries are processed server side:

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	Specify the type to narrow down the results by user, organization or facility. 使用できる値は次のとおりです。user, organization, facility
Target	String	Specify the ID to narrow down the results by user Id, organization Id or facility Id.

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

ビュー固有の情報

The Sync App will use the Garoon 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.

• TargetType supports the '=' operator.
• Target supports the '=' operator.

NOTE: Target and TargetType fields should be used together in the query (i.e If target field is specified in the query, targetType field is also mandatory and vice versa). For example, the following queries are processed server side:

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	Specify the type to narrow down the results by user, organization or facility. 使用できる値は次のとおりです。user, organization, facility
Target	String	Specify the ID to narrow down the results by user Id, organization Id or facility 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

SupportEnhancedSQL をfalse に設定すると、クライアント側の実行をオフにできます。その場合、その他のカラムを参照する検索条件でエラーが発生します。

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

SupportEnhancedSQL をfalse に設定すると、クライアント側の実行をオフにできます。その場合、その他のカラムを参照する検索条件でエラーが発生します。

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'

SupportEnhancedSQL をfalse に設定すると、クライアント側の実行をオフにできます。その場合、その他のカラムを参照する検索条件でエラーが発生します。

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'

SupportEnhancedSQL をfalse に設定すると、クライアント側の実行をオフにできます。その場合、その他のカラムを参照する検索条件でエラーが発生します。

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'

SupportEnhancedSQL をfalse に設定すると、クライアント側の実行をオフにできます。その場合、その他のカラムを参照する検索条件でエラーが発生します。

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 ユーザーアカウント。
Password	ユーザーの認証で使用されるパスワード。
BasicAuthUser	Basic 認証を使用するドメインに必要な追加のユーザー名。
BasicAuthPassword	Basic 認証を使用するドメインに必要な追加のパスワード。

SSL

---

プロパティ	説明
SSLClientCert	SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストア。
SSLClientCertType	TLS/SSL クライアント証明書を格納するキーストアの種類。
SSLClientCertPassword	TLS/SSL クライアント証明書のパスワード。
SSLClientCertSubject	TLS/SSL クライアント証明書のサブジェクト。
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

Firewall

---

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

Proxy

---

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
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	クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	Garoon から返されるページあたりの結果の最大数。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

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

---

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

Garoon アカウントのURL。

解説

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

認証で使用されるGaroon ユーザーアカウント。

解説

このフィールドは、Password とともに、Garoon サーバーに対して認証をするために使われます。

ユーザーの認証で使用されるパスワード。

解説

User およびPassword を一緒に使用してサーバーで認証を行います。

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

解説

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

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

解説

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

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

---

プロパティ	説明
SSLClientCert	SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストア。
SSLClientCertType	TLS/SSL クライアント証明書を格納するキーストアの種類。
SSLClientCertPassword	TLS/SSL クライアント証明書のパスワード。
SSLClientCertSubject	TLS/SSL クライアント証明書のサブジェクト。
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストア。

解説

クライアント証明書のための証明書ストア名。

SSLClientCertType フィールドは、SSLClientCert により指定された証明書ストアの種類を指定します。ストアがパスワードで保護されている場合は、SSLClientCertPassword でパスワードを指定します。

SSLClientCert は、SSLClientCertSubject フィールドとともにクライアント証明書を指定するために使われます。SSLClientCert に値がある場合で、SSLClientCertSubject が設定されている場合は、証明書の検索が始まります。詳しくは、SSLClientCertSubject を参照してください。

証明書ストアの指定はプラットフォームに依存します。

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

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

Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。

証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ（例えば、PKCS12証明書ストア）に設定する必要があります。

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 形式の証明書を含む文字列の名前です。

TLS/SSL クライアント証明書のパスワード。

解説

証明書ストアでパスワードが必要である場合、このプロパティを使用してパスワードを指定し、証明書ストアにアクセスできます。

TLS/SSL クライアント証明書のサブジェクト。

解説

証明書のサブジェクトは、証明書をロードするときにストア内の証明書を検索するために使用されます。

完全に一致するものが見つからない場合、ストアはプロパティの値を含むサブジェクトを検索します。それでも一致するものが見つからない場合、プロパティは空白で設定され、証明書は選択されません。

"*" に設定すると、証明書ストアの1番目の証明書が選択されます。

証明書のサブジェクトは識別の名前フィールドおよび値のカンマ区切りのリストです。例えば、"CN=www.server.com, OU=test, C=US, [email protected]" です。共通のフィールドとその説明は以下のとおりです。

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

フィールド値にカンマが含まれている場合は、それを引用符で囲む必要があります。

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	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

プロキシベースのファイアウォールで使われるプロトコル。

解説

このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。

タイプ	デフォルトポート	説明
TUNNEL	80	これが設定されている場合、Sync App はGaroon への接続を開き、プロキシを経由して通信が行われます。
SOCKS4	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

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

プロキシベースのファイアウォールの名前もしくはIP アドレス。

解説

ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。

Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。

プロキシベースのファイアウォールのTCP ポート。

解説

ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。

プロキシベースのファイアウォールに認証するために使うユーザー名。

解説

FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。

プロキシベースのファイアウォールへの認証に使われるパスワード。

解説

このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。

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

---

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

解説

これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

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

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

解説

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。

SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。

ProxyServer プロキシが起動しているTCP ポート。

解説

HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。

ProxyServer プロキシへの認証で使われる認証タイプ。

解説

この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。

Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

認証タイプは、次のどれかになります。

• BASIC： Sync App はHTTP BASIC 認証を行います。
• DIGEST： Sync App はHTTP DIGEST 認証を行います。
• NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKereros トークンを取得します。
• PROPRIETARY： Sync App はNTLM もしくはKerberos トークンを発行しません。このトークンを、HTTP リクエストのAuthorization ヘッダーに含める必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyServer プロキシへの認証に使われるユーザー名。

解説

ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。

ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。

user@domain
domain\user

ProxyServer プロキシへの認証に使われるパスワード。

解説

このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。

HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。

NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。

ProxyServer プロキシへの接続時に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。

AUTO	デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

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

Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

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

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

ログファイルに含めるコアモジュール。

解説

指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。

概要はログ ページを参照してください。

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

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。

解説

Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\Garoon Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます：

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。

このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。

解説

テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

解説

ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

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

---

プロパティ	説明
MaxRows	クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	Garoon から返されるページあたりの結果の最大数。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

解説

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

これらの隠しプロパティは特定のユースケースでのみ使用されます。

解説

以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。

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

統合およびフォーマット

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

Garoon から返されるページあたりの結果の最大数。

解説

Pagesize プロパティは、Garoon から返されるページあたりの結果の最大数に影響を与えます。より大きい値を設定すると、1ページあたりの消費メモリが増える代わりに、パフォーマンスが向上する場合があります。

このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。

解説

Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。

カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

解説

ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。

また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。

• 各ルートエレメントはビューの名前を定義します。
• 各ルートエレメントには、query と呼ばれる子エレメントが含まれており、この子エレメントにはビューのカスタムSQL クエリが含まれています。

次に例を示します。

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

UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。

"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"