Kintone への接続を追加

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

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

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

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

Kintone への接続

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

• Url：アカウントのURL。
• GuestSpaceId：オプション。ゲストスペースを使用するときに設定。

Kintone への認証

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

パスワード認証

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

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

API トークン

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

• APIToken：API トークン。

  API トークンを生成するには、特定のアプリにアクセスして歯車アイコンをクリックしてください。［設定］->［APIトークン］に移動します。［生成する］ボタンをクリックすると、API トークンが生成されます。 APIToken をカンマ区切りで複数指定することもできます。

• AppId：アプリID。

  AppId はkintone UI ダッシュボードの［アプリ］内に並んだ特定のアプリの番号です。 AppId をカンマ区切りで複数指定することもできます。

• AuthScheme：AuthScheme をAPIToken に設定。

追加のセキュリティ

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

クライアントSSL の使用

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

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

Basic

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

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

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

ユーザー定義ビュー

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

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

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

クエリ処理

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

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

ログ

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

Firewall またはProxy 経由の接続

HTTP プロキシ

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

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

その他のプロキシ

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

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

Sync App は、Kintone API をリレーショナルテーブル、ビュー、およびストアドプロシージャ としてモデル化します。

テーブル

Sync App を使用すると、アカウント内のすべてのテーブルを操作できます。テーブルスキーマは静的または動的になります。Comments テーブルには、固定カラムを持つ静的スキーマがあります。他のテーブルは動的で、メタデータの変更を反映します。接続すると、Sync App はKintone のテーブルメタデータを取得してテーブルスキーマを生成します。

静的スキーマは、容易に拡張できるスキーマファイルで定義されます。例えばデータ型を変更するなどComments 静的テーブルの動作をカスタマイズするには、スキーマファイルを編集します。スキーマファイルは、Sync App インストールフォルダのdb サブフォルダにあります。

サブテーブル

いくつかのKintone アプリでは、ユーザーは多くのレコードを含むカスタムフィールドを追加できます。Sync App はこれらのフィールドを、変更を反映する動的なサブテーブルとしてモデル化します。

ストアドプロシージャ

ストアドプロシージャ は、Kintone のファンクションライクなインターフェースです。これらを使用して、Kintone 内の情報を検索、更新、および変更できます。 例えば、ストアドプロシージャを使用してアプリの操作を実行したりファイルで作業したりします。

ビュー

Sync App は静的なApps ビューのアプリをモデル化します。

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

Kintone Connector for CData Sync テーブル

Name	Description
Comments	kintone で利用可能なコメントをクエリします。

kintone で利用可能なコメントをクエリします。

Select

WHERE 句ではRecordId およびAppId カラムが必須です。Sync App はKintone API を使用してこれらのカラムによる結果をフィルタリングします。また、Kintone API はId のフィルタもサポートしています。 デフォルトでは、Sync App はクライアント側でSync App 内で他のフィルタを処理します。

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

SELECT * FROM Comments WHERE RecordId = 1 AND AppId = 5 AND Id = 1

Insert

INSERT ステートメントでは、AppId およびRecordId カラムが必須です。

INSERT INTO Comments (AppId, RecordId, Text, MentionsAggregate) VALUES (5, 1, 'To do', '[{"code": "Administrator","type": "USER"}]')

Delete

Comments を削除するには、RecordId、AppId、およびId を指定してDELETE ステートメントを発行します。

DELETE FROM Comments WHERE RecordId = 1 AND AppId = 5 AND Id = 1

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	True		コメントID。
AppId [KEY]	Integer	False		アプリID。
RecordId [KEY]	Integer	False		レコードID。
Text	String	False		改行コードを含むコメント。
CreatorCode	String	True		コメント作成者のユーザーコード（ログイン名）。
CreatorName	String	True		コメント作成者のユーザー名（表示名）。
CreatedAt	Datetime	True		コメントの作成日時。
MentionsAggregate	String	False		メンションされたユーザーの情報を含む配列。

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

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

Kintone Connector for CData Sync ビュー

Name	Description
Apps	kintone で利用可能なアプリをクエリします。

kintone で利用可能なアプリをクエリします。

Select

デフォルトでは、Sync App はKintone API を使用して以下のカラムを参照する検索条件を処理し、クライアント側でSync App 内で他のフィルタを処理します。Kintone API は、AppId、Code、およびSpaceId カラムの検索をサポートしています。これらのカラムは= およびIN 演算子のサーバー側処理をサポートしますが、Name カラムがサポートするのはLIKE 演算子のみです。例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM Apps WHERE AppId IN (20, 21, 51, 56) AND Name LIKE '%To Do%'

Columns

Name	Type	References	Description
AppId [KEY]	Integer		kintone アプリケーションのアプリID。
Code	String		アプリのアプリコード。アプリの設定でアプリコードが設定されていない場合は空になります。
Name	String		アプリの名前。ローカライズの設定が使われている場合、このカラムはこのAPI を使用しているkintone ユーザーの言語設定に従ってローカライズされた名前を返します。
Description	String		アプリの説明。ローカライズの設定が使われている場合、このカラムはこのAPI を使用しているkintone ユーザーの言語設定に従ってローカライズされたアプリの説明を返します。
SpaceId	String		アプリがスペース内で作成された場合、このカラムはスペースID を返します。そうでない場合はnull を返します。
ThreadId	String		アプリがスペース内で作成された場合、このカラムはアプリが属するスペースのスレッドのスレッドID を返します。ユーザーインターフェースの設定をクラシックデザインに変更していないユーザーは、スペース内でアプリが作成される際、アプリは自動的にスペースの最初のスレッドに属します。クラシックデザインを使用しているユーザーは、スペーススペシフィックではなく、スレッドスペシフィックなアプリを作成することができます。アプリがスペースで作成されなかった場合は、null が返されます。
CreatedAt	Datetime		アプリが作成された日付。
CreatorCode	String		作成したユーザーのログイン名。停止ユーザーおよび削除ユーザーの場合は何も返されません。
CreatorName	String		作成したユーザーの表示名。停止ユーザーおよび削除ユーザーの場合は何も返されません。
ModifiedAt	Datetime		アプリが最後に変更された日付。
ModifierCode	String		最後に更新したユーザーのログイン名。停止ユーザーおよび削除ユーザーの場合は何も返されません。
ModifierName	String		最後に更新したユーザーの表示名。停止ユーザーおよび削除ユーザーの場合は何も返されません。
Alias	String		アプリのエイリアス名。

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

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

Authentication

---

プロパティ	説明
AuthScheme	Kintone にUser / Password で接続するかAPIToken で接続するか。
URL	Kintone URL。次に例を示します。 https://SUBDOMAIN_NAME.cybozu.com
User	認証で使用されるKintone ユーザーアカウント。
Password	ユーザーの認証で使用されるパスワード。
BasicAuthUser	Basic 認証を使用するドメインに必要な追加のユーザー名。
BasicAuthPassword	Basic 認証を使用するドメインに必要な追加のパスワード。
AppId	認証時にAPI トークンとともに使用するアプリID。
APIToken	認証時に使用するAPI トークン。

SSL

---

プロパティ	説明
SSLClientCert	SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストア。
SSLClientCertType	TLS/SSL クライアント証明書を格納するキーストアの種類。
SSLClientCertPassword	TLS/SSL クライアント証明書のパスワード。
SSLClientCertSubject	TLS/SSL クライアント証明書のサブジェクト。

Firewall

---

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

Proxy

---

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。
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

---

プロパティ	説明
AllowSpecialCharacters	特殊文字を許容するかどうかを決定します。True の場合、特殊文字は置き換えられません。
CheckForSubtablesIn	サブテーブルを取得するKintone アプリのカンマ区切りリスト。
GuestSpaceId	クエリ結果をゲストスペースに制限します。
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
NumberMapToDouble	数値フィールドのデータ型をdecimal からdouble に変更するかどうかを決定します。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	Kintone から返されるページあたりの結果の最大数。
SubtableSeparatorCharacter	tablename + char + subtable 形式のサブテーブルからテーブルを分割するために使用される文字。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UseCodeForFieldName	フィールド名にLabel かCode のどちらを使用するかを決定します。
UseCursor	カーソルを使用してレコードを取得するかどうかを決定するboolean。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
UseSimpleNames	テーブルとカラムに簡略名を使用するかどうかを決定するboolean。
UseUnitForNumericField	フィールド名に単位を表示するかどうかを決定します。

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

---

プロパティ	説明
AuthScheme	Kintone にUser / Password で接続するかAPIToken で接続するか。
URL	Kintone URL。次に例を示します。 https://SUBDOMAIN_NAME.cybozu.com
User	認証で使用されるKintone ユーザーアカウント。
Password	ユーザーの認証で使用されるパスワード。
BasicAuthUser	Basic 認証を使用するドメインに必要な追加のユーザー名。
BasicAuthPassword	Basic 認証を使用するドメインに必要な追加のパスワード。
AppId	認証時にAPI トークンとともに使用するアプリID。
APIToken	認証時に使用するAPI トークン。

Kintone にUser / Password で接続するかAPIToken で接続するか。

解説

• Password：パスワード認証を実行する場合に設定。
• APIToken：APIToken 認証を実行する場合に設定。

Kintone URL。次に例を示します。 https://SUBDOMAIN_NAME.cybozu.com

解説

Kintone URL。次に例を示します。

https://SUBDOMAIN_NAME.cybozu.com

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

解説

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

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

解説

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

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

解説

Basic 認証が有効なドメインに接続するために使用するBasic 認証のユーザー名。Basic 認証は2段階認証です。Basic 認証を使用するドメインに接続する場合は、User とPassword に加えてBasicAuthUser とBasicAuthPassword を設定します。

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

解説

Basic 認証が有効なドメインに接続するために使用するBasic 認証のパスワード。Basic 認証は2段階認証です。Basic 認証を使用するドメインに接続する場合は、User とPassword に加えてBasicAuthUser とBasicAuthPassword を設定します。

認証時にAPI トークンとともに使用するアプリID。

解説

AppId は、kintone UI ダッシュボードの［アプリ］の下にあるシーケンス内の特定のアプリの番号です。

AppId をカンマ区切りで複数指定することもできます。

認証時に使用するAPI トークン。

解説

認証時に使用するAPI トークン。API トークンを作成するには、API トークンを作成する特定のアプリにアクセスして歯車アイコンをクリックします。［アプリの設定］->［設定］タブ->［APIトークン］に進み、［生成する］ボタンをクリックすると、API トークンが生成されます。

また、Lookup フィールドやRelated Record フィールドを含む操作の場合は、APIToken をカンマ区切りで複数指定することができます。

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

---

プロパティ	説明
SSLClientCert	SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストア。
SSLClientCertType	TLS/SSL クライアント証明書を格納するキーストアの種類。
SSLClientCertPassword	TLS/SSL クライアント証明書のパスワード。
SSLClientCertSubject	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メールアドレス

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

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

---

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

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

解説

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

タイプ	デフォルトポート	説明
TUNNEL	80	これが設定されている場合、Sync App はKintone への接続を開き、プロキシを経由して通信が行われます。
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	これは、システムプロキシ設定を使用するかどうかを示します。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

これは、システムプロキシ設定を使用するかどうかを示します。

解説

これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するには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 もしくはKerberos トークンを取得します。
• 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\\Kintone Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます：

Platform	%APPDATA%
Windows	APPDATA 環境変数の値
Linux	~/.config

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、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 プロパティの全リストを提供します。

---

プロパティ	説明
AllowSpecialCharacters	特殊文字を許容するかどうかを決定します。True の場合、特殊文字は置き換えられません。
CheckForSubtablesIn	サブテーブルを取得するKintone アプリのカンマ区切りリスト。
GuestSpaceId	クエリ結果をゲストスペースに制限します。
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
NumberMapToDouble	数値フィールドのデータ型をdecimal からdouble に変更するかどうかを決定します。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	Kintone から返されるページあたりの結果の最大数。
SubtableSeparatorCharacter	tablename + char + subtable 形式のサブテーブルからテーブルを分割するために使用される文字。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UseCodeForFieldName	フィールド名にLabel かCode のどちらを使用するかを決定します。
UseCursor	カーソルを使用してレコードを取得するかどうかを決定するboolean。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
UseSimpleNames	テーブルとカラムに簡略名を使用するかどうかを決定するboolean。
UseUnitForNumericField	フィールド名に単位を表示するかどうかを決定します。

特殊文字を許容するかどうかを決定します。True の場合、特殊文字は置き換えられません。

解説

特殊文字を許容するかどうかを決定します。True の場合、特殊文字は置き換えられません。

サブテーブルを取得するKintone アプリのカンマ区切りリスト。

解説

すべてのKintone アプリのサブテーブルを確認するには、このフィールドを* に設定します。サブテーブルを検索しない場合は、このフィールドを'None' に設定します。Kintone サブテーブルは別々のテーブルとして公開されており、API からすべてのサブテーブルのリストを取得するのは時間がかかります。この フィールドにいくつかのアプリ名のみを指定することで、Sync App のパフォーマンスが向上します。このフィールドを* に設定して、すべてのKintone アプリのサブテーブルを確認することもできますが、アプリ数が多い場合はテーブルをリストするにははるかに時間がかかります。

クエリ結果をゲストスペースに制限します。

解説

この接続プロパティは、クエリ結果を指定したゲストスペースに制限します。

GuestSpaceId は、Apps テーブルのSpaceId カラムにあるSync App で確認できます。あるいは、作成したスペースに移動するときにURL からGuestSpaceId を取得します。例えば、次のURL では、GuestSpaceId は"3" になります。

https://xlqc1.cybozu.com/k/guest/3/#/space/3/thread/3

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

解説

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

数値フィールドのデータ型をdecimal からdouble に変更するかどうかを決定します。

解説

数値フィールドのデータ型をdecimal からdouble に変更するかどうかを決定します。True に設定すると、データ型がdecimal からdouble に変更されます。

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

解説

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

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

統合およびフォーマット

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

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

解説

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

tablename + char + subtable 形式のサブテーブルからテーブルを分割するために使用される文字。

解説

アプリにサブテーブルがある場合、それは別のテーブルとして表示されます。名前は、AppName + SubtableSeparatorCharacter + SubtableName になります。 このプロパティを使用して、カスタム文字をセパレータとして設定し、アプリからサブテーブルを簡単に識別します。このプロパティを使用すると、 アプリの命名規則を破らずにサブテーブル名に異なる特殊文字を設定できます。

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

解説

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

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

フィールド名にLabel かCode のどちらを使用するかを決定します。

解説

true に設定すると、フィールド名にCode が使用されます。

カーソルを使用してレコードを取得するかどうかを決定するboolean。

解説

カーソルを使用してレコードを取得するかどうかを決定するboolean。

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

解説

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

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

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

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

次に例を示します。

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

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

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

指定されたパスは引用符で囲まれていないことに注意してください。

テーブルとカラムに簡略名を使用するかどうかを決定するboolean。

解説

Kintone テーブルおよびカラムでは、 通常のデータベースでは使うことが認められていない特殊記号・文字を名前に使うことができます。UseSimpleNames を使用すると、Sync App を従来のデータベースツールでより簡単に使用できるようになります。

UseSimpleNames をtrue に設定し、返されるテーブル名およびカラム名をシンプルにします。表示されるテーブル名 およびカラム名においてアルファベット文字およびアンダースコアのみを有効とするネーミングスキームを強制します。 英数字以外の文字はすべて、アンダースコアに変換されます。

フィールド名に単位を表示するかどうかを決定します。

解説

false を指定するとフィールド名に単位は表示されません。