レプリケーション replication
Adobe Experience Manager as a Cloud Service では、Sling コンテンツ配布機能を使用して、AEM ランタイムの外部にある Adobe Developer で実行されるパイプラインサービスに複製するコンテンツを移動します。
コンテンツの公開方法 methods-of-publishing-content
独自の一括公開カスタムコードを作成することはお勧めできません。
何らかの理由でカスタマイズする必要がある場合は、既存のワークフロー API を使用して、このステップをトリガーできます。
常に、公開する必要のあるコンテンツのみを公開することをお勧めします。また、必要がない場合は、大量のコンテンツを公開しないようにしてください。ただし、ツリーアクティベーションワークフローステップを使用したワークフローを通じて送信できるコンテンツの量に制限はありません。
クイック公開／非公開 - 計画的公開／非公開 publish-unpublish
この機能を使用すると、「公開を管理」のアプローチで可能な追加オプションを使用せずに、選択したページを直ちに公開できます。
詳しくは、「公開を管理」を参照してください。
オンタイムとオフタイム - トリガー設定 on-and-off-times-trigger-configuration
オンタイム と オフタイム の追加設定をページのプロパティの「基本」タブで行えます。
この機能の自動レプリケーションを実現するには、OSGi 設定の「オン／オフトリガー設定」で「自動レプリケーション」を有効にします。
公開を管理 manage-publication
公開を管理には、クイック公開よりも多くのオプションがあります。子ページの追加、参照のカスタマイズ、該当するワークフローの開始、後で公開するためのオプションがあります。
「後で公開する」オプションの対象にフォルダーの子を含めると、コンテンツツリーを公開ワークフローが呼び出されます（この記事で説明）。
「公開を管理」について詳しくは、 公開の基本に関するドキュメント を参照してください。
ツリーアクティベーションワークフローステップ tree-activation
パフォーマンスの高いツリーアクティベーションワークフローステップは、コンテンツノードの深い階層を高いパフォーマンスでレプリケートすることを目的としています。キューが大きくなりすぎると、他のレプリケーションが最小限の遅延で並行して続行できるように、自動的に一時停止します。
TreeActivation プロセスステップを使用するワークフローモデルを作成します。
-
AEM as a Cloud Service のホームページから、ツール／ワークフロー／モデル に移動します。
-
ワークフローモデルページで、画面の右上隅にある「作成」を押します。
-
モデルにタイトルと名前を追加します。詳しくは、ワークフローモデルの作成を参照してください。
-
作成したモデルをリストから選択し、「編集」を押します。
-
次のウィンドウで、デフォルトで表示されるステップを削除します
-
プロセスステップを現在のモデルフローにドラッグ＆ドロップします。
-
フローのプロセスステップを選択し、レンチアイコンを押して「設定」を選択します。
-
「プロセス」タブを選択し、ドロップダウンリストから
Publish Content Treeを選択し、ハンドラー処理の設定 チェックボックスをオンにします。
-
「引数」フィールドに追加のパラメーターを設定します。複数のコンマ区切り引数をまとめることができます。例：
enableVersion=false,agentId=publish,chunkSize=50,maxTreeSize=500000,dryRun=false,filters=onlyModified,maxQueueSize=10note note NOTE パラメーターのリストについては、以下の「パラメーター」の節を参照してください。 -
「完了」を押して、ワークフローモデルを保存します。
パラメーター
サポートされるフィルター
サポートの再開
ワークフローはコンテンツをチャンク単位で処理し、各チャンクは、公開される完全なコンテンツのサブセットを表します。ワークフローがシステムによって停止されると、中断した場所から続行されます。
ワークフローの進行状況の監視
-
AEM as a Cloud Service のホームページから、ツール／一般／ジョブ に移動します。
-
ワークフローに対応する行を確認します。進行状況 列には、レプリケーションの進行状況が示されます。例えば、41/564 と表示され、更新すると 52/564 に更新される場合があります。
-
行を選択して開くと、ワークフロー実行のステータスに関する追加の詳細が表示されます。
コンテンツツリーの公開ワークフロー publish-content-tree-workflow
次に示すように、 ツール／ワークフロー／モデル を選択し、「コンテンツツリーを公開」という標準のワークフローモデルをコピーして、ツリーレプリケーションをトリガーできます。
元のモデルを呼び出さないでください。その代わりに、最初にモデルをコピーして、そのコピーを呼び出してください。
すべてのワークフローと同様に、API を使用して呼び出すこともできます。詳しくは、プログラムによるワークフローの操作を参照してください。
または、Publish Content Tree プロセスステップを使用するワークフローモデルを作成することもできます。
-
AEM as a Cloud Service のホームページから、ツール／ワークフロー／モデル に移動します。
-
ワークフローモデルページで、画面の右上隅にある「作成」を押します。
-
モデルにタイトルと名前を追加します。詳しくは、ワークフローモデルの作成を参照してください。
-
作成したモデルをリストから選択し、「編集」を押します。
-
次のウィンドウで、「プロセスステップ」を現在のモデルフローにドラッグ＆ドロップします。
-
フローのプロセスステップを選択し、レンチアイコンを押して「設定」を選択します。
-
「プロセス」タブを選択し、ドロップダウンリストから
Publish Content Treeを選択し、ハンドラー処理の設定 チェックボックスをオンにします。
-
「引数」フィールドに追加のパラメーターを設定します。複数のコンマ区切り引数をまとめることができます。例：
enableVersion=true,agentId=publish,includeChildren=truenote note NOTE パラメーターのリストについては、以下の「パラメーター」の節を参照してください。 -
「完了」を押して、ワークフローモデルを保存します。
パラメーター
-
includeChildren（ブール値、デフォルト：false）。値falseでは、パスのみが公開され、trueでは、子も公開されます。 -
replicateAsParticipant（ブール値、デフォルト：false）。trueに設定した場合、レプリケーションは、参加者ステップを実行したプリンシパルのuseridを使用します。 -
enableVersion（ブール値、デフォルト：false）。このパラメーターは、レプリケーション時に新しいバージョンが作成されるかどうかを指定します。 -
agentId（文字列値。デフォルトは、パブリッシュのエージェントのみが使用されることを意味します）。agentId を明確にすることをお勧めします。例えば、値「publish」を設定します。エージェントをpreviewに設定すると、プレビューサービスに公開されます。 -
filters（文字列値。デフォルトは、すべてのパスがアクティブ化されることを意味します）。使用できる値は次のとおりです。onlyActivated-（既に）アクティブ化されたページのみアクティブ化します。再アクティブ化の形で動作します。onlyModified- 既にアクティブ化されており、変更日がアクティブ化の日付よりも後のパスのみをアクティブ化します。- 上記は、パイプ（|）で OR 結合できます。（例：
onlyActivated|onlyModified）。
ログ
ツリーのアクティベーションワークフローステップが開始されると、その設定パラメーターが INFO ログレベルで記録されます。パスがアクティブ化されると、INFO 文も記録されます。
最後の INFO ステートメントは、すべてのパスがワークフローステップでレプリケートされた後にログに記録されます。
また、com.day.cq.wcm.workflow.process.impl の下のロガーのログレベルを DEBUG/TRACE に上げると、さらに多くのログ情報を取得できます。
エラーが発生した場合、ワークフローステップは WorkflowException で終了し、基になる例外をラップします。
サンプルのコンテンツツリーの公開ワークフローで生成されるログの例を以下に示します。
| code language-none |
|---|
|
| code language-none |
|---|
|
レプリケーション 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 開始メニューで ツール／デプロイメント／配布 に移動します。
-
公開 カードを選択します。
-
キューのステータスが緑色かどうかを確認します。
-
レプリケーションサービスへの接続をテストできます。
-
「ログ」タブを選択すると、コンテンツパブリケーションの履歴が表示されます。
コンテンツを公開できなかった場合は、パブリケーション全体が AEM パブリッシュサービスから元に戻されます。
その場合は、メインの編集可能なキューのステータスが赤く表示され、公開のキャンセル原因となった項目を特定するために、そのキューを確認する必要があります。そのキューをクリックすると、保留中の項目が表示されるので、その中から 1 つの項目またはすべての項目を必要に応じてクリアできます。