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

データセットフィルター

Liferay DXP 2024.Q1/Portal GA112

重要

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

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

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

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

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

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

Liferay DXP 2024.Q4+/Portal GA129+

どのタイプのフィルターでも、「Filter By」フィールドの下の「Select」をクリックすると、選択したエントリー・タイプのすべてのフィールドを含むツリー・ビューの「Select Field」ポップアップが開きます。オブジェクトエントリタイプの場合、親または関連するエントリフィールドを展開することもできます（たとえば、関連オブジェクトのフィールドなど）。

警告

フィールドでフィルタリングできるかどうかは、関連するAPIのフィルタリング機能に依存します。選択できる項目であっても、フィルタリングに対応していない項目があります。 API Explorer で API を見つけ、 $filter パラメータでクエリが機能するかどうかを確認して、機能を確認します。

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

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

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

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

警告

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

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

Liferay 2025.Q2+

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

データセットフィルターは、トグルボタンで無効化できます。必要に応じて後で再度有効化できます。

データセットフィルターは削除するのではなく、無効化してください。そうすれば、必要に応じて後で再度有効化できます。

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

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

新しいフィルターを追加する際は、 クライアント拡張機能 を選択してください。

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

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

クライアントの内線番号に基づいてフィルタを作成します。

日付範囲フィルター

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

新しいフィルターを追加する際は、日付範囲をから選択してください。
フィルターの名前を記入し、オプションでローカライズする。
エントリをフィルタリングするフィールドを選択してください。

各フィールドには、一度に1つのフィルターのみを関連付けることができます。
（オプション）をからからまでの日付に設定すると、エントリが事前にフィルタリングされ、指定された範囲内のエントリが表示されます。
［保存］をクリックします。

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

選択フィルター

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

注

選択リストから選択されたフィルターは、整数型のフィールドには適用できません。なぜなら、選択リストのキーは文字列であり、比較に互換性がないためです。フィルタリングを実行するAPIは、フィルタリングに使用する一意のキーを必要とします。

新しいフィルターを追加する際は、まず選択を選択してください。選択フィルターは、「設定」、「フィルターソース」、「フィルターオプション」の3つのセクションで構成されています。

設定の下、

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

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

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