データセットアクション

Liferay DXP 2024.Q1+/ポータル GA112+

データ セットを管理するときに、データ セット フラグメントで使用するアクションを定義します。 アクションには、アイテムと作成の 2 種類があります。

データ セット内のアイテムに対してアクションを実行するには、 アイテム アクション を使用します。

新しいデータを追加するには、 作成アクション を使用します。

まず、 データ セットにアクションを追加 し、それを アイテムまたは作成アクションとして構成します。

データセットへのアクションの追加

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

2. アクセスするデータ セットの 名前 を選択します。

   または、データ セット エントリの横にある [アクション] () をクリックし、 [編集]を選択します。

3. [アクション] タブを選択し、 アイテム アクション または 作成アクション タブを開いて、 追加 () をクリックします。

   アクションを作成する前に、アクションを構成する必要があるページが表示されます。

「表示オプション」セクションでは、すべてのアクションに共通する一般設定を見つけることができます。

1. ラベルに記入し、オプションで ローカライズ します。

2. (オプション) データ セット フラグメントに表示するアイコンを選択します。

   すぐに使用できるアイコンのリストから選択するか、 SVG スプライト マップ クライアント拡張機能を通じて登録されたアイコンの名前を入力します。 カスタム アイコンを使用するには、クライアント拡張機能を構成する必要があります。

   ヒント

   アイテムに単一のアクションがある場合、アイコンが選択されていないと、そのラベルはボタン コンポーネント内にテキストとして表示されます。 複数のアクションが存在する場合は、アクション メニュー アイコン () が表示され、クリックすると利用可能なアクションが表示されます。

   

「アクションの動作」セクションで、アクションの種類を選択します。 選択したアクションごとに特定の構成を見つけることができます。 各アクション タイプの詳細については、 アイテムおよび作成アクションの構成 を参照してください。

アクションが設定されたら、 「保存」をクリックします。

アイテムと作成アクションの設定

Liferay DXP 2024.Q2+/ポータル GA120+

アイテムと作成アクションを使用してデータ セットをさらにカスタマイズできます。

アイテム アクションを使用すると、ユーザーはデータ セット アイテムごとにアクション (アイテムの削除、編集、詳細の表示など) を実行できます。

アイテムアクションには 5 つのタイプがあります: 非同期、 ヘッドレス、 リンク、 モーダル、 サイドパネル

作成アクションを使用して、データ セットの新しいアイテムを作成します。 新しいエントリが作成される URL にユーザーを誘導し、リンクを直接開くか、モーダルまたはサイド パネルで開くかを選択できます。

作成アクションの種類には、 リンク、 モーダル、 サイド パネルの 3 つがあります。

これらのアクションを実装する方法の実践的な例については、「 データ セット アクションの使用」を参照してください。

データ セットのアクションを作成する前に、追加のガイダンスとして 一般的な注意事項 セクションを確認してください。

一般的な観察

• API 情報: API エクスプローラーを通じてアクション キーとエンドポイントの詳細にアクセスします。

• 確認メッセージ: これらはアイテムアクションでのみ使用できます。

• 権限: アクションがヘッドレス エンドポイントに関連付けられている場合、ユーザーはエンドポイントを使用するために必要な権限 (ドキュメントの編集など) を持っている必要があります。 エンドポイントによって返される情報は、ユーザーの権限によって異なる場合があります。

• URL 補間: URL 内の補間パラメータを使用して、情報を API に動的に送信します。 パラメータ化された値は中括弧 {}で囲みます。

  たとえば、 (...)externalReferenceCode=9ad3e87f-0a7b-4624(...) のような静的値を externalReferenceCode={externalReferenceCode} に置き換えて、項目に基づいて値が動的に取得されるようにします。

• URL のベスト プラクティス: 相対 URL を使用し、できるだけ汎用的なものにするようにします。

  アクション URL にホスト名/ポートを含めないでください。

  可能な限りサイト名の指定は避けてください。

  p_p_auth 値はセッション固有であり、異なるコンテキストでは有効ではないため、URL では使用しないでください。

非同期アクション

非同期アクションはバックグラウンドで動作し、ユーザーがアプリケーションを操作し続けながら、複雑な操作や時間のかかる操作をバックグラウンドで実行できます。

非同期アクションを作成するには、

1. 「アクションの動作」で、タイプとして「 非同期 」を選択します。

2. 選択したメソッドが実装されている REST エンドポイントの URL を指定し、 メソッドを選択します: Delete、Get、Patch、Post、または Put。

3. Liferay DXP 2024.Q4+/Portal GA129+ 選択した方法に該当する場合は、 リクエスト ボディ を入力します。 選択したエンドポイントに必要なすべての値を入力します (Patch メソッドの場合は、変更するフィールドのみ)。

   リクエスト本文は有効な JSON である必要があります。 入力がない場合は {}として解釈されます。

4. (オプション) ヘッドレス アクション キー を入力して、アクションをヘッドレス エンドポイントにリンクし、選択したアクション メソッドに必要な権限がユーザーにあるかどうかを確認します。 キーが選択した方法と一致していることを確認します。

   重要

   キーが定義されていない場合でもアクションは機能しますが、検証や制限は行われないため、すべてのユーザーに表示されます。

5. (オプション) 非同期アクションの 確認 と ステータス メッセージ を設定します。

設定が完了したら、非同期アクションを使用して、選択したメソッドを呼び出して実行します。

この例の非同期アクション構成では、Patch メソッドを介してバックグラウンド プロセスでユーザーを非アクティブ化します。

ヘッドレスアクション

ヘッドレス アクションは ヘッドレス アクション キーによって制御され、API を通じて実行できる特定の権限と機能を決定します。 たとえば、キー delete を持つヘッドレスアクションにより、API は特定のリソースに対して削除操作を実行できるようになります。

ヘッドレスアクションを作成するには、

1. 「アクションの動作」で、タイプとして「 ヘッドレス 」を選択します。

2. Liferay DXP 2024.Q4+/Portal GA129+ 選択した方法に該当する場合は、 リクエスト ボディ を入力します。 選択したエンドポイントに必要なすべての値を入力します (Patch メソッドの場合は、変更するフィールドのみ)。

   リクエスト本文は有効な JSON である必要があります。 入力がない場合は {}として解釈されます。

3. アクションをヘッドレス エンドポイントに関連付けるには、 ヘッドレス アクション キー を入力します。

4. (オプション) ヘッドレスアクションの 確認 と ステータス メッセージ を設定します。

設定が完了したら、ヘッドレスアクションを使用して関連するAPI呼び出しを開始および管理します。

このヘッドレス アクション構成の例では、Patch メソッドを使用してユーザーを非アクティブ化します。

リンクアクション

リンク アクションは、ユーザーを指定された URL に誘導します。 これらは、データ セット アイテムの詳細の削除、変更、表示などの操作を容易にするアイテム アクションとして使用することも、データ セットに新しいアイテムを追加する作成アクションとして使用することもできます。

主な違いは、URL の特定の目的と、アイテム アクションでのみ使用できる確認メッセージを設定できるかどうかです。

リンクアクションを作成するには、

1. 「アクションの動作」で、タイプとして「 リンク 」を選択します。

2. URL を指定します。

1. (オプション) ヘッドレスアクションキーを入力します。 アクション キーを使用すると、管理者はアクションをヘッドレス エンドポイント (GET、POST、DELETE など) に接続できます。

2. (オプション) アイテム タイプとしてリンク アクションを使用している場合は、 確認メッセージ を設定できます。

設定が完了すると、ユーザーはアクション ボタンまたはアイコンをクリックすると指定された URL に誘導されます。

モーダルアクション

モーダル アクションは、モーダルでレンダリングされる指定された URL にユーザーを送信します。 モーダル アクションはアイテム アクションまたは作成アクションとして使用できますが、確認メッセージが含まれるのはアイテム アクションのみであることに注意してください。

モーダルアクションを作成するには、

1. 「アクションの動作」で、タイプとして「 モーダル 」を選択します。

2. モーダルの バリアント を選択します: 全画面、大、小。

3. モーダルの タイトル を入力します。。

4. URL を指定します。

5. (オプション) ヘッドレスアクションキーを入力します。 アクション キーを使用すると、管理者はアクションをヘッドレス エンドポイント (GET、POST、DELETE など) に接続できます。

6. (オプション) モーダルアクションをアイテムタイプとして使用している場合は、 確認メッセージ を設定できます。

設定が完了すると、ユーザーはアクション ボタンまたはアイコンをクリックしたときに、モーダルでレンダリングされた選択した URL に誘導されます。

サイドパネルアクション

サイド パネル アクションは、サイド パネルに表示される指定された URL にユーザーを送信します。 サイド パネル アクションをアイテム アクションまたは作成アクションとして使用できますが、確認メッセージが含まれるのはアイテム アクションのみであることに注意してください。

サイドパネルアクションを作成するには、

1. アクション動作セクションで、タイプとして サイドパネル を選択します。

2. サイドパネルの タイトル を入力します。

3. ユーザーが移動する URL を指定します。

4. (オプション) ヘッドレスアクションキーを入力します。 アクション キーを使用すると、管理者はアクションをヘッドレス エンドポイント (GET、POST、DELETE など) に接続できます。

5. (オプション) サイド パネル アクションをアイテム タイプとして使用している場合は、 確認メッセージ を設定できます。

設定が完了すると、ユーザーはアクション ボタンまたはアイコンをクリックしたときに、サイド パネルに表示される選択した URL に誘導されます。

設定確認とステータスメッセージ

アクションを実行する前に確認メッセージや成功/失敗メッセージを表示できます。

アイテムアクションの確認メッセージを作成するには、

1. 手順に従って、 データ セットを作成 アイテム アクションします。

2. 「アクションの動作」で、 「確認メッセージ」を入力します。

3. メッセージ タイプを選択します: 警告、情報、セカンダリ、成功、危険。

非同期 および ヘッドレス アクションのステータスメッセージを作成するには、

1. 手順に従って、 データ セットを作成 アイテム アクションします。

2. タイプとして 非同期 または ヘッドレス を選択します。

3. [ステータス メッセージ] の下で、 [成功] タブを選択し、成功メッセージを入力します。

4. エラー タブを選択し、エラー メッセージを入力します。

データセットアクションの有効化と無効化

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

ステータス列のボタンを使用して、定義したアクションを有効または無効にすることもできます。 アクションが非アクティブになると、再度アクティブ化するまでユーザーに表示されなくなります。

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

モーダルおよびサイドパネルアクションでのタイトルの使用

Liferay DXP 2024.Q3+/ポータル GA125+

サイド パネルとモーダル アクションは現在のページの上部に開くため、ユーザーは別のページに移動することなくコンテンツを操作できます。 これらのアクションに タイトル フィールドを追加すると、コンポーネントの上部にタイトルと閉じるボタンのあるバーが表示されます。 ユーザーはモーダル/サイドパネルを閉じて元のページに戻ることができます。

サイド パネルまたはモーダル アクションがすでにタイトルが含まれている URL を指している場合は、アクション構成でタイトルを追加する必要はありません。 ターゲット URL の既存のタイトルが閉じるボタンとともに表示されます。 アクション構成に別のタイトルを追加すると、2 つのバーが重なり合います。

アクションにも URL にもタイトルが含まれていない場合は何も表示されません。

関連トピック

• データセットの管理
• データセットの作成
• データセットアクションの使用