Kintone への接続を追加

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

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

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

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

Kintone への接続

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

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

Kintone REST API

Kintone REST API に接続する場合は、Schema を"REST" に設定します。

Kintone REST API は、以下の認証スキームをサポートしています。

• パスワード認証
• API トークン
• OAuth 認証

Kintone USER API

Kintone USER API に接続する場合は、Schema を"USER" に設定します。

Kintone USER API は、以下の認証スキームをサポートしています。

• パスワード認証

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 パスワード。

OAuth 認証

ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。この認証を有効にするには、すべてのOAuth フローでAuthScheme をOAuth に設定し、カスタムOAuth アプリケーションを作成する必要があります。

Note： OAuth 認証はカーソルAPI をサポートしていません。OAuth は1万行以上の取得には推奨されません。

以下のサブセクションでは、3つの一般的な認証フローでのKintone への認証について詳しく説明します。 カスタムOAuth アプリケーションの作成については、カスタムOAuth アプリケーションの作成 を参照してください。 Kintone で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

OAuth アクセストークンの自動リフレッシュ：

Sync App がOAuth アクセストークンを自動的にリフレッシュするようにするには：

1. はじめてデータに接続する前に、次の接続パラメータを設定します。
   • InitiateOAuth：REFRESH。
   • OAuthClientId：カスタムOAuth アプリケーション設定のクライアントId。
   • OAuthClientSecret：カスタムOAuth アプリケーション設定のクライアントシークレット。
   • OAuthAccessToken：GetOAuthAccessToken によって返されたアクセストークン。
   • OAuthSettingsLocation：Sync App がOAuth 値を保存する場所のパス。これは接続間で維持されます。
   • UseCursor：FALSE。
2. その後のデータ接続では、以下を設定します。
   • InitiateOAuth
   • OAuthSettingsLocation

OAuth アクセストークンの手動リフレッシュ：

OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。

1. ExpiresIn 期間（GetOAuthAccessToken が返す）が経過した後にOAuthAccessToken を手動でリフレッシュするには、RefreshOAuthAccessToken ストアドプロシージャを呼び出します。
2. 次の接続プロパティを設定します。
   • OAuthClientId：カスタムOAuth アプリケーション設定のクライアントId。
   • OAuthClientSecret：カスタムOAuth アプリケーション設定のクライアントシークレット。

3. RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを設定します。
4. 新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定します。これで新規接続が開かれます。

OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

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

ユーザー定義ビュー

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

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

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

クエリ処理

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

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

ログ

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

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

REST API の使用

REST データモデルで利用可能なエンティティについては、REST データモデル を参照してください。

USER API の使用

USER データモデルで利用可能なエンティティについては、USER データモデル を参照してください。

Sync App は、Kintone REST 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
ActionSettings	kintone で利用可能なアクション設定を更新およびクエリします。
AppPermissions	kintone のアプリのアクセス権を更新およびクエリします。
Comments	kintone で利用可能なコメントをクエリします。
FieldPermissions	kintone の利用可能なフィールドのアクセス権の設定を更新およびクエリします。
FormFields	kintone のフォームフィールドを作成、更新、削除、クエリします。
FormLayout	kintone で利用可能なフォームのレイアウトを更新およびクエリします。
GeneralNotifications	kintone で利用可能なアプリの条件通知の設定を更新およびクエリします。
GeneralSettings	kintone の一般設定を更新およびクエリします。
GraphSettings	kintone の利用可能なグラフの設定を更新およびクエリします。
PerRecordNotifications	kintone の利用可能なレコードの条件通知の設定を更新およびクエリします。
ProcessManagement	kintone のプロセス管理を更新およびクエリします。
RecordPermissions	kintone の利用可能なレコードのアクセス権の設定を更新およびクエリします。
ReminderNotifications	kintone の利用可能なリマインダーの条件通知を更新およびクエリします。
SampleApp	サンプルアプリ：顧客管理（営業支援パック）
SampleApp_Table	サンプルアプリ：顧客管理（営業支援パック）明細テーブル
Space	kintone の利用可能なスペースを更新、削除、クエリします。
SpaceMembers	kintone の利用可能なスペースのメンバーを更新およびクエリします。
Views	kintone で利用可能な一覧の設定を更新およびクエリします。

kintone で利用可能なアクション設定を更新およびクエリします。

Select

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

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

SELECT * FROM ActionSettings WHERE AppId = 6
SELECT * FROM ActionSettings WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ActionSettings WHERE AppId = 6 AND IsPreview = false

Update

ActionSettings を更新するには、Actions を集計として指定します。ActionSettings を更新するには、AppId カラムが必須です。

UPDATE ActionSettings SET Actions = '{"Action_Z":{"name":"Action_A","index":"0"}}' WHERE AppId = 6

Columns

Name	Type	ReadOnly	References	Description
AppId	Integer	False		kintone アプリケーションのアプリID。
Id [KEY]	String	True		アクションID。
Index	String	False		アクションの並び順。0 から始まります。
Name	String	False		アクション名。
DestApp	String	False		コピー先のアプリのアプリID。
DestCode	String	False		コピー先のアプリのアプリコード。コピー先のアプリの設定でアプリコードが設定されていない場合は、空の文字列が返されます。
Mappings	String	False		フィールドの関連付けのオプションを含むオブジェクト配列。フィールドの関連付けが設定されていない場合は、空配列が返されます。
Entities	String	False		アクションが許可されているエンティティを含むオブジェクトの配列。これは「アクションの利用者」オプションを反映します。非アクティブユーザーおよび削除されたユーザー / 組織 / グループは、レスポンスに含まれません。
Revision	String	False		アプリの設定のリビジョン番号。

Pseudo-Columns

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

Name	Type	Description
Lang	String	取得する名称の言語。
IsPreview	Boolean	False に設定することで、運用環境のアプリのアクション設定の詳細を取得することができます。デフォルト値はtrue です。
Actions	String	Update の実行にのみ使用されます。

kintone のアプリのアクセス権を更新およびクエリします。

Select

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

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

SELECT * FROM AppPermissions WHERE AppId = 6
SELECT * FROM AppPermissions WHERE AppId = 6 AND IsPreview = false

Update

AppPermissions を更新するには、Rights を集計として指定します。AppPermissions を更新するには、AppId カラムとIsPreview カラムが必須です。

UPDATE AppPermissions SET Rights = '[{"entity":{"type":"CREATOR"},"appEditable":true,"recordViewable":true,"recordAddable":true,"recordEditable":true,"recordDeletable":true,"recordImportable":true,"recordExportable":true}]' WHERE AppId = 6 AND IsPreview = true

Columns

Name	Type	ReadOnly	References	Description
AppId [KEY]	Integer	False		kintone アプリケーションのアプリID。
EntityType [KEY]	String	False		アクセス権の設定対象の種類。
EntityCode	String	False		アクセス権の設定対象のコード。
IncludeSubs	Boolean	False		設定を下位組織に継承するかどうか。
AppEditable	Boolean	False		アプリの管理が可能かどうか。この権限を持つエンティティは、アプリの設定にアクセスして編集できます。
RecordViewable	Boolean	False		レコードの閲覧が可能かどうか。
RecordAddable	Boolean	False		レコードの追加が可能かどうか。
RecordEditable	Boolean	False		レコードの編集が可能かどうか。
RecordDeletable	Boolean	False		レコードの削除が可能かどうか。
RecordImportable	Boolean	False		ファイルの読み込みが可能かどうか。
RecordExportable	Boolean	False		ファイルの書き出しが可能かどうか。
Revision	String	True		アプリの設定のリビジョン番号。

Pseudo-Columns

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

Name	Type	Description
IsPreview	Boolean	False に設定することで、運用環境のアプリのアクセス権の設定の詳細を取得することができます。デフォルト値はtrue です。
Rights	String	Update の実行にのみ使用されます。

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 の利用可能なフィールドのアクセス権の設定を更新およびクエリします。

Select

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

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

SELECT * FROM FieldPermissions WHERE AppId = 6
SELECT * FROM FieldPermissions WHERE AppId = 6 AND IsPreview = false

Update

FieldPermissions を更新するには、Rights を集計として指定します。FieldPermissions を更新するには、AppId カラムとIsPreview カラムが必須です。

UPDATE FieldPermissions SET Rights = 'Update FieldPermissions set Rights='[{"code":"Updated_by","entities":[{"accessibility":"READ","entity":{"type":"GROUP","code":"everyone"}}]}]' WHERE AppId = 6 AND IsPreview = true

Columns

Name	Type	ReadOnly	References	Description
AppId [KEY]	Integer	False		kintone アプリケーションのアプリID。
Code [KEY]	String	False		アクセス権を設定するフィールドコード。
Entities	String	False		アクセス権の設定対象の一覧を、優先度の高い順に並べた配列。
Revision	String	True		アプリの設定のリビジョン番号。

Pseudo-Columns

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

Name	Type	Description
IsPreview	Boolean	False に設定することで、運用環境のアプリのFieldPermissions の詳細を取得することができます。デフォルト値はtrue です。
Rights	String	Update の実行にのみ使用されます。

kintone のフォームフィールドを作成、更新、削除、クエリします。

Select

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

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

SELECT * FROM FormFields WHERE AppId = 6
SELECT * FROM FormFields WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM FormFields WHERE AppId = 6 AND IsPreview = false

Insert

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

INSERT INTO FormFields (AppId, Type, Code, Label) VALUES (6, 'SINGLE_LINE_TEXT', 'Text__single_line_CRUD', 'Test')

挿入は、AppId カラムとProperties カラムをjson 集計として指定することでも実行できます。

INSERT INTO FormFields (AppId, Properties) VALUES (6, '{"Text__single_line_TD":{"type":"SINGLE_LINE_TEXT","code":"Text__single_line_TD","label":"Test"}}')

Kintone API はBulk Insert もサポートしています。

INSERT INTO FormFields#TEMP (AppId, Type, Code, Label) VALUES (6, 'SINGLE_LINE_TEXT', 'Text__single_line_temp1', 'Label1')
INSERT INTO FormFields#TEMP (AppId, Type, Code, Label) VALUES (6, 'SINGLE_LINE_TEXT', 'Text__single_line_temp2', 'Label2')
INSERT INTO FormFields (AppId, Type, Code, Label) SELECT AppId, Type, Code, Label FROM FormFields#TEMP

Update

FormFields を更新するには、Properties を集計として指定します。FormFields を更新するには、AppId カラムが必須です。

UPDATE FormFields SET Properties = '{"Text__single_line_TT":{"code":"Text__single_line_PT","label":"text","type":"SINGLE_LINE_TEXT"}}' WHERE AppId = 6

Delete

削除したいCode カラムの値をカンマ区切りで指定する必要があります。FormFields を削除するには、AppId カラムが必須です。

DELETE FROM FormFields WHERE Code = 'Text__single_line_CRUD, Text__single_line_TD' AND AppId = 6

Columns

Name	Type	ReadOnly	References	Description
AppId [KEY]	Integer	False		kintone アプリケーションのアプリID。
Code [KEY]	String	False		フィールドコード。
Enabled	String	True		機能が有効かどうか。
Label	String	False		フィールド名。
NoLabel	Boolean	False		フィールド名を非表示にするかどうか。
Type	String	False		フィールドの種類。
Required	String	False		入力が必須かどうか。
Unique	String	False		重複を禁止するかどうか。
MaxValue	String	False		フィールドの最大値。
MinValue	String	False		フィールドの最小値。
MaxLength	String	False		フィールドの最大文字数。
MinLength	String	False		フィールドの最小文字数。
DefaultValue	String	False		初期値。複数の初期値を設定できるフィールドでは、配列が返ります。
DefaultNowValue	String	False		レコード登録時の日時を初期値にするかどうか。
Options	String	False		フィールドの選択肢のデータを含むオブジェクト。
Align	String	False		選択肢の並び。
Expression	String	False		自動計算式。
HideExpression	String	False		計算フィールドの計算式を非表示にするかどうか。
Digit	String	False		数値の桁区切りを表示するかどうか。
ThumbnailSize	String	False		画像のサムネイルの大きさ（ピクセル単位）。
Protocol	String	False		フィールドのリンクの種類。
Format	String	False		計算フィールドの表示形式。
DisplayScale	String	False		小数点以下の表示桁数。
Unit	String	False		単位記号。
UnitPosition	String	False		単位記号の表示位置。
Entities	String	False		選択肢のユーザーの一覧の配列。
ReferenceTable	String	False		関連レコード一覧フィールドの設定を含むオブジェクト。
LookUp	String	False		ルックアップフィールドの設定を含むオブジェクト。
OpenGroup	String	False		グループ内のフィールドを表示するかどうか。
Fields	String	False		テーブル内のフィールドのデータを含むオブジェクト。オブジェクトの構造は、properties と同じです。
Revision	String	True		アプリの設定のリビジョン番号。

Pseudo-Columns

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

Name	Type	Description
Lang	String	取得する名称の言語。
IsPreview	Boolean	False に設定することで、運用環境のアプリのフォームフィールドの詳細を取得することができます。デフォルト値はtrue です。
Properties	String	Insert またはUpdate の実行にのみ使用されます。

kintone で利用可能なフォームのレイアウトを更新およびクエリします。

Select

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

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

SELECT * FROM FormLayout WHERE AppId = 6
SELECT * FROM FormLayout WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM FormLayout WHERE AppId = 6 AND IsPreview = false

Update

FormLayout を更新するには、Layout を集計として指定します。フォームのすべてのフィールドは集計で指定される必要があります。FormLayout を更新するには、AppId カラムが必須です。

UPDATE FormLayout SET Layout = '[{"type":"ROW","fields":[{"type":"SPACER","code":"Table_0","size":{"width":"200"}}]}]' WHERE AppId = 6

Columns

Name	Type	ReadOnly	References	Description
AppId [KEY]	Integer	False		kintone アプリケーションのアプリID。
Fields	String	False		行に含まれるフィールドの一覧。
Type	String	False		フィールドの種類。 使用できる値は次のとおりです。ROW, SUBTABLE, GROUP
Code	String	False		テーブル、またはグループのフィールドコード。テーブル、グループ以外の行では、このパラメータは返されません。
Revision	String	True		アプリの設定のリビジョン番号。

Pseudo-Columns

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

Name	Type	Description
IsPreview	Boolean	False に設定することで、運用環境のアプリのフォームのレイアウトの詳細を取得することができます。デフォルト値はtrue です。
Layout	String	Insert またはUpdate の実行にのみ使用されます。

kintone で利用可能なアプリの条件通知の設定を更新およびクエリします。

Select

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

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

SELECT * FROM GeneralNotifications WHERE AppId = 6
SELECT * FROM GeneralNotifications WHERE AppId = 6 AND IsPreview = false

Update

GeneralNotifications を更新するには、Notifications を集計として指定します。GeneralNotifications を更新するには、AppId カラムが必須です。

UPDATE GeneralNotifications SET Notifications = '[{"entity":{"type":"FIELD_ENTITY","code":"Updated_by"},"includeSubs":false,"recordAdded":false,"commentAdded":true}],"notifyToCommenter":true' WHERE AppId = 6

Columns

Name	Type	ReadOnly	References	Description
AppId [KEY]	Integer	False		kintone アプリケーションのアプリID。
EntityType	String	False		条件通知の設定対象のエンティティの種類。
EntityCode [KEY]	String	False		条件通知の設定対象のエンティティのコード。
IncludeSubs	Boolean	False		設定を下位組織に継承するかどうか。notifications[].entity.type の値が「ORGANIZATION」または「FIELD_ENTITY」 で組織選択フィールドが指定されている場合以外はfalse が返ります。
RecordAdded	Boolean	False		レコード追加で通知するかどうか。
RecordEdited	Boolean	False		レコード編集で通知するかどうか。
CommentAdded	Boolean	False		コメントの書き込みで通知するかどうか。
StatusChanged	Boolean	False		ステータスの更新で通知するかどうか。
FileImported	Boolean	False		ファイル読み込みで通知するかどうか。
NotifyToCommenter	Boolean	False		コメントを書き込んだユーザーが、そのレコードにコメントが書き込まれたときに通知を受信するかどうか。これは、「コメントを書き込んだユーザーは、そのレコードにコメントが書き込まれたときに通知を受信する」チェックボックスを反映します。
Revision	String	True		アプリの設定のリビジョン番号。

Pseudo-Columns

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

Name	Type	Description
IsPreview	Boolean	False に設定することで、運用環境のアプリのGeneralNotifications の詳細を取得することができます。デフォルト値はtrue です。
Notifications	String	Update の実行にのみ使用されます。

kintone の一般設定を更新およびクエリします。

Select

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

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

SELECT * FROM GeneralSettings WHERE AppId = 6
SELECT * FROM GeneralSettings WHERE AppId = 6 AND IsPreview = false

Update

更新するGeneralSetting の AppId とIconKey を指定する必要があります。

UPDATE GeneralSettings SET Name = 'UpdatedName', Description = 'Test Description', IconType = 'PRESET', IconKey = 'APP72' WHERE IconKey = 'APP72' AND AppId = 6

Columns

Name	Type	ReadOnly	References	Description
AppId [KEY]	Integer	True		kintone アプリケーションのアプリID。
IconKey [KEY]	String	False		アイコンのキー（識別子）。kintone の組込みアイコンを使用している場合に出力されます。
IconType	String	False		アイコンの種類：FILE、PRESET。
IconFile	String	False		アイコンの種類：FILE、PRESET。
Name	String	False		アプリ名。
Description	String	False		アプリの説明。HTML 形式で出力されます。
Theme	String	False		デザインテーマ。
Revision	String	True		アプリの設定のリビジョン番号。

Pseudo-Columns

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

Name	Type	Description
Lang	String	取得する名称の言語。
IsPreview	Boolean	False に設定することで、運用環境のアプリの一般設定の詳細を取得することができます。デフォルト値はtrue です。

kintone の利用可能なグラフの設定を更新およびクエリします。

Select

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

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

SELECT * FROM GraphSettings WHERE AppId = 6
SELECT * FROM GraphSettings WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM GraphSettings WHERE AppId = 6 AND IsPreview = false

Update

GraphSettings を更新するには、Reports を集計として指定します。GraphSettings を更新するには、AppId カラムが必須です。

UPDATE GraphSettings SET Reports = '{"Graph1":{"chartType":"BAR","chartMode":"PERCENTAGE","name":"Updated_Graph_Name","index":"0","groups":[{"code":"Created_by"}]}}' WHERE AppId = 6

Columns

Name	Type	ReadOnly	References	Description
AppId	Integer	False		kintone アプリケーションのアプリID。
Id [KEY]	String	True		グラフID。
Index	String	False		グラフの並び順。0 から始まります。
Name	String	False		グラフ名。64 文字以下で指定します。lang を指定した場合は、API を実行するユーザーの表示言語の名称が返ります。
PeriodicReport	String	False		定期レポートオプションを含むオブジェクト。定期レポートが設定されていない場合は「null」が返ります。
Sorts	String	False		ソートオプションを含むオブジェクトの配列。
Aggregations	String	False		集計方法の種類。
ChartMode	String	False		グラフの表示モード。
ChartType	String	False		グラフの種類。
FilterCond	String	False		絞り込み条件。クエリ形式で指定します。
Groups	String	False		集計方法の種類。
Revision	String	True		アプリの設定のリビジョン番号。

Pseudo-Columns

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

Name	Type	Description
Lang	String	取得する名称の言語。
IsPreview	Boolean	False に設定することで、運用環境のアプリのグラフの設定の詳細を取得することができます。デフォルト値はtrue です。
Reports	String	Update の実行にのみ使用されます。

kintone の利用可能なレコードの条件通知の設定を更新およびクエリします。

Select

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

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

SELECT * FROM PerRecordNotifications WHERE AppId = 6
SELECT * FROM PerRecordNotifications WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM PerRecordNotifications WHERE AppId = 6 AND IsPreview = false

Update

PerRecordNotifications を更新するには、Notifications を集計として指定します。PerRecordNotifications を更新するには、AppId カラムが必須です。

UPDATE PerRecordNotifications SET Notifications = '[{"filterCond":"Record_number = 18","title":"Test Title","targets":[{"entity":{"type":"FIELD_ENTITY","code":"Created_by"},"includeSubs":false}]}]' WHERE AppId = 6

Columns

Name	Type	ReadOnly	References	Description
AppId [KEY]	Integer	False		kintone アプリケーションのアプリID。
FilterCond	String	False		レコードの条件。クエリ形式で表されます。
Title [KEY]	String	False		通知内容。
Targets	String	False		通知先の対象の一覧。
Revision	String	True		アプリの設定のリビジョン番号。

Pseudo-Columns

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

Name	Type	Description
Lang	String	取得する名称の言語。
IsPreview	Boolean	False に設定することで、運用環境のアプリのPerRecordNotifications の詳細を取得することができます。デフォルト値はtrue です。
Notifications	String	Update の実行にのみ使用されます。

kintone のプロセス管理を更新およびクエリします。

Select

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

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

SELECT * FROM ProcessManagement WHERE AppId = 6
SELECT * FROM ProcessManagement WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ProcessManagement WHERE AppId = 6 AND IsPreview = false

Update

ProcessManagement を更新するには、States とActions を集計として指定します。ProcessManagement を更新するには、AppId カラムが必須です。

UPDATE ProcessManagement SET Enable = true, States = '{"In progress":{"name":"In progress","index":"1","assignee":{"type":"ONE","entities":[]}},"Ready":{"name":"Ready","index":"3","assignee":{"type":"ONE","entities":[]}},"Completed":{"name":"Completed","index":"2","assignee":{"type":"ONE","entities":[]}},"Not started":{"name":"Not started","index":"0","assignee":{"type":"ONE","entities":[{"entity":{"type":"FIELD_ENTITY","code":"Created_by"},"includeSubs":false}]}}}', Actions = '[{"name":"Start","from":"Not started","to":"In progress","filterCond":""},{"name":"Complete","from":"Completed","to":"Completed","filterCond":""}]' WHERE AppId = 6

Columns

Name	Type	ReadOnly	References	Description
AppId [KEY]	Integer	False		kintone アプリケーションのアプリID。
Enable	Boolean	False		プロセス管理が有効かどうか。
Actions	String	False		アクションの情報の一覧。並び順はGUI と同じです。プロセス管理を一度も設定していないアプリの場合は「null」が返ります。
Revision	String	True		アプリの設定のリビジョン番号。
Name	String	False		ステータス名。
Index	String	False		ステータスの順番。昇順で並べ替えられます。
AssigneeType	String	False		ステータスの作業者のタイプ。
AssigneeEntities	String	False		ステータスの作業者の一覧。並び順はGUI と同じです。

Pseudo-Columns

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

Name	Type	Description
Lang	String	取得する名称の言語。
IsPreview	Boolean	False に設定することで、運用環境のアプリのProcess Management の詳細を取得することができます。デフォルト値はtrue です。
States	String	Update の実行にのみ使用されます。

kintone の利用可能なレコードのアクセス権の設定を更新およびクエリします。

Select

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

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

SELECT * FROM RecordPermissions WHERE AppId = 6
SELECT * FROM RecordPermissions WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM RecordPermissions WHERE AppId = 6 AND IsPreview = false

Update

RecordPermissions を更新するには、Rights を集計として指定します。RecordPermissions を更新するには、AppId カラムとIsPreview カラムが必須です。

UPDATE RecordPermissions SET Rights = '[{"filterCond":"","entities":[{"entity":{"type":"GROUP","code":"everyone"},"viewable":false,"editable":false,"deletable":false,"includeSubs":true}]}]' WHERE AppId = 6 AND IsPreview = true

Columns

Name	Type	ReadOnly	References	Description
AppId [KEY]	Integer	False		kintone アプリケーションのアプリID。
FilterCond	String	False		レコードのアクセス権の設定の一覧。
Entities	String	False		アクセス権の設定対象の一覧を、優先度の高い順に並べた配列。
Revision	String	False		アプリの設定のリビジョン番号。

Pseudo-Columns

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

Name	Type	Description
Lang	String	取得する名称の言語。
IsPreview	Boolean	False に設定することで、運用環境のアプリのRecordPermissions の詳細を取得することができます。デフォルト値はtrue です。
Rights	String	Update の実行にのみ使用されます。

kintone の利用可能なリマインダーの条件通知を更新およびクエリします。

Select

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

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

SELECT * FROM ReminderNotifications WHERE AppId = 6
SELECT * FROM ReminderNotifications WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ReminderNotifications WHERE AppId = 6 AND IsPreview = false

Update

ReminderNotifications を更新するには、Notifications を集計として指定します。ReminderNotifications を更新するには、AppId カラムが必須です。

UPDATE ReminderNotifications SET Notifications = '[{"timing":{"code":"Updated_datetime","daysLater":-2,"hoursLater":-5},"filterCond":"Record_number = 14","title":"Reminder: Tomorrow is the deadline.","targets":[{"entity":{"type":"FIELD_ENTITY","code":"Created_by"},"includeSubs":false}]}]' WHERE AppId = 6

Columns

Name	Type	ReadOnly	References	Description
AppId [KEY]	Integer	False		kintone アプリケーションのアプリID。
FilterCond	String	False		リマインダーの条件通知を行う条件。クエリ形式で表されます。
Title	String	False		リマインダーの条件通知で通知される内容。
TimingCode [KEY]	String	False		通知のタイミングの基準日時となるフィールドのフィールドコード。
TimingDaysLater	Integer	False		基準日時notifications[].timing.code date/datetime から何日前または何日後に通知するか。基準日時より前に通知する場合は、負の整数が返ります。
TimingHoursLater	Integer	False		基準日時notifications[].timing.code datetime に timing.daysLater を足した日時から、何時間後または何時間前に通知するか。
TimingTime	String	False		基準日時にtiming.daysLater を足した日付から、いつ通知するか。このパラメータは、notifications[].timing.code パラメータに日付フィールドを設定しているか、notifications[].timing.code に日時を表すフィールドを指定し「絶対時刻を指定」が設定されている場合に返されます。
Targets	String	False		リマインダーの通知先の対象の一覧。
Revision	String	True		アプリの設定のリビジョン番号。
Timezone	String	False		リマインドする時刻のタイムゾーン。「リマインド時刻のタイムゾーン」ドロップダウンオプションを反映します。リマインダーの条件通知を一度も設定していないアプリでは「null」が返ります。

Pseudo-Columns

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

Name	Type	Description
Lang	String	取得する名称の言語。
IsPreview	Boolean	False に設定することで、運用環境のアプリのReminder Notifications の詳細を取得することができます。デフォルト値はtrue です。
Notifications	String	Update の実行にのみ使用されます。

サンプルアプリ：顧客管理（営業支援パック）

Columns

Name	Type	ReadOnly	References	Description
RecordId	Int	True		サンプル：レコードID
Revision	Int	True		サンプル：Revision
AppId	Int	True		サンプル：アプリID
備考	String	True		サンプル：備考
更新者 Code	String	True		サンプル：更新者 Code
更新者 Name	String	True		サンプル：更新者 Name
作成者 Code	String	True		サンプル：作成者 Code
作成者 Name	String	True		サンプル：作成者 Name
郵便番号	String	True		サンプル：郵便番号
部署名	String	True		サンプル：部署名
メールアドレス	String	True		サンプル：メールアドレス
担当者名	String	True		サンプル：担当者名
更新日時	Datetime	True		サンプル：更新日時
顧客名	String	True		サンプル：顧客名
住所	String	True		サンプル：住所
TEL	String	True		サンプル：TEL
FAX	String	True		サンプル：FAX
作成日時	Datetime	True		サンプル：作成日時

サンプルアプリ：顧客管理（営業支援パック）明細テーブル

Columns

Name	Type	ReadOnly	References	Description
顧客管理（営業支援パック）Id	Int	True		サンプル：顧客管理（営業支援パック）Id
Id	Int	True		サンプル：Id
Revision	Int	True		サンプル：Revision
AppId	Int	True		サンプル：アプリID
案件名	String	True		サンプル：案件名
確度	String	True		サンプル：確度
受注予定日	Datetime	True		サンプル：受注予定日
合計費用	Double	True		サンプル：合計費用
商談担当者 Aggregate	String	True		サンプル：商談担当者 Aggregate

kintone の利用可能なスペースを更新、削除、クエリします。

Select

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

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

SELECT * FROM Space WHERE Id = 7

Insert

INSERT ステートメントでは、SpaceTemplateID、Name、Members カラムが必須です。

INSERT INTO Space(SpaceTemplateID, Name, Members) Values(1, 'New_Space', '[{"entity":{"type":"USER","code":"[email protected]"},"isAdmin":true}]')

Update

Space を更新するには、Id カラムが必須です。

UPDATE Space SET body='Space Body' WHERE Id = 16

Delete

Space を削除するには、Id カラムが必須です。

DELETE FROM Space WHERE Id = 16

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		スペースID。
Name	String	False		スペース名。
DefaultThread	String	False		スペースが作成されたときに初期作成されたスレッドのスレッドID。
IsPrivate	Boolean	False		公開 / 非公開の区分。
CreatorCode	String	False		作成者のコード。停止中または削除済みユーザーの場合は、空文字列が返ります。
CreatorName	String	False		作成者の名前。停止中または削除済みユーザーの場合は、空文字列が返ります。
ModifierCode	String	False		更新者のコード。停止中または削除済みユーザーの場合は、空文字列が返ります。
ModifierName	String	False		更新者の名前。停止中または削除済みユーザーの場合は、空文字列が返ります。
MemberCount	String	False		スペースのメンバー数。
CoverType	String	False		スペースのカバー画像の種類。
CoverKey	String	False		スペースのカバー画像のキー文字列。
CoverUrl	String	False		スペースのカバー画像のURL。
Body	String	False		スペースの本文（HTML）。スペース本文のHTML が空の場合null が返ります。ただし、一度でも本文を設定したことがあるスペースの場合、画面上では何も表示されていなくても、HTML タグのみが設定されている可能性があります。その場合、それらの文字列が返ります。
UseMultiThread	Boolean	False		「スペースのポータルと複数のスレッドを使用する」が有効のスペースかどうか。
IsGuest	Boolean	False		ゲストスペースかどうか。
FixedMember	Boolean	False
AttachedApps	String	False		スレッド内アプリのリスト。公開前のアプリは含みません。設定完了していない項目も反映されません。
ShowAnnouncement	Boolean	False		「スペースのポータルと複数のスレッドを使用する」が有効のスペースのポータルの「お知らせ」の表示状態。
ShowThreadList	Boolean	False		「スペースのポータルと複数のスレッドを使用する」が有効のスペースのポータルの「スレッド一覧」の表示状態。
ShowAppList	Boolean	False		「スペースのポータルと複数のスレッドを使用する」が有効のスペースのポータルの「アプリ一覧」の表示状態。
ShowMemberList	Boolean	False		「スペースのポータルと複数のスレッドを使用する」が有効のスペースのポータルの「ピープル一覧」の表示状態。
ShowRelatedLinkList	Boolean	False		「スペースのポータルと複数のスレッドを使用する」が有効のスペースのポータルの「関連リンク一覧」の表示状態。

Pseudo-Columns

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

Name	Type	Description
SpaceTemplateID	String	スペースのテンプレートID。新しいスペースを作成する際に必須です。
Members	String	スペースのメンバーの情報の一覧。新しいスペースを作成する際に必須です。少なくとも1人のスペース管理者を指定する必要があります。使用停止中のユーザーおよび削除したユーザーは指定できません。

kintone の利用可能なスペースのメンバーを更新およびクエリします。

Select

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

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

SELECT * FROM SpaceMembers WHERE Id = 1

Update

SpaceMembers を更新するには、Members カラムを集計として指定します。SpaceMembers を更新するには、Id カラムが必須です。

UPDATE SpaceMembers SET Members='[{"entity":{"type":"USER","code":"[email protected]"},"isAdmin":true}]' WHERE Id = 1

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		スペースID。
EntityCode	String	False		スペースのメンバーのコード。
EntityType	String	False		スペースのメンバーの種類。
IsAdmin	Boolean	False		スペースのメンバーがスペース管理者かどうか。
IsImplicit	Boolean	False		スペースのメンバーユーザーとして追加されているかどうか。
IncludeSubs	Boolean	False		下位組織を含むかどうか。

Pseudo-Columns

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

Name	Type	Description
Members	String	スペースのメンバーの情報の一覧。新しいスペースを作成する際に必須です。少なくとも1人のスペース管理者を指定する必要があります。使用停止中のユーザーおよび削除したユーザーは指定できません。

kintone で利用可能な一覧の設定を更新およびクエリします。

Select

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

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

SELECT * FROM Views WHERE AppId = 6
SELECT * FROM Views WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM Views WHERE AppId = 6 AND IsPreview = false

Update

Views を更新するには、Views を集計として指定します。集計に記載されていないビュー名は削除されます。Views を更新するには、AppId カラムが必須です。

UPDATE VIEWS SET Views = '{"(Assigned to me)":{"index":0,"type":"LIST","name":"(Assigned to me)","filterCond":"Assignee in (LOGINUSER())","sort":"Record_number asc"},"subTableTest2":{"index":1,"type":"CALENDAR","name":"subTableTest","date":"Updated_datetime","filterCond":"","sort":"Record_number asc"}}' WHERE AppId = 6

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		一覧のID。
AppId	Integer	False		kintone アプリケーションのアプリID。
Index	String	False		一覧の表示順（昇順）。
Name	String	False		一覧名。
Title	String	False		タイトルとして使用するフィールドのフィールドコード。一覧の表示形式が「CALENDAR」の場合に返ります。
Type	String	False		一覧の表示形式。 使用できる値は次のとおりです。LIST, CALENDAR, CUSTOM
BuiltinType	String	False		一覧名が「（作業者が自分）」の場合のみ出力されるプロパティ。「ASSIGNEE」が返ります。
Date	String	False		日付として使用するフィールドのフィールドコード。一覧の表示形式が「CALENDAR」の場合に返ります。
Fields	String	False		表示するフィールドのフィールドコードの一覧。
FilterCond	String	False		レコードの絞り込み条件。クエリ形式で表されます。
Html	String	False		カスタマイズに使用するHTML の内容。一覧の表示形式が「CUSTOM」の場合に返ります。
Pager	Boolean	False		ページネーションを表示するかどうか。一覧の表示形式が「CUSTOM」の場合に返ります。
Device	String	False		一覧を表示する範囲。
Sort	String	False		レコードのソート条件。クエリ形式で表されます。
Revision	String	True		アプリの設定のリビジョン番号。

Pseudo-Columns

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

Name	Type	Description
Lang	String	取得する名称の言語。
IsPreview	Boolean	False に設定することで、運用環境のアプリのViews の詳細を取得することができます。デフォルト値はtrue です。
Views	String	Update の実行にのみ使用されます。

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

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

Kintone Connector for CData Sync ビュー

Name	Description
ActionSettingsEntities	kintone で利用可能なアクション設定のアクションを利用するメンバーの一覧をクエリします。
ActionSettingsMappings	kintone で利用可能なアクション設定のフィールドの関連付けの一覧をクエリします。
Apps	kintone で利用可能なアプリをクエリします。
FieldPermissionsEntities	kintone のフィールドのアクセス権の設定の対象をクエリします。
FormLayoutFields	kintone で利用可能なフォームのレイアウトの行に含まれるフィールドの一覧をクエリします。
PerRecordNotificationsTargets	kintone のレコードの条件通知先の対象をクエリします。
ProcessManagementActions	kintone のプロセス管理のアクションの情報の一覧をクエリします。
RecordPermissionsEntities	kintone の利用可能なレコードのアクセス権の設定の対象をクエリします。
ReminderNotificationsTargets	kintone の利用可能なリマインダーの条件通知先の対象の一覧をクエリします。

kintone で利用可能なアクション設定のアクションを利用するメンバーの一覧をクエリします。

Select

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

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

SELECT * FROM ActionSettingsEntities WHERE AppId = 6
SELECT * FROM ActionSettingsEntities WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ActionSettingsEntities WHERE AppId = 6 AND IsPreview = false

Columns

Name	Type	References	Description
AppId	Integer		kintone アプリケーションのアプリID。
Id	String		アクションID。
Code	String		アクションが許可されているエンティティのコード。ゲストユーザーの場合、ログイン名の頭に「guest/」が付きます。
Type	String		アクションが許可されているエンティティの種類。 使用できる値は次のとおりです。USER, GROUP, ORGANIZATION
Revision	String		アプリの設定のリビジョン番号。

Pseudo-Columns

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

Name	Type	Description
Lang	String		取得する名称の言語。
IsPreview	Boolean		False に設定することで、運用環境のアプリのアクション設定の詳細を取得することができます。デフォルト値はtrue です。

kintone で利用可能なアクション設定のフィールドの関連付けの一覧をクエリします。

Select

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

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

SELECT * FROM ActionSettingsMappings WHERE AppId = 6
SELECT * FROM ActionSettingsMappings WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ActionSettingsMappings WHERE AppId = 6 AND IsPreview = false

Columns

Name	Type	References	Description
AppId	Integer		kintone アプリケーションのアプリID。
Id	String		アクションID。
SrcType	String		コピー元の種類。 使用できる値は次のとおりです。FIELD, RECORD_URL
SrcField	String		「フィールドの関連付け」オプションでコピー元に指定されたフィールドのフィールドコード。このパラメータは、actions.{actionname}.mappings[].srcType パラメータがFIELD に設定されている場合にのみ返されます。
DestField	String		「フィールドの関連付け」オプションでコピー先に指定されたフィールドのフィールドコード。
Revision	String		アプリの設定のリビジョン番号。

Pseudo-Columns

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

Name	Type	Description
Lang	String		取得する名称の言語。
IsPreview	Boolean		False に設定することで、運用環境のアプリのアクション設定の詳細を取得することができます。デフォルト値はtrue です。

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		アプリのエイリアス名。

kintone のフィールドのアクセス権の設定の対象をクエリします。

Select

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

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

SELECT * FROM FieldPermissionsEntities WHERE AppId = 6
SELECT * FROM FieldPermissionsEntities WHERE AppId = 6 AND IsPreview = false

Columns

Name	Type	References	Description
AppId [KEY]	Integer		アプリケーションのアプリID。
Code [KEY]	String		アクセス権を設定するフィールドコード。
EntityType	String		アクセス権の設定対象の種類。
EntityCode	String		アクセス権の設定対象のコード。
Accessibility	String		フィールドに対して可能な操作。 使用できる値は次のとおりです。READ, WRITE, NONE
IncludeSubs	Boolean		設定を下位組織に継承するかどうか。

Pseudo-Columns

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

Name	Type	Description
IsPreview	Boolean		False に設定することで、運用環境のアプリのFieldPermissions の詳細を取得することができます。デフォルト値はtrue です。

kintone で利用可能なフォームのレイアウトの行に含まれるフィールドの一覧をクエリします。

Select

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

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

SELECT * FROM FormLayoutFields WHERE AppId = 6
SELECT * FROM FormLayoutFields WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM FormLayoutFields WHERE AppId = 6 AND IsPreview = false

Columns

Name	Type	References	Description
AppId	Integer		kintone アプリケーションのアプリID。
Code	String		フィールドコード。
Type	String		フィールドの種類。
ElementId	String		スペースフィールドの要素ID。スペースフィールドでのみ出力されます。
Label	String		ラベル名。ラベルフィールドでのみ出力されます。
Width	String		ピクセル単位でのフィールドの横幅。
Height	String		フィールド名を含めた、ピクセル単位でのフィールドの縦幅。
InnerHeight	String		フィールド名を除いた、ピクセル単位でのフィールドの縦幅。

Pseudo-Columns

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

Name	Type	Description
IsPreview	Boolean		False に設定することで、運用環境のアプリのフォームのレイアウトの詳細を取得することができます。デフォルト値はtrue です。

kintone のレコードの条件通知先の対象をクエリします。

Select

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

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

SELECT * FROM PerRecordNotificationsTargets WHERE AppId = 6
SELECT * FROM PerRecordNotificationsTargets WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM PerRecordNotificationsTargets WHERE AppId = 6 AND IsPreview = false

Columns

Name	Type	References	Description
AppId	Integer		kintone アプリケーションのアプリID。
Title	String		通知内容。
EntityType	String		通知先の対象の種類。
EntityCode	String		通知先の対象のコード。
IncludeSubs	Boolean		設定を下位組織に継承するかどうか。

Pseudo-Columns

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

Name	Type	Description
Lang	String		取得する名称の言語。
IsPreview	Boolean		False に設定することで、運用環境のアプリのPerRecord Notifications Targets の詳細を取得することができます。デフォルト値はtrue です。

kintone のプロセス管理のアクションの情報の一覧をクエリします。

Select

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

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

SELECT * FROM ProcessManagementActions WHERE AppId = 6
SELECT * FROM ProcessManagementActions WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ProcessManagementActions WHERE AppId = 6 AND IsPreview = false

Columns

Name	Type	References	Description
AppId	Integer		kintone アプリケーションのアプリID。
Name	String		アクションの名前。
From	String		アクション実行前のステータス名。
To	String		アクション実行後のステータス名。
FilterCond	String		アクションの実行条件。

Pseudo-Columns

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

Name	Type	Description
Lang	String		取得する名称の言語。
IsPreview	Boolean		False に設定することで、運用環境のアプリのProcess Management Actions の詳細を取得することができます。デフォルト値はtrue です。

kintone の利用可能なレコードのアクセス権の設定の対象をクエリします。

Select

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

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

SELECT * FROM RecordPermissionsEntities WHERE AppId = 6
SELECT * FROM RecordPermissionsEntities WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM RecordPermissionsEntities WHERE AppId = 6 AND IsPreview = false

Columns

Name	Type	References	Description
AppId	Integer		kintone アプリケーションのアプリID。
FilterCond	String		レコードのアクセス権の設定の一覧。
EntityType	String		アクセス権の設定対象の種類。
EntityCode	String		アクセス権の設定対象のコード。
Viewable	Boolean		レコードの閲覧が可能かどうか。
Editable	Boolean		レコードの編集が可能かどうか。
Deletable	Boolean		レコードの削除が可能かどうか。
IncludeSubs	Boolean		設定を下位組織に継承するか。

Pseudo-Columns

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

Name	Type	Description
Lang	String		取得する名称の言語。
IsPreview	Boolean		False に設定することで、運用環境のアプリのRecord Permissions Entities の詳細を取得することができます。デフォルト値はtrue です。

kintone の利用可能なリマインダーの条件通知先の対象の一覧をクエリします。

Select

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

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

SELECT * FROM ReminderNotificationsTargets WHERE AppId = 6
SELECT * FROM ReminderNotificationsTargets WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ReminderNotificationsTargets WHERE AppId = 6 AND IsPreview = false

Columns

Name	Type	References	Description
AppId [KEY]	Integer		アプリケーションのアプリID。
TimingCode [KEY]	String		通知のタイミングの基準日時となるフィールドのフィールドコード。
EntityType	String		リマインダーの通知先の対象の種類。
EntityCode	String		リマインダーの通知先の対象のコード。
IncludeSubs	Boolean		設定を下位組織に継承するかどうか。entity.type が「ORGANIZATION」か、「FIELD_ENTITY」で組織選択フィールドが指定されている場合のみ「false」が返ります。

Pseudo-Columns

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

Name	Type	Description
Lang	String		取得する名称の言語。
IsPreview	Boolean		False に設定することで、運用環境のアプリのReminder Notifications Targets の詳細を取得することができます。デフォルト値はtrue です。

Sync App はKintone USER API をリレーショナルビューとしてモデル化します。

ビュー

Sync App は、User、UserGroups、UserDepartments の情報をビューにモデル化します。

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

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

Kintone Connector for CData Sync ビュー

Name	Description
UserDepartments	Gets information of Departments that a User belongs to, and Job Title information related to the Department.
UserGroups	Gets information of Groups that a User belongs to.
Users	Gets information of users.

Gets information of Departments that a User belongs to, and Job Title information related to the Department.

Select

WHERE 句では、UserCode カラムが必須です。Sync App はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Sync App はクライアント側でSync App 内で他のフィルタを処理します。

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

SELECT * FROM UserDepartments where UserCode = 'loginname';

Columns

Name	Type	References	Description
OrganizationId [KEY]	Long		The ID of the Department.
TitleId [KEY]	Long		The ID of the Job Title.
OrganizationCode	String		The Code of the Department.
OrganizationName	String		The display name of the Department.
OrganizationLocalName	String		The localized name of the Department.
OrganizationLocalNameLocale	String		The locale of the localized name of the Department.
OrganizationParentCode	String		The code of the Parent Department. null, if the parent is the Root.
OrganizationDescription	String		The description of the Department.
TitleCode	String		The code of the Job Title.
TitleName	String		The name of the Job Title.
TitleDescription	String		The description of the Job Title.

Pseudo-Columns

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

Name	Type	Description
UserCode	String		The log in name of the User.

Gets information of Groups that a User belongs to.

Select

WHERE 句では、UserCode カラムが必須です。Sync App はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Sync App はクライアント側でSync App 内で他のフィルタを処理します。

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

SELECT * FROM UserGroups where UserCode = 'loginname';

Columns

Name	Type	References	Description
GroupId [KEY]	Long		The ID of the Group.
GroupCode	String		The code of the Group.
GroupName	String		The display name of the Group.
GroupDescription	String		The description of the Group.

Pseudo-Columns

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

Name	Type	Description
UserCode	String		The log in name of the User.

Gets information of users.

Select

Sync App はKintone API を使用してサポート対象のフィルタを処理します。デフォルトでは、Sync App はクライアント側でSync App 内で他のフィルタを処理します。

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

SELECT * FROM Users where id = 1;
SELECT * FROM Users where id in (1,2);
SELECT * FROM Users where Code = 'loginname';
SELECT * FROM Users where code in ('loginname1','loginname2');

Columns

Name	Type	References	Description
Id [KEY]	Long		The user ID.
Code	String		The log in name of the User.
CreatedTime	Datetime		The created datetime of the User.
UpdatedTime	Datetime		The updated datetime of the User.
Valid	Boolean		If the Status of the user is Active or not.
Name	String		The display name of the User.
SurName	String		The last name of the User.
GivenName	String		The first name of the User.
SurNameReading	String		The phonetic reading of the Last name.
GivenNameReading	String		The phonetic reading of the First name.
LocalName	String		The localized display name of the User.
LocalNameLocale	String		The locale of the localized display name of the User.
Timezone	String		The time zone ID of the user's set time zone.
Locale	String		The language setting of the user.
Description	String		The About Me section of the user's profile.
Phone	String		The phone number of the User.
MobilePhone	String		The mobile phone number of the User.
ExtensionNumber	String		The extension number of the User.
Email	String		The Email address of the User.
SkypeID	String		The Skype ID of the User.
Url	String		The URL section of the user's profile.
EmployeeNumber	String		The Employee Number of the User.
BirthDate	Datetime		The Birthday of the User.
JoinDate	Datetime		The Hire Date of the User.
PrimaryOrganization	Integer		The Department ID of the Priority Department of the User. Set to null if there is no Priority Department.
SortOrder	Integer		The Display Order priority of the User.
CustomItemValues	String		A list of pairs of Custom Field Names and Custom Field Codes.

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

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

Authentication

---

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

OAuth

---

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

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 のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。

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

---

プロパティ	説明
AllowSpecialCharacters	特殊文字を許容するかどうかを決定します。True の場合、特殊文字は置き換えられません。
CheckForSubtablesIn	サブテーブルを取得するKintone アプリのカンマ区切りリスト。
GuestSpaceId	クエリ結果をゲストスペースに制限します。
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
NumberMapToDouble	数値フィールドのデータ型をdecimal からdouble に変更するかどうかを決定します。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Pagesize	Kintone から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
SubtableSeparatorCharacter	tablename + char + subtable 形式のサブテーブルからテーブルを分割するために使用される文字。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UseCodeForFieldName	フィールド名にLabel かCode のどちらを使用するかを決定します。
UseCursor	カーソルを使用してレコードを取得するかどうかを決定するboolean。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
UseSimpleNames	テーブルとカラムに簡略名を使用するかどうかを決定するboolean。
UseUnitForNumericField	フィールド名に単位を表示するかどうかを決定します。

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

---

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

Kintone にUser / Password、APIToken、OAuth のどれで接続するか。

解説

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

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

解説

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

https://SUBDOMAIN_NAME.cybozu.com

使用するKintone API のバージョンを指定します。

解説

使用するKintone のAPI バージョンを以下から選択します：

• Kintone REST API の場合は、REST。
• Kintone USER API の場合は、USER。

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

解説

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

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

解説

認証サーバーは、ユーザーのID を検証するために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 をカンマ区切りで複数指定することができます。

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

---

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。

解説

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

解説

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

このセクションでは、本プロバイダーの接続文字列で設定可能な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 のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。

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。

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

---

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

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

解説

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

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

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

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

プロトコル	デフォルトポート	説明
TUNNEL	80	Sync App がKintone への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。
SOCKS4	1080	Sync App がKintone への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	Sync App がKintone にデータを送信するポート。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\\Kintone 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 プロパティの全リストを提供します。

---

プロパティ	説明
AllowSpecialCharacters	特殊文字を許容するかどうかを決定します。True の場合、特殊文字は置き換えられません。
CheckForSubtablesIn	サブテーブルを取得するKintone アプリのカンマ区切りリスト。
GuestSpaceId	クエリ結果をゲストスペースに制限します。
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
NumberMapToDouble	数値フィールドのデータ型をdecimal からdouble に変更するかどうかを決定します。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Pagesize	Kintone から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
SubtableSeparatorCharacter	tablename + char + subtable 形式のサブテーブルからテーブルを分割するために使用される文字。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UseCodeForFieldName	フィールド名にLabel かCode のどちらを使用するかを決定します。
UseCursor	カーソルを使用してレコードを取得するかどうかを決定するboolean。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
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 を使用しないクエリで返される最大行数を指定します。

解説

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

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

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

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

解説

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

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

解説

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

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

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

統合およびフォーマット

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

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

解説

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

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

解説

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

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

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

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

解説

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

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

解説

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

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

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

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

解説

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

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

解説

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

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

解説

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

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

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

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

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

解説

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

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

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

解説

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