ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、こちらまでご連絡ください。

データセットフィルター

Liferay DXP 2024.Q1/ポータル GA112

重要

現在、この機能はリリース機能フラグ (LPS-164563) によって保護されています。

データセットを管理するときに、データセットフラグメントで使用される事前適用フィルターを定義できます。これらのフィルターを設定することはできますが、ユーザーはいつでもパラメータを変更できます。

データセットにフィルターを追加する

グローバルメニュー () を開き、 コントロールパネル タブを選択して、オブジェクトの下の データセット をクリックします。
アクセスするデータセットの名前をクリックします。

または、データセットエントリの横にある [アクション] () をクリックし、 [編集]を選択します。
フィルター タブを選択します。
追加 () をクリックし、使用可能なオプションのいずれかを選択します: クライアント拡張機能、日付範囲、または選択。

フィルターフィールドの選択

Liferay DXP 2024.Q4+/ポータル GA129+

どのタイプのフィルターでも、[フィルター条件] フィールドの下の [選択] をクリックすると、[フィールドの選択] ポップアップが開き、選択したエントリタイプのすべてのフィールドを含むツリービューが表示されます。オブジェクトエントリタイプの場合、親または関連エントリフィールド ( 関連オブジェクトのフィールドなど) を展開することもできます。

警告

フィールドでフィルタリングできるかどうかは、関連付けられている API のフィルタリング機能によって異なります。一部のフィールドは、選択できる場合でもフィルタリングをサポートしていません。 API エクスプローラーで API を見つけ、クエリが $filter パラメータで機能するかどうかをチェックして、機能を確認します。

選択したフィルターのタイプによって、ツリー内のどのフィールドが選択可能かが決まります。

クライアント拡張フィルター: 任意のフィールドを選択できます。クライアント拡張機能の実装によって、フィルターの適用方法が決まります。
日付範囲フィルター: 日付フィールドのみが選択可能です。ユーザーは、フィルターを選択するときに、デフォルトの日付範囲を変更できます。
[選択フィルター](#selection filter): 選択できるのは文字列または数値フィールドのみです。

選択したエントリタイプのすべてのフィールドと、関連するエントリタイプを表示できます。

関連エントリに属するフィールドを選択すると、より複雑なフィルターに役立ちます。たとえば、School オブジェクトと関係のある Student オブジェクトがある場合、関連する School の schoolName フィールドで Student データセットをフィルターできます。ユーザーが Stanford Universityという名前を選択した場合、次のフィルター式が自動的に適用されます: filter=(studentsAtSchool/schoolName+eq+'Stanford+University')。

警告

オブジェクトエンドポイントのみが、関連または親の入力フィールドの選択をサポートします。他の種類のエンドポイント ( /o/headless-* エンドポイントなど) に対して自動的に生成されたフィルター構文は、関連エントリのフィールドを使用するフィルターでは機能しません。

フィルターの有効化と無効化

ライフレイ 2025年第2四半期以降

フィルターを追加した後で、[ステータス] 列のボタンを使用してフィルターを有効または無効にすることもできます。フィルターが非アクティブになると、再度アクティブ化するまでユーザーは使用できなくなります。

トグルボタンを使用してデータセットフィルターを無効にし、必要に応じて後で再度有効にすることができます。

データセットフィルターを削除するのではなく非アクティブ化して、必要に応じて後で再度アクティブ化できるようにします。

クライアント拡張フィルター

フロントエンドデータセットフィルタークライアント拡張機能を使用するか、ワークスペースからクライアント拡張機能をデプロイして、フィルターエクスペリエンスをカスタマイズし、データセットに新しいタイプのフィルターを追加します。

新しいフィルターを追加するときは、 クライアント拡張 を選択します。

各フィールドは、一度に 1 つのフィルターにのみ関連付けることができます。

フィルターの名前を入力し、オプションでローカライズします。
エントリをフィルタリングする フィールド を選択します。
フロントエンドデータセットフィルター クライアント拡張機能を選択し、保存をクリックします。

クライアント拡張機能に基づいてフィルターを作成します。

日付範囲フィルター

日付型フィールドを使用して、表示されるエントリを事前にフィルタリングします。

新しいフィルターを追加するときは、 日付範囲 を選択します。
フィルターの名前を入力し、オプションでローカライズします。
エントリをフィルタリングする フィールド を選択します。

各フィールドは、一度に 1 つのフィルターにのみ関連付けることができます。
(オプション) エントリを事前にフィルターするには、開始と終了の日付を設定します。フィルターにより、指定された範囲内のエントリが表示されます。
[保存]をクリックします。

日付フィールドに基づいてフィルターを作成します。

選択フィルター

フィルターのパラメータとして、API REST エンドポイントまたは選択リストオプションを使用します。

新しいフィルターを追加するときは、まず選択を選択します。選択フィルターには、構成、フィルターソース、フィルターオプションの 3 つのセクションがあります。

構成の下で、

フィルターの名前を入力し、オプションでローカライズします。
エントリをフィルタリングする フィールド を選択します。

フィルターソースの下で、

フィルターソース を構成して、フィルターで提供される値を決定します。フィルターに関連付けるオブジェクトピックリストまたは Liferay DXP 2024.Q3+/Portal GA125+ API REST アプリケーションを選択します。
- オブジェクト選択リストを使用して、フィルターに関連付ける選択リストを選択します。
- Liferay DXP 2024.Q3+/Portal GA125+ API RESTアプリケーションでは、 RESTアプリケーション、 RESTスキーマ、 RESTエンドポイント、 アイテムキー、および アイテムラベルを選択します。
  
  ヒント
  
  アイテムキーとアイテムラベルは、フィルターの構築に使用される API 応答のフィールドを定義します。アイテムキーはフィルターパラメーターとして OData オブジェクトを構築し、アイテムラベルはフィルター UI に値を表示します。 API は幅広いデータを返すことができるため、適切な統合とデータ処理にはこれらのフィールドを指定することが重要です。