データセットアクションの使用
Liferay DXP 2024.Q1/ポータル GA112
現在、この機能は リリース機能フラグ (LPS-164563) によって保護されています。
データ セット アクションを使用してさまざまなタスクを実行する方法の例をいくつか示します。
ユースケース: アクションを使用してドキュメントを編集する
背景: サイトのドキュメントとメディア アプリケーションにパフォーマンス レビュー ドキュメントがあり、パフォーマンス レビューの一覧、その ID、タイトル、外部参照コード、および作成日を表示したいと考えています。 また、データ セットを表示できるユーザーがドキュメントを編集できるようにする必要があります。
環境の設定: アクションを作成する前に、 次のパラメータを使用してデータセットを作成します 。
| 項目 | 値 |
|---|---|
| 名前 | ドキュメントデータセット |
| REST アプリケーション | /headless-delivery/v1.0 |
| REST スキーマ | ドキュメント |
| REST エンドポイント | /v1.0/sites/{siteId}/documents |
Documents Data Set の編集を開始し、 id、 externalReferenceCode、 title、および dateCreated フィールド を追加します。
次に、 ドキュメントをドキュメントとメディア アプリケーションにアップロードします。
編集アクションの作成
「新しいアイテムアクション」ページで、以下の表の情報を使用してフィールドに入力します。
| 項目 | 値 |
|---|---|
| ラベル | ドキュメントの編集 |
| アイコン | 鉛筆( |
| 種類 | リンク |
URLを入力するには、
-
新しいタブで、ドキュメントとメディア アプリケーション (サイト メニュー → コンテンツ & データ → ドキュメントとメディア) でパフォーマンス レビュー ドキュメントを探します。
-
ドキュメントの アクション メニュー (
) を開き、 編集 オプションを右クリックして、 リンク アドレスのコピーを選択します。URL は次のようになります
http://localhost:8080/group/guest/~/control_panel/manage?(...)_com_liferay_document_library_web_portlet_DLAdminPortlet_fileEntryId=32813&(...)state%3Dmaximized%26p_p_mode%3Dview%26p_p_auth%3DYH1QvqK9&p_p_auth=YH1QvqK9
-
「新しいアイテムアクション」ウィンドウに戻り、そのフィールドに URL を貼り付けます。
このアクションを現状のまま使用すると、ユーザーは、編集しようとしているエントリに関係なく、同じドキュメントを参照する同じ編集ページに送信されます。
それを望んでいないので、URL をできるだけ汎用的にし、値をパラメーター化して、各アクションが特定のエントリの URL を指すようにする必要があります。
-
URL をより汎用的にするには、まず最初のアドレス (
http://localhost:8080) を見つけて削除することから始めます。これにより、サイトのアドレスが変更された場合でもアクションが機能することが保証されます。
-
認証トークン
p_p_auth%3DYH1QvqK9&p_p_auth=YH1QvqK9を検索して削除することもできます。これにより、ログインするたびに
p_p_auth認証トークンが変更されるため、認証の競合を防ぐことができます。 -
URL をパラメーター化するには、URL 内の
fileEntryId値を見つけます。 ドキュメントを参照するためにヘッドレス API で使用されるパラメータに置き換えます。 この場合、はを ID とします。fileEntryIdの値がインスタンス内で異なります。どの値を使用すべきかわからない場合は、 API エクスプローラー にアクセスし、REST アプリケーションで使用されているパラメータを探してください。
-
32813を{id}に置き換えます。パラメータ値を中括弧 ({}) 内に入力します。

-
URL を設定したら、ヘッドレス アクティベーション キーを追加します。 API エクスプローラーを使用して見つけることができます。 使用している REST アプリケーションを見つけて、GET コマンドを実行します。 キーはレスポンス本文に次のように記載されています。
(...) "actions": { "get": { "method": "GET", "href": "http://localhost:8080/o/c/performancereviews/32647" }, "replace": { "method": "PUT", "href": "http://localhost:8080/o/c/performancereviews/32647" }, "update": { "method": "PATCH", "href": "http://localhost:8080/o/c/performancereviews/32647" }, "delete": { "method": "DELETE", "href": "http://localhost:8080/o/c/performancereviews/32647" } }この場合、アクション キーは
取得、置換、更新、削除です。ユーザーがドキュメントを編集するため、PUT メソッドとそのアクティベーション キーを使用する必要があります (
をに置き換えます)。 キーをヘッドレス アクション キー フィールドに追加し、ユーザーにそのアクションに必要な権限があることを確認します。 -
この場合、確認メッセージは必要ないので、 「保存」をクリックします。
コンテンツページでデータセットフラグメントを使用する
アクションが設定されました。 データ セット フラグメントを使用して、データ セットを コンテンツ ページに表示します。
-
左側のフラグメントとウィジェット メニューで、フラグメントの下のデータセットを検索します。 フラグメントを編集領域にドラッグ アンド ドロップします。
-
フラグメントをクリックします。 右側の「全般」タブには、データ セットを選択できるフィールドがあります。 追加 (
) をクリックし、 ドキュメント データ セットを選択します。 -
ページを公開します。
データ セットには、構成どおりにデータ セットが表示されます。 ドキュメントを編集するには、 編集 をクリックします。
