データセット操作
Liferay DXP 2024.Q1+/Portal GA112+
現在、この機能は リリース機能フラグ （LPS-164563）の背後にあります。
データセットを管理する際に、データセットフラグメント内で使用するアクションを定義します。 アクションには、アイテムと作成の2種類があります。
データセット内のアイテムに対してアクションを実行するには、 アイテムアクション を使用します。
新しいデータを追加するには、 作成アクション を使用します。
まず、データセットにアクションを追加し、それを「アイテム」または「作成」アクションとして設定します。
データセットにアクションを追加する
-
グローバルメニュー (
) を開き、 コントロールパネル → データセット のオブジェクトの下に移動します。 -
アクセスしたいデータセットの名前 を選択してください。
または、データセットエントリの横にある アクション (
) をクリックし、 編集 を選択します。 -
[アクション] タブを選択し、[アイテムのアクション] または [作成時のアクション]タブを開き、[追加](
) をクリックします。アクションを作成する前に、そのアクションを設定する必要があるページが表示されます。
「表示オプション」セクションでは、すべてのアクションに共通する一般的な設定を確認できます。
-
ラベルに記入し、必要に応じて ローカライズします。
-
（オプション）データセットフラグメントに表示するアイコンを選択します。
既成のアイコンのリストから選択するか、 SVG スプライト マップ クライアント拡張機能 を介して登録されたアイコンの名前を入力します。 カスタムアイコンを使用するには、クライアント拡張機能の設定が必要です。
ヒントアイテムに単一のアクションが設定されている場合、アイコンが選択されていない限り、そのラベルはボタンコンポーネント内のテキストとして表示されます。 複数のアクションが存在する場合、アクションメニューアイコン（
）が表示され、クリックすると利用可能なアクションが表示されます。
「アクション動作」セクションで、アクションの種類を選択します。 選択した各アクションごとに、具体的な設定項目を見つけることができます。 各アクションタイプの詳細については、 アイテムと作成アクションの設定 を参照してください。
アクションを設定したら、 保存 をクリックします。
アイテムと作成アクションの設定
Liferay DXP 2024.Q2+/Portal GA120+
アイテムや作成アクションを使用して、データセットをさらにカスタマイズできます。
アイテムアクションを使用すると、データセットの各アイテムに対して、ユーザーが実行できるアクション（アイテムの削除、編集、詳細の表示など）を設定できます。
アイテムのアクションタイプは 5 つあります: 非同期、 ヘッドレス、 リンク、 モーダル、および サイドパネル
作成アクションを使用すると、データセットに新しいアイテムを作成できます。 ユーザーを新しいエントリが作成されるURLに誘導し、リンクを直接開くか、モーダルウィンドウまたはサイドパネルで開くかを選択できます。
作成アクションの種類は 3 つあります: リンク、 モーダル、および サイドパネル。
これらのアクションを実装する方法の実践的な例については、 データセットアクションの使用 をお読みください。
データセットのアクションを作成する前に、 一般的な観察事項 セクションを確認して、追加のガイダンスを確認してください。
一般的な観察
-
API情報： APIエクスプローラーを介してアクションキーとエンドポイントの詳細にアクセスします。
-
確認メッセージ：これらはアイテム操作に対してのみ表示されます。
-
権限: アクションがヘッドレスエンドポイントに関連付けられている場合、ユーザーはエンドポイントを使用するために必要な権限（たとえば、ドキュメントを編集する権限）を持っている必要があります。 エンドポイントから返される情報は、ユーザーの権限によって異なる場合があります。
-
URL補間：URLに補間パラメータを使用することで、情報を動的にAPIに送信できます。 パラメータ化された値を中括弧で囲みます
{}。例えば、
(...)externalReferenceCode=9ad3e87f-0a7b-4624(...)のような静的な値をexternalReferenceCode={externalReferenceCode}に置き換えると、アイテムに基づいて値が動的に取得されます。 -
URLのベストプラクティス：相対URLを使用し、できるだけ汎用性の高いURLにするように努めましょう。
アクションURLにホスト名/ポート番号を含めないようにしてください。
可能な限りサイト名を指定することは避けてください。
URL では
p_p_authの値を使用しないでください。これらはセッション固有のものであり、異なるコンテキストでは有効ではありません。
非同期アクション
非同期処理はバックグラウンドで動作し、ユーザーがアプリケーションを操作している間でも、複雑な処理や時間のかかる処理をバックグラウンドで実行することを可能にします。
非同期アクションを作成するには、
-
「アクション動作」で、「タイプ」として「 Async 」を選択します。
-
選択したメソッドが実装されている REST エンドポイントの URL を指定し、 メソッド: Delete、Get、Patch、Post、または Put を選択します。
-
Liferay DXP 2024.Q4+/Portal GA129+ 選択した方法に該当する場合は、 リクエストボディ を入力してください。 選択したエンドポイントに必要な値をすべて入力してください（Patchメソッドの場合は、変更するフィールドのみを入力してください）。
リクエストボディは有効なJSON形式である必要があります。 入力がない場合、
{}として解釈されます。 -
（オプション） ヘッドレスアクションキー を入力して、アクションをヘッドレスエンドポイントにリンクし、選択したアクションメソッドに必要な権限をユーザーが持っているかどうかを確認します。 選択した方法とキーが一致していることを確認してください。
重要キーが定義されていない場合でも、アクションは機能しますが、検証や制限が適用されないため、すべてのユーザーに表示されます。
-
(オプション) 非同期アクションに対して 確認 と ステータス メッセージ を設定します。
設定が完了したら、非同期アクションを使用して選択したメソッドを呼び出し、実行します。
この非同期アクション構成例では、Patch メソッドを使用してバックグラウンド プロセスを持つユーザーを非アクティブ化します。
ヘッドレスアクション
ヘッドレスアクションは、 ヘッドレスアクションキーを介して制御され、これにより、API を介して実行できる特定の権限と機能が決定されます。 例えば、キー delete を持つヘッドレスアクションは、API が特定のリソースに対して削除操作を実行できるようにします。
ヘッドレスアクションを作成するには、
-
「アクション動作」で、「タイプ」として「 ヘッドレス 」を選択します。
-
Liferay DXP 2024.Q4+/Portal GA129+ 選択した方法に該当する場合は、 リクエストボディ を入力してください。 選択したエンドポイントに必要な値をすべて入力してください（Patchメソッドの場合は、変更するフィールドのみを入力してください）。
リクエストボディは有効なJSON形式である必要があります。 入力がない場合、
{}として解釈されます。 -
ヘッドレス エンドポイントにアクションを関連付けるには、 ヘッドレス アクション キー を入力してください。
-
（オプション）ヘッドレスアクションの 確認メッセージとステータスメッセージを設定します。
設定が完了したら、ヘッドレスアクションを使用して関連するAPI呼び出しを開始および管理します。
このヘッドレスアクション構成例では、Patch メソッドを使用してユーザーを無効化します。
リンクアクション
リンクアクションは、ユーザーを指定されたURLに誘導します。 これらは、データセット項目の削除、変更、詳細表示などの操作を容易にする項目アクションとして、またデータセットに新しい項目を追加する作成アクションとして使用できます。
主な違いは、URLの具体的な目的と、確認メッセージを設定できるかどうかです。確認メッセージの設定は、アイテム操作の場合のみ可能です。
リンクアクションを作成するには、
-
「アクション動作」で、「タイプ」として「 リンク 」を選択します。
-
URLを指定してください。
リンクアクションで URL を設定すると、データセット コンポーネントは自動的に リダイレクト と backURL パラメーターを追加し、 backURL パラメーターをデータセットのページの URL に設定します。 宛先ページからデータセットに戻れない場合は、宛先ページがパラメータを正しく処理していることを確認してください。
-
（オプション） ヘッドレスアクションキー を入力してください。 アクションキーを使用すると、管理者はアクションをヘッドレスエンドポイントに接続できます（例：GET、POST、DELETE）。
設定が完了すると、ユーザーはアクションボタンまたはアイコンをクリックした際に、指定されたURLにリダイレクトされます。
モーダルアクション
モーダルアクションは、ユーザーを指定されたURLに誘導し、そのURL内のモーダルウィンドウを表示します。 モーダルアクションはアイテムアクションまたは作成アクションとして使用できますが、確認メッセージが含まれるのはアイテムアクションのみであることに注意してください。
モーダルアクションを使用する場合は、モーダル内で宛先URLが正しく機能することを確認してください。
モーダルアクションを作成するには、
-
「アクション動作」で、「タイプ」として「 モーダル 」を選択します。
-
モーダル用に バリアント を選択してください: 全画面、大、または小。
-
URLを指定してください。
-
（オプション） ヘッドレスアクションキー を入力してください。 アクションキーを使用すると、管理者はアクションをヘッドレスエンドポイントに接続できます（例：GET、POST、DELETE）。
設定が完了すると、ユーザーはアクションボタンまたはアイコンをクリックした際に、選択したURLがモーダルウィンドウに表示され、そこに誘導されます。
サイドパネルアクション
サイドパネルのアクションは、ユーザーをサイドパネルに表示される指定されたURLに誘導します。 サイドパネルのアクションは、アイテムアクションまたは作成アクションとして使用できますが、確認メッセージが表示されるのはアイテムアクションのみであることに注意してください。
サイドパネルのアクションを使用する場合は、宛先URLがサイドパネル内で正しく動作することを確認してください。
サイドパネルアクションを作成するには、
-
「アクション動作」セクションで、「タイプ」として「 サイドパネル 」を選択します。
-
ユーザーを誘導する先のURLを指定してください。
-
（オプション） ヘッドレスアクションキー を入力してください。 アクションキーを使用すると、管理者はアクションをヘッドレスエンドポイントに接続できます（例：GET、POST、DELETE）。
-
（オプション）サイドパネルアクションをアイテムタイプとして使用している場合は、 確認メッセージを 設定できます。
設定が完了すると、ユーザーはアクションボタンまたはアイコンをクリックした際に、サイドパネルに表示される選択したURLにリダイレクトされます。
確認メッセージとステータスメッセージの設定
アクションを実行する前に、確認メッセージや成功／失敗メッセージを表示できます。
どちらの項目も任意入力です。 確認メッセージが空の場合は、メッセージは表示されず、処理は即座に実行されます。 同様に、ステータスメッセージが空欄の場合、一般的な成功メッセージまたはエラーメッセージが表示されます。
アイテムアクションの確認メッセージを作成するには、
-
手順に従って、データセット「 Item Action」を作成してください。
-
アクション動作の下に、 確認メッセージを入力します。
-
メッセージタイプを選択してください：警告、情報、二次、成功、危険。
非同期 および ヘッドレス アクションのステータス メッセージを作成するには、
-
タイプとして Async または Headless を選択してください。
-
ステータス メッセージで、 成功 タブを選択し、成功メッセージを入力します。
-
エラー タブを選択し、エラー メッセージを入力します。
確認メッセージとステータスメッセージはローカライズ可能です。 詳細については、 ラベルの編集とローカライズ をお読みください。
データセットアクションの有効化と無効化
Liferay 2025.Q2+
ステータス列のボタンを使用して、定義したアクションを有効または無効にすることもできます。 アクションが非アクティブになると、再度アクティブ化するまでユーザーには表示されなくなります。
データセットのアクションは削除するのではなく、無効化してください。そうすれば、必要に応じて後で再度有効化できます。
モーダルおよびサイドパネルのアクションでタイトルを使用する
Liferay DXP 2024.Q3+/Portal GA125+
サイドパネルとモーダルアクションは現在のページの上に開くため、ユーザーはページを移動することなくコンテンツを操作できます。 これらのアクションに タイトル フィールドを追加すると、コンポーネントの上部にタイトルと閉じるボタンが表示されたバーが表示されます。 ユーザーはモーダルウィンドウ／サイドパネルを閉じて、元のページに戻ることができます。
サイドパネルまたはモーダルアクションが既にタイトルを含むURLを指している場合、アクション設定にタイトルを追加する必要はありません。 対象URLの既存のタイトルが、閉じるボタンとともに表示されます。 アクション設定に別のタイトルを追加すると、2つのバーが重なって表示されます。
アクションにもURLにもタイトルが含まれていない場合、何も表示されません。