ユニバーサルエディターについて universal-editor
ユニバーサルエディターの柔軟性と、AEM 6.5 LTS を使用してヘッドレスエクスペリエンスを強化する方法について説明します。
概要 overview
ユニバーサルエディターは、Adobe Experience Manager Sites の一部である多用途のビジュアルエディターです。作成者は、ヘッドレスエクスペリエンスに対して見たままが得られる(WYSIWYG)編集を行うことができます。
- 作成者は、ユニバーサルエディターの柔軟性の利点を活用できます。 すべてのフォームのAEM ヘッドレスコンテンツに対して、同じ一貫性のあるビジュアル編集をサポートします。
- ユニバーサルエディターは実装の真の分離もサポートしているので、開発者はユニバーサルエディターの汎用性の恩恵を受けることができます。SDKやテクノロジーに制約を課すことなく、開発者が選択したほぼすべてのフレームワークやアーキテクチャを使用できます。
詳しくは、ユニバーサルエディターの AEM as a Cloud Service ドキュメントを参照してください。
アーキテクチャ architecture
ユニバーサルエディターは、AEM と連携してヘッドレスでコンテンツを作成するサービスです。
- ユニバーサルエディターは
https://experience.adobe.com/#/aem/editor/canvasでホストされ、AEM 6.5 LTS によってレンダリングされたページを編集できます。 - ユニバーサルエディターは、AEM オーサーインスタンスからDispatcherを介してAEM ページを読み取ります。
- Dispatcher と同じホストで実行されるユニバーサルエディターサービスは、変更を AEM オーサーインスタンスに書き戻します。
要件 requirements
以下では、ユニバーサルエディターをサポートしています。
- AEM 6.5 LTS GA
- オンプレミスおよびAdobe Managed Services(AMS)の両方のホスティングがサポートされています。
- AEM 6.5
- オンプレミスホスティングと AMS ホスティングの両方がサポートされています。
- AEM as a Cloud Service (リリース
2023.8.13099以降)
このドキュメントでは、ユニバーサルエディターのAEM 6.5 LTS サポートに焦点を当てます。 AEM 6.5 LTS でユニバーサルエディターを使用するには、次が必要です。
- AEM 6.5 LTS GA
- Dispatcher が適切に設定されている
設定 setup
ユニバーサルエディターを使用するには、次の手順を実行します。
設定が完了したら、アプリケーションを実装してユニバーサルエディターを使用できます。
サービスの設定 configure-aem
ユニバーサルエディターは、設定が必要な多数のサービスに依存しています。
login-token cookie の SameSite 属性を設定します。 samesite-attribute
- Configuration Manager を開きます。
http://<host>:<port>/system/console/configMgr
- リストで Adobe Granite Token Authentication Handler を見つけて、「設定値を変更」をクリックします。
- ダイアログで、login-token cookie の SameSite 属性(
token.samesite.cookie.attr)の値をPartitionedに変更します。 - 「保存」をクリックします。
SAMEORIGIN ヘッダーの X-Frame オプションを削除します。 sameorigin
- Configuration Manager を開きます。
http://<host>:<port>/system/console/configMgr
- リストで Apache Sling Main Servlet を見つけて、「設定値を編集」をクリックします。
- 追加の応答ヘッダー属性(
sling.additional.response.headers)からX-Frame-Options=SAMEORIGIN値が存在する場合は削除します。 - 「保存」をクリックします。
Adobe Granite クエリパラメーター認証ハンドラーを設定する query-parameter
- Configuration Manager を開きます。
http://<host>:<port>/system/console/configMgr
- リストで Adobe Granite Query Parameter Authentication Handler を見つけて、「設定値を編集」をクリックします。
- 「パス」フィールド(
path)に、/を追加して有効にします。- 値が空の場合は、認証ハンドラーが無効になります。
- 「保存」をクリックします。
ユニバーサルエディターで開くコンテンツパスまたは sling:resourceTypes を定義する paths
-
Configuration Manager を開きます。
http://<host>:<port>/system/console/configMgr
-
リストで ユニバーサルエディター URL サービス を見つけて、「設定値を編集」をクリックします。
-
ユニバーサルエディターを開くコンテンツパスまたは
sling:resourceTypesを定義します。- 「ユニバーサルエディターを開くマッピング」フィールドに、ユニバーサルエディターを開くパスを指定します。
- ユニバーサルエディターで開く「Sling:resourceTypes」フィールドに、ユニバーサルエディターで直接開くリソースのリストを入力します
-
「保存」をクリックします。
-
Externalizer 設定 を確認し、少なくともローカル、オーサー、パブリッシュ環境が次の例のように設定されていることを確認します。
code language-text "local $[env:AEM_EXTERNALIZER_LOCAL;default=http://localhost:4502]", "author $[env:AEM_EXTERNALIZER_AUTHOR;default=http://localhost:4502]", "publish $[env:AEM_EXTERNALIZER_PUBLISH;default=http://localhost:4503]"
これらの設定手順が完了すると、AEMは次の順序でページ用のユニバーサルエディターを開きます。
-
AEMは
Universal Editor Opening Mappingの下のマッピングを確認し、コンテンツがそこに定義されたパスの下にある場合は、ユニバーサルエディターが開きます。 -
Universal Editor Opening Mappingで定義されているパス外のコンテンツの場合、AEMは、コンテンツresourceTypeが Sling:resourceTypes のエントリと一致するかどうかを確認します。このエントリはユニバーサルエディターで開かれ す。 一致する場合、AEMは${author}${path}.htmlでユニバーサルエディターにコンテンツを開きます。 -
それ以外の場合は、AEMによってページエディターが開きます。
次の変数は、Universal Editor Opening Mapping でマッピングを定義するために使用できます。
path:開くリソースのコンテンツパスlocalhost:スキーマのないlocalhostの Externalizer エントリ(例:localhost:4502)author:スキーマなしのオーサー用の Externalizer エントリ(例:localhost:4502)publish:スキーマを使用しないパブリッシュ用の Externalizer エントリ(例:localhost:4503)preview:スキーマを使用しないプレビュー用の Externalizer エントリ(例:localhost:4504)env:定義された Sling 実行モードに基づくprod、stage、devtoken:QueryTokenAuthenticationHandlerに必要なクエリトークン
マッピングの例:
-
AEM オーサーの
/content/fooの下にあるすべてのページを開きます。/content/foo:${author}${path}.html?login-token=${token}https://localhost:4502/content/foo/x.html?login-token=<token>を開く結果
-
リモート NextJS サーバー上の
/content/barの下にあるすべてのページを開き、すべての変数を情報として指定します/content/bar:nextjs.server${path}?env=${env}&author=https://${author}&publish=https://${publish}&login-token=${token}https://nextjs.server/content/bar/x?env=prod&author=https://localhost:4502&publish=https://localhost:4503&login-token=<token>を開く結果
ユニバーサルエディターサービスの設定 set-up-ue
AEM を更新および設定すると、独自のローカル開発およびテスト用にローカルのユニバーサルエディターサービスを設定できます。
-
Node.js バージョン 20 以降をインストールします。
-
ソフトウェア配布 から最新のユニバーサルエディターサービスをダウンロードして展開します
-
環境変数または
.envファイルを使用してユニバーサルエディターサービスを設定します。- 詳しくは、AEM as a Cloud Service ユニバーサルエディターのドキュメントを参照してください。
- 内部 IP の書き換えが必要な場合は、
UES_MAPPINGオプションを使用する必要があります。
-
universal-editor-service.cjsを実行します
Dispatcher の更新 update-dispatcher
AEMが設定され、ローカルのユニバーサルエディターサービスが実行されている場合は、(Dispatcherで 新しいサービスのリバースプロキシを許可する必要があ ます。
-
オーサーインスタンスの vhost ファイルを調整して、リバースプロキシが組み込まれるようにします。
code language-html <IfModule mod_proxy.c> ProxyPass "/universal-editor" "http://localhost:8080" ProxyPassReverse "/universal-editor" "http://localhost:8080" </IfModule>note note NOTE 8080 がデフォルトのポートです。 .envファイルのUES_PORTパラメーターを使用して変更した場合は、ここでポート値をそれに応じて調整する必要があります。 -
Apache を再起動します。
アプリの実装 instrumentation
AEM が更新され、ローカルのユニバーサルエディターサービスが実行されている場合は、ユニバーサルエディターを使用してヘッドレスコンテンツの編集を開始できます。
ただし、ユニバーサルエディターを利用するには、アプリのインストルメントを行う必要があります。 これには、コンテンツを保持する方法と場所をエディターに指示するメタタグを含める必要があります。 この実装について詳しくは、AEM as a Cloud Service のユニバーサルエディターのドキュメントを参照してください。
AEMを使用したユニバーサルエディターのドキュメントに従う場合、AEM as a Cloud Service 6.5 LTS で使用する際には次の変更が適用されます。
-
メタタグのプロトコルは、
aemの代わりにaem65にする必要があります。code language-html <meta name="urn:adobe:aue:system:aemconnection" content={`aem65:${getAuthorHost()}`}/> -
ユニバーサルエディターサービスのエンドポイントは、メタタグを通じて通知する必要があります。
code language-html <meta name="urn:adobe:aue:config:service" content={`${getAuthorHost()}/universal-editor`}/> -
コンポーネント定義の
pluginsセクションでは、aemの代わりにaem65を使用する必要があります。
AEM 6.5 LTS とAEM as a Cloud Serviceの違い differences
AEM 6.5 LTS のユニバーサルエディターは、UI や多くの設定を含め、AEM as a Cloud Serviceと広く同じように機能します。 ただし、注意すべき違いがあります。
- 6.5 LTS のユニバーサルエディターは、ヘッドレスユースケースのみをサポートしています。
- ユニバーサルエディターの設定は、(現在のドキュメントで説明されているように 6.5 LTS の場合 若干異なります。
- 6.5 LTS のユニバーサルエディターは、AEM as a Cloud Serviceとは異なるアセットピッカーと異なるコンテンツフラグメントピッカーを使用します。