レプリケーション replication

Adobe Experience Manager as a Cloud Service では、Sling コンテンツ配布機能を使用して、AEM ランタイムの外部にある Adobe Developer で実行されるパイプラインサービスに複製するコンテンツを移動します。

コンテンツの公開方法 methods-of-publishing-content

クイック公開／非公開 - 計画的公開／非公開 publish-unpublish

この機能を使用すると、「公開を管理」のアプローチで可能な追加オプションを使用せずに、選択したページを直ちに公開できます。

詳しくは、「公開を管理」を参照してください。

オンタイムとオフタイム - トリガー設定 on-and-off-times-trigger-configuration

オンタイム ​と​ オフタイム ​の追加設定をページのプロパティの「基本」タブで行えます。

この機能の自動レプリケーションを実現するには、OSGi 設定の「オン／オフトリガー設定」で「自動レプリケーション」を有効にします。

公開を管理 manage-publication

公開を管理には、クイック公開よりも多くのオプションがあります。子ページの追加、参照のカスタマイズ、該当するワークフローの開始、後で公開するためのオプションがあります。

「後で公開する」オプションの対象にフォルダーの子を含めると、コンテンツツリーを公開ワークフローが呼び出されます（この記事で説明）。

「公開を管理」について詳しくは、 公開の基本に関するドキュメント を参照してください。

コンテンツツリーの公開ワークフロー publish-content-tree-workflow

次に示すように、 ツール／ワークフロー／モデル ​を選択し、「コンテンツツリーを公開」という標準のワークフローモデルをコピーして、ツリーレプリケーションをトリガーできます。

元のモデルを呼び出さないでください。その代わりに、最初にモデルをコピーして、そのコピーを呼び出してください。

すべてのワークフローと同様に、API を使用して呼び出すこともできます。詳しくは、プログラムによるワークフローの操作を参照してください。

または、Publish Content Tree プロセスステップを使用するワークフローモデルを作成することもできます。

パラメーター

ログ

ツリーのアクティベーションワークフローステップが開始されると、その設定パラメーターが INFO ログレベルで記録されます。パスがアクティブ化されると、INFO 文も記録されます。

最後の INFO ステートメントは、すべてのパスがワークフローステップでレプリケートされた後にログに記録されます。

また、com.day.cq.wcm.workflow.process.impl の下のロガーのログレベルを DEBUG/TRACE に上げると、さらに多くのログ情報を取得できます。

エラーが発生した場合、ワークフローステップは WorkflowException で終了し、基になる例外をラップします。

サンプルのコンテンツツリーの公開ワークフローで生成されるログの例を以下に示します。

21.04.2021 19:14:55.566 [cm-p123-e456-aem-author-797aaaf-wkkqt] *INFO* [JobHandler: /var/workflow/instances/server60/2021-04-20/brian-tree-replication-test-2_1:/content/wknd/us/en/adventures] com.day.cq.wcm.workflow.process.impl.treeactivation.TreeActivationWorkflowProcess TreeActivation options: replicateAsParticipant=false(userid=workflow-process-service), agentId=publish, chunkSize=100, filter=, enableVersion=false

21.04.2021 19:14:58.541 [cm-p123-e456-aem-author-797aaaf-wkkqt] *INFO* [JobHandler: /var/workflow/instances/server60/2021-04-20/brian-tree-replication-test-2_1:/content/wknd/us/en/adventures] com.day.cq.wcm.workflow.process.impl.ChunkedReplicator closing chunkedReplication-VolatileWorkItem_node1_var_workflow_instances_server60_2021-04-20_brian-tree-replication-test-2_1, 17 paths replicated in 2971 ms

サポートの再開

ワークフローは、コンテンツをチャンク単位で処理し、チャンクは公開されるコンテンツ全体のサブセットを表します。ワークフローがシステムによって停止されると、ワークフローが再起動され、まだ処理されていないチャンクを処理します。ログステートメントには、コンテンツが特定のパスから再開されたことが示されます。

レプリケーション API replication-api

AEM as a Cloud Service に備わっている Replication API を使用してコンテンツを公開できます。

詳しくは、 API のドキュメント を参照してください。

API の基本的な使用法

@Reference
Replicator replicator;
@Reference
ReplicationStatusProvider replicationStatusProvider;

....
Session session = ...
// Activate a single page to all agents, which are active by default
replicator.replicate(session,ReplicationActionType.ACTIVATE,"/content/we-retail/en");
// Activate multiple pages (but try to limit it to approx 100 at max)
replicator.replicate(session,ReplicationActionType.ACTIVATE, new String[]{"/content/we-retail/en","/content/we-retail/de"});

// ways to get the replication status
Resource enResource = resourceResolver.getResource("/content/we-retail/en");
Resource deResource = resourceResolver.getResource("/content/we-retail/de");
ReplicationStatus enStatus = enResource.adaptTo(ReplicationStatus.class);
// if you need to get the status for more more than 1 resource at once, this approach is more performant
Map<String,ReplicationStatus> allStatus = replicationStatusProvider.getBatchReplicationStatus(enResource,deResource);

特定のエージェントを使用したレプリケーション

上記の例のようにリソースをレプリケートする場合は、デフォルトでアクティブなエージェントのみが使用されます。AEM as a Cloud Service では、オーサーをパブリッシュ層に接続する「パブリッシュ」と呼ばれるエージェントのみを指します。

プレビュー機能をサポートするために、「プレビュー」と呼ばれる新しいエージェントが追加されました。このエージェントは、デフォルトではアクティブになっていません。このエージェントは、オーサーをプレビュー層に接続するために使用されます。プレビューエージェントのみを使用してレプリケートする場合は、AgentFilter を使用してこのプレビューエージェントを明示的に選択する必要があります。

次の例を参照してください。

private static final String PREVIEW_AGENT = "preview";

ReplicationStatus beforeStatus = enResource.adaptTo(ReplicationStatus.class); // beforeStatus.isActivated == false

ReplicationOptions options = new ReplicationOptions();
options.setFilter(new AgentFilter() {
  @Override
  public boolean isIncluded (Agent agent) {
    return agent.getId().equals(PREVIEW_AGENT);
  }
});
// will replicate only to preview
replicator.replicate(session,ReplicationActionType.ACTIVATE,"/content/we-retail/en", options);

ReplicationStatus afterStatus = enResource.adaptTo(ReplicationStatus.class); // afterStatus.isActivated == false
ReplicationStatus previewStatus = afterStatus.getStatusForAgent(PREVIEW_AGENT); // previewStatus.isActivated == true

このようなフィルターを指定せず、「パブリッシュ」エージェントのみを使用する場合、「プレビュー」エージェントは使用されず、レプリケーションアクションはプレビュー層には影響しません。

リソースの ReplicationStatus 全体が変更されるのは、デフォルトでアクティブになっているエージェントがレプリケーションアクションに少なくとも 1 つ含まれている場合のみです。上記の例では、このフローは該当しませんでした。レプリケーションでは単に「プレビュー」エージェントが使用されていました。したがって、新しい getStatusForAgent() メソッドを使用する必要があります。これにより、特定のエージェントのステータスをクエリすることができます。このメソッドは、「パブリッシュ」エージェントに対しても機能します。指定されたエージェントを使用して実行されたレプリケーションアクションがある場合、このメソッドは null 以外の値を返します。

コンテンツの無効化方法 invalidating-content

コンテンツを直接無効にするには、作成者が Sling コンテンツ無効化（SCD）を使用するか（推奨される方法）、Replication API を使用して公開 Dispatcher フラッシュレプリケーションエージェントを呼び出します。詳しくは、キャッシュページを参照してください。

Replication API の容量制限

一度にレプリケートするパスは 100 個未満で、上限は 500 個です。上限を超えると、ReplicationException がスローされます。
アプリケーションロジックにアトミックレプリケーションが必要ない場合は、ReplicationOptions.setUseAtomicCalls を false に設定することで、この制限を解除できます。これにより任意の数のパスを扱えますが、内部的には、この制限内に収まるようにバケットが作成されます。

レプリケーション呼び出しごとに送信されるコンテンツのサイズは、10 MB を超えてはなりません。このルールにはノードとプロパティが含まれますが、バイナリは含まれません（ワークフローパッケージとコンテンツパッケージはバイナリと見なされません）。

トラブルシューティング troubleshooting

レプリケーションのトラブルシューティングを行うには、AEM オーサーサービス Web UI のレプリケーションキューに移動します。

コンテンツを公開できなかった場合は、パブリケーション全体が AEM パブリッシュサービスから元に戻されます。

その場合は、メインの編集可能なキューのステータスが赤く表示され、公開のキャンセル原因となった項目を特定するために、そのキューを確認する必要があります。そのキューをクリックすると、保留中の項目が表示されるので、その中から 1 つの項目またはすべての項目を必要に応じてクリアできます。