データテーブルセレクター

はじめに

NocoBase では、データテーブルセレクター（Collection select） を使用して、1 つまたは複数のデータテーブルを選択できます。

データテーブルセレクターは、プラグイン設定、ルール設定、メタデータ管理などのシナリオに適しています。保存されるのはデータテーブルの識別子であり、業務レコードではありません。

特定のテーブル内のレコードを選択する場合は、データテーブルセレクターではなく、リレーションフィールドを使用してください。

適用シナリオ

データテーブルセレクターは、次のような業務シナリオに適しています。

プラグイン設定で対象データテーブルを選択する
ルール設定でデータテーブルの範囲を指定する
メタデータ管理、テンプレート設定
Collection 識別子を参照する機能設定

設定の作成

データテーブルの「Configure fields」ページで「Add field」をクリックし、「データテーブルセレクター」を選択すると、データテーブルセレクターフィールドを作成できます。

20240512174047

設定	説明
Field interface	フィールドのインターフェースタイプ。データテーブルセレクターでは `collectionSelect` に対応し、ページ上での入力方法や表示方法を決定します。
Field display name	画面上に表示されるフィールド名。たとえば「対象データテーブル」「ターゲットデータテーブル」「データ範囲」などです。業務担当者が直感的に理解できる名称を使用することをおすすめします。
Field name	API、リレーションフィールド、権限、ワークフローなどから内部参照するためのフィールド識別名。作成後は通常変更せず、英字、数字、アンダースコアのみ使用でき、先頭は英字である必要があります。
Field type	データレイヤー上でのフィールドタイプ。データテーブルセレクターは通常、データテーブルの識別子を保存します。保存タイプは実際の設定に従います。
Default value	デフォルト値。レコードを新規作成する際、ユーザーが入力しなかった場合に自動で設定できます。
Validation rules	バリデーションルール。通常は必須入力や選択範囲を設定します。
Description	フィールドの説明。フィールドの意味、入力要件、データソース、管理担当者などを記載するのに適しています。

注意

フィールド名は作成後、ページブロック、権限、ワークフロー、API から参照されます。作成前に命名を確認し、後からの変更による設定調整の負担を避けてください。

フィールドの特徴

データテーブルセレクターフィールドのデフォルト動作は次のとおりです。

特徴	説明
デフォルトの Field interface	`collectionSelect`。
デフォルトの Field type	`string`。
選択可能な Field type	`string`、`json`。実際の設定に従います。
ページコンポーネント	編集モードではデータテーブル選択コンポーネントを使用します。
フィルター	通常、業務上のフィルターフィールドとしては使用しません。
並べ替え	通常、並べ替えには使用しません。
バリデーション	必須入力などの基本的なバリデーションに対応しています。

設定の編集

作成後、フィールド右側の「Edit」をクリックすると、データテーブルセレクターフィールドの設定を編集できます。フィールドの編集は、主に NocoBase でのフィールドの表示方法や使用方法を調整するために行います。たとえば、表示名、説明、デフォルト値、バリデーションルール、フィールド固有の設定などを変更できます。

フィールドがメインデータベースですでに同期されているテーブルに由来する場合、編集時には通常、フィールドマッピングを行います。つまり、データベースフィールドを NocoBase の Field type と Field interface にマッピングします。

設定	編集可否	説明
Field display name	はい	画面上でのフィールド表示名を変更します。フィールド識別名は変更されません。
Field name	いいえ	フィールド識別名は、作成後通常、編集フォームでは変更できません。
Field interface	条件付きで可	メインデータベースのフィールドまたは同期フィールドは、フィールドマッピング時に調整できます。変更すると、ページ上での入力、表示、バリデーションの方法に影響します。
Field type	条件付きで可	メインデータベースのフィールドまたは同期フィールドは、フィールドマッピング時に調整できます。変更前に、既存データを新しいタイプで利用できるか確認する必要があります。
Default value	はい	レコード新規作成時のデフォルト値を調整します。
Validation rules	はい	フィールドのバリデーションルールを調整します。
Description	はい	フィールドの意味、入力要件、データソース、管理担当者などを補足します。

注意

Field type や Field interface の切り替えは、単に表示名を変更することとは異なります。フィールドの保存方法、入力コンポーネント、バリデーションルール、フィルター条件、ワークフロー変数の使用方法に影響します。既存データが多い場合は、あらかじめデータ形式が適合するか確認してください。

フィールドの削除

フィールド右側の「Delete」をクリックすると、データテーブルセレクターフィールドを削除できます。メインデータベースでは、複数のフィールドを選択して一括削除することもできます。

メインデータベースで新規作成したデータテーブルセレクターフィールドを削除すると、通常、データベース内の実際の列と、その列に保存されているデータも同時に削除されます。データベースとの同期や外部データソースからのマッピングによって作成されたフィールドを削除する場合、影響範囲は対応するデータソースとフィールドの由来によって異なります。

警告

フィールドを削除すると、ページブロック、フォーム、フィルター、権限、ワークフロー、API、インポート・エクスポート、既存データに影響する可能性があります。削除前に、そのフィールドが現在も業務設定から参照されていないか確認してください。

ページ設定での使用

データテーブルセレクターは、設定用フォームでの使用に適しています。

シナリオ	用途
フォームブロック	1 つまたは複数のデータテーブルを選択します。
詳細ブロック	選択済みのデータテーブルを表示します。
プラグイン設定	機能の対象となるデータテーブルの範囲を指定します。
ワークフローまたはルール	メタデータ設定としてロジックに組み込みます。

#データテーブルセレクター

#はじめに

#適用シナリオ

#設定の作成

#フィールドの特徴

#設定の編集

#フィールドの削除

#ページ設定での使用

#関連リンク