ライブコピーの同期の設定

最終更新日: 2023-11-08
  • 作成対象:
  • Admin

ライブコピーをソースコンテンツと同期する方法とタイミングを制御するには、次のタスクを実行します。

  • 既存のロールアウト設定が要件を満たしているかどうか、または 1 つ以上のロールアウト設定を作成する必要があるかどうかを決定します。
  • ライブコピーに使用するロールアウト設定を指定します。

インストールされるロールアウト設定とカスタムロールアウト設定

このセクションでは、インストールされているロールアウト設定と、それらが使用する同期アクション、および必要に応じてカスタム設定を作成する方法に関する情報を提供します。

注意

インストール済みの標準のロールアウト設定を、更新したり変更したりすることは 推奨しません。カスタムのライブアクションが必要な場合は、カスタムロールアウトの設定で追加してください。

ロールアウトトリガー

各ロールアウト設定では、ロールアウトトリガーを使用してロールアウトを発生させます。ロールアウト設定では、以下のいずれかのトリガーを使用できます。

  • ロールアウト時ロールアウト​コマンドをブループリントページで使用します。または、同期​コマンドをライブコピーページで使用します。

  • 変更時:ソースページが変更されます。

  • アクティベート時:ソースページがアクティベートされます。

  • アクティベート解除時:ソースページがアクティベート解除されます。

メモ

変更時トリガーを使用すると、パフォーマンスに影響を及ぼす可能性があります。詳しくは、MSM のベストプラクティスを参照してください。

インストール済みのロールアウト設定

次の表に、AEMと共にインストールされるロールアウト設定を示します。 表には各ロールアウト設定のトリガーと同期アクションが含まれます。インストールされたロールアウト設定のアクションが要件を満たさない場合は、次の操作を実行できます。 ロールアウト設定の作成.

名前 説明 トリガー 同期アクション

関連情報 インストール済みの同期アクション
標準ロールアウト設定 ロールアウトトリガーでロールアウトプロセスを開始するのを許可したり、アクション(コンテンツの作成、更新、削除や子ノードの整理)を実行したりする標準のロールアウト設定です。。 ロールアウト時 contentUpdate
contentCopy
contentDelete
referencesUpdate
productUpdate
orderChildren
ブループリントのアクティベート時にアクティベート ソースが公開されたときにライブコピーを公開します。 アクティベート時 targetActivate
ブループリントのアクティベート解除時にアクティベート解除 ソースが非アクティブ化された場合に、ライブコピーを非アクティブ化します。 アクティベート解除時 targetDeactivate
変更時にプッシュ

ソースが変更された場合に、コンテンツをライブコピーにプッシュします。

このロールアウト設定は、[ 変更時 ]トリガーを使用するので、慎重に使用してください。

変更時 contentUpdate
contentCopy
contentDelete
referencesUpdate
orderChildren
変更時にプッシュ(シャロー)

参照を更新することなく、ブループリントページが変更されたときに、ライブコピーにコンテンツをプッシュします(シャローコピーの場合など)。

このロールアウト設定は、[ 変更時 ]トリガーを使用するので、慎重に使用してください。

変更時 contentUpdate
contentCopy
contentDelete
orderChildren
ローンチを昇格 ローンチページを昇格するための標準ロールアウト設定です。 ロールアウト時 contentUpdate
contentCopy
contentDelete
referencesUpdate
orderChildren
markLiveRelationship
カタログページコンテンツのロールアウト設定 カタログのブループリントのページテンプレートを適用します。 ロールアウト時 contentUpdate
contentCopy
contentDelete
referencesUpdate
productCreateUpdate
orderChildren
カタログページ更新のロールアウト設定 カタログのブループリントのターゲットプロパティを適用します。 カタログページコンテンツのロールアウト設定の後に実行する必要があります。 ロールアウト時 catalogRolloutHooks
DPS パブリケーションのロールアウト設定 DPS パブリッシュのロールアウト設定。最初のロールアウトで FolioProducer バインディングプロパティを除外しながら、ロールアウトトリガーでロールアウトプロセスを開始できます。 ロールアウト時 contentUpdate
contentCopy
contentDelete
referencesUpdate
orderChildren
dpsMetadataFilter
レガシー (5.6.0) カタログロールアウト設定 非推奨です。カタログロールアウトには、MSM ではなく Catalog Generator を使用してください。 ロールアウト時 editProperties

インストール済みの同期アクション

次のテーブルに、AEM と共にインストールされる同期アクションのリストを示します。インストールされているアクションが要件を満たさない場合は、新しい同期アクションを作成できます。

アクション名 説明 プロパティ
contentCopy ソースのノードがライブコピーに存在しない場合は、ライブコピーにノードをコピーします。CQ MSM Content Copy Action サービスを設定して、除外するノードタイプ、段落項目、ページプロパティを指定してください。
contentDelete

ソースに存在しないライブコピーのノードを削除します。CQ MSM Content Delete Action サービスを設定して、除外するノードタイプ、段落項目およびページプロパティを指定してください。

contentUpdate ソースからの変更を使用してライブコピーのコンテンツを更新します。CQ MSM Content Update Action サービスを設定して、除外するノードタイプ、段落項目、ページプロパティを指定してください。
editProperties

ライブコピーのプロパティを編集します。 editMap プロパティは、編集するプロパティとその値を決定します。 editMap プロパティの値は、次の形式を使用する必要があります。

[property_name_1]#[current_value]#[new_value],
[property_name_2]#[current_value]#[new_value],
... ,
[property_name_n]#[current_value]#[new_value]

current_valuenew_value の項目は正規表現です。

例えば、editMap の次の値を検討してください。

sling:resourceType#/(contentpage|homepage)#/
mobilecontentpage,
cq:template#/contentpage#/mobilecontentpage

この値は、ライブコピーのノードのプロパティを次のように編集します。

  • contentpage または homepage のどちらかに設定されている sling:resourceType プロパティは次のように設定されます。 mobilecontentpage.
  • contentpage に設定されている cq:template プロパティは次のように設定されます。 mobilecontentpage.

editMap: (String) プロパティ、現在の値および新しい値を識別します。 詳しくは、説明を参照してください。

notify ページがロールアウトされたページイベントを送信します。 通知が送信されるようにするには、最初にロールアウトイベントを購読する必要があります。
orderChildren ライブコピーでは、ブループリント上の順序に基づいて子(ノード)を並べ替えます
referencesUpdate

この同期アクションにより、ライブコピーでは、リンクなどの参照が更新されます。
ブループリント内の特定のリソースを指す、ライブコピーページ内のパスを検索します。見つかると、パスが更新され、(ブループリントではなく)ライブコピー内の関連リソースを指すようになります。 ブループリント外のターゲットを持つ参照は変更されません。

CQ MSM References Update Action サービスを設定して、除外するノードタイプ、段落項目、ページプロパティを指定してください。

targetVersion

ライブコピーのバージョンを作成します。

このアクションは、ロールアウト設定に含まれる唯一の同期アクションである必要があります。

targetActivate

ライブコピーをアクティベートします。

このアクションは、ロールアウト設定に含まれる唯一の同期アクションである必要があります。

targetDeactivate

ライブコピーを非アクティブ化します。

このアクションは、ロールアウト設定に含まれる唯一の同期アクションである必要があります。

ワークフロー

target プロパティで定義されているワークフローを開始し(ページの場合のみ)、ライブコピーをペイロードとして取ります。

モデルノードのパスがターゲットパスになります。

target: (String) ワークフローモデルのパス。
mandatory

ライブコピーページ上の複数の ACL の権限を、特定のユーザーグループに対して読み取り専用に設定します。 次の ACL が設定されています。

  • ActionSet.ACTION_NAME_REMOVE
  • ActionSet.ACTION_NAME_SET_PROPERTY
  • ActionSet.ACTION_NAME_ACL_MODIFY

このアクションはページにのみ使用してください。

target:(文字列)権限を設定するグループの ID。
mandatoryContent

ライブコピーページ上の複数の ACL の権限を、特定のユーザーグループに対して読み取り専用に設定します。 次の ACL が設定されています。

  • ActionSet.ACTION_NAME_SET_PROPERTY
  • ActionSet.ACTION_NAME_ACL_MODIFY

このアクションはページにのみ使用してください。

target:(文字列)権限を設定するグループの ID。
mandatoryStructure ライブコピーページ上の ActionSet.ACTION_NAME_REMOVE ACL の権限を、特定のユーザーグループについて読み取り専用に設定します。このアクションはページにのみ使用してください。 target:(文字列)権限を設定するグループの ID。
VersionCopyAction ブループリント/ソースページが少なくとも 1 回公開された場合は、公開されたバージョンを使用してライブコピーページを作成します。メモ:このアクションは、公開されたソースページに基づくライブコピーページの作成でのみ使用できます。既存のライブコピーページの更新では使用できません。
PageMoveAction

PageMoveAction は、ページがブループリント内で移動された場合に適用されます。

アクションは、(関連する)LiveCopy ページを移動前の場所から移動後の場所に移動するのではなく、コピーします。

PageMoveAction は、移動前の場所にある LiveCopy ページを変更しません。 したがって、連続する RolloutConfigurations の場合、ブループリントのない LiveRelationship のステータスになります。

CQ MSM Page Move Action サービスを設定して、除外するノードタイプ、段落項目およびページプロパティを指定してください。

このアクションは、ロールアウト設定に含まれる唯一の同期アクションである必要があります。

prop_referenceUpdate: (Boolean) 参照を更新するには、true に設定します。 デフォルトは true です。

productCreateUpdate カタログ内の製品リソースを作成または更新します。 このアクションは、次のいずれかの状況で使用することを目的としています。
  • カタログ(またはカタログセクション)の生成またはロールアウト
  • ユーザは、製品コンポーネントの同期継承を復元します。
markLiveRelationship ローンチが作成したコンテンツにライブ関係が存在することを示します。
catalogRolloutHooks カタログ生成固有のロールアウトフックを実行します。 CatalogGenerator の executePageRolloutHooks メソッドと executeProductRolloutHooks メソッドを呼び出します。
AEM Javadoc のcom.adobe.cq.commerce.pim.api.CatalogGenerator を参照してください。
productUpdate 製品カタログのライブコピーの製品ページを更新します

ロールアウト設定の作成

以下が可能です。 ロールアウト設定の作成 インストールされたロールアウト設定がアプリケーションの要件を満たさない場合:

ブループリントページまたはライブコピーページでロールアウト設定を指定すると、新しいロールアウト設定を使用できるようになります。

プロパティとノードタイプの同期からの除外

対応する同期アクションをサポートする複数の OSGi サービスを設定して、特定のノードタイプやプロパティに影響を与えないようにすることができます。例えば、AEM の内部機能に関連する多くのプロパティとサブノードをライブコピーに含めることはできません。コピーする必要があるのは、ページのユーザーに関連するコンテンツだけです。

AEM を操作しているときは、このようなサービスの設定を管理する方法がいくつかあります。詳細および推奨事項については、OSGi の設定を参照してください。

次の表に、除外するノードを指定できる同期アクションを示します。この表には、Web コンソールを使用して設定する場合のサービスの名前とリポジトリーノードを使用して設定する場合の PID が示されています。

同期アクション Web コンソールでのサービス名 サービス PID
contentCopy CQ MSM Content Copy Action com.day.cq.wcm.msm.impl.actions.ContentCopyActionFactory
contentDelete CQ MSM Content Delete Action com.day.cq.wcm.msm.impl.actions.ContentDeleteActionFactory
contentUpdate CQ MSM Content Update Action com.day.cq.wcm.msm.impl.actions.ContentUpdateActionFactory
PageMoveAction CQ MSM Page Move Action com.day.cq.wcm.msm.impl.actions.PageMoveActionFactory
referencesUpdate CQ MSM References Update Action com.day.cq.wcm.msm.impl.actions.ReferencesUpdateActionFactory

次の表は、設定可能なプロパティを示しています。

Web コンソールのプロパティ/ OSGi プロパティ 説明

除外されたノードタイプ

cq.wcm.msm.action.excludednodetypes

同期アクションから除外するノードタイプに一致する正規表現。

Excluded Paragraph Items

cq.wcm.msm.action.excludedparagraphitems

同期アクションから除外する段落項目に一致する正規表現。

Excluded Page Properties

cq.wcm.msm.action.excludedprops

同期アクションから除外するページプロパティに一致する正規表現。

Ignored Mixin NodeTypes

cq.wcm.msm.action.ignoredMixin

CQ MSM Content Update Action でのみ使用できます。同期アクションから除外する mixin ノードタイプの名前に一致する正規表現です。
メモ

クラシック UI では、ライブコピーページのページプロパティダイアログボックスに表示されるロックアイコンに、 Excluded Page Properties プロパティの設定が反映されていません。 ロックアイコンは、同期アクションから除外されたプロパティに対しても表示されます。

メモ

タッチ操作向け UI の場合は、ページプロパティの MSM ロックの設定(タッチ操作向け UI)も参照してください。

CQ MSM Content Update Action - 除外

いくつかのプロパティとノードタイプは、デフォルトで除外されます。これらは、除外ページのプロパティ​の CQ MSM CQ コンテンツ更新アクション​の OSGi 設定で定義されています。

デフォルトでは、次の正規表現に一致するプロパティがロールアウト時に除外されます(更新されません)。

CQ MSM Content Update Action

必要に応じて、除外リストを定義する表現を変更できます。

例えば、ロールアウトで考慮される変更にページ​タイトル​を含めるには、除外から jcr:title を削除します。正規表現は次のようになります。

jcr:(?!(title)$).*

参照を更新するための同期の設定

参照の更新に関連する、対応する同期アクションをサポートする複数の OSGi サービスを設定できます。

AEM を操作しているときは、このようなサービスの設定を管理する方法がいくつかあります。詳細および推奨事項については、OSGi の設定を参照してください。

次の表は、参照の更新を指定できる同期アクションを示します。この表には、Web コンソールを使用して設定する場合のサービスの名前とリポジトリーノードを使用して設定する場合の PID が示されています。

Web コンソールのプロパティ/ OSGi プロパティ 説明

ネストされたライブコピー全体での参照を更新

cq.wcm.msm.impl.action.referencesupdate.prop_updateNested

CQ MSM References Update Action でのみ使用できます。 最上位のライブコピーのブランチ内にあるリソースをターゲットとする参照を置き換えるには、このオプションを選択する(Web コンソール)か、この boolean プロパティを true に設定します(リポジトリ設定)。

Update Referencing Pages

cq.wcm.msm.impl.actions.pagemove.prop_referenceUpdate

CQ MSM Page Move Action でのみ使用できます。元のページを使用する参照を、ライブコピーページを参照するように更新するには、このオプションを選択する(Web コンソール)か、この boolean プロパティを true に設定します(リポジトリ設定)。

使用するロールアウト設定の指定

MSM を使用すると、通常使用するロールアウト設定のセットを指定できます。必要に応じて、特定のライブコピー用にロールアウト設定を上書きすることもできます。MSM では、使用するロールアウト設定を複数の場所で指定できます。この場所では、特定のライブコピーに設定を適用するかどうかを指定します。

使用するロールアウト設定を指定できる場所を以下に示します。また、ライブコピーに使用するロールアウト設定を MSM がどのように決定するかについても説明します。

  • ライブコピーページのプロパティ 1 つ以上のロールアウト設定を使用するようにライブコピーページが設定される場合、MSM ではそれらのロールアウト設定を使用します。
  • ブループリントページのプロパティ​ライブコピーがブループリントに基づいており、ライブコピーページがロールアウト設定を使用して設定されない場合は、ブループリントのソースページに関連付けられているロールアウト設定が使用されます。
  • ライブコピーの親ページプロパティ:​ライブコピーページもブループリントのソースページもロールアウト設定を使用して設定されない場合は、ライブコピーページの親ページに適用されるロールアウト設定が使用されます。
  • システムのデフォルト​ライブコピーの親ページのロールアウト設定を特定できない場合は、システムのデフォルトのロールアウト設定が使用されます。

例えば、ブループリントでは We.Retail 参照サイトをソースコンテンツとして使用します。 サイトはブループリントから作成されます。次のリスト内の各項目では、ロールアウト設定の使用に関する様々なシナリオについて説明します。

  • ブループリントページまたはライブコピーページがロールアウト設定を使用するように設定されていない。 MSM では、すべてのライブコピーページに対してシステムのデフォルトのロールアウト設定が使用されます。
  • We.Retail 参照サイトのルートページは、複数のロールアウト設定を使用して設定されます。 MSM は、すべてのライブコピーページに対して、これらのロールアウト設定を使用します。
  • We.Retail 参照サイトのルートページが複数のロールアウト設定を使用して設定されており、ライブコピーサイトのルートページが別のロールアウト設定のセットを使用して設定されている。MSM では、ライブコピーサイトのルートページで設定されたロールアウト設定を使用します。

ライブコピーページ用のロールアウト設定の指定

ソースページがロールアウトされる際に使用するロールアウト設定を使用してライブコピーページを設定します。 デフォルトでは、子ページは設定を継承します。使用するロールアウト設定を指定する場合は、ライブコピーページがその親から継承する設定を上書きします。

ライブコピーの作成時に、ライブコピーページ用のロールアウト設定を指定することもできます。

  1. Sites コンソールを使用してライブコピーページを選択します。

  2. ツールバーの「プロパティ」を選択します。

  3. ライブコピー」タブを開きます。

    設定」セクションには、ページが継承するロールアウト設定が表示されます。

    設定

  4. 必要に応じて、 ライブコピーの継承 フラグ。 オンにした場合、ライブコピー設定がすべての子で有効になります。

  5. ロールアウト設定を親から継承」プロパティをオフにして、1 つ以上のロールアウト設定をリストから選択します。

    選択したロールアウト設定がドロップダウンリストの下に表示されます。

    選択したロールアウト設定

  6. 保存」をクリックまたはタップします。

ブループリントページ用のロールアウト設定の指定

ブループリントページのロールアウト時に使用するロールアウト設定を使用して、ブループリントページを設定します。

ブループリントページの子ページは設定を継承します。 使用するロールアウト設定を指定する場合は、ページがその親から継承する設定を上書きする場合があります。

  1. サイト​コンソールを使用してブループリントのルートページを選択します。
  2. ツールバーの「プロパティ」を選択します。
  3. ブループリント」タブを開きます。
  4. ドロップダウンセレクターを使用して、ロールアウト設定​を 1 つ以上選択します。
  5. 保存」を選択して更新内容を保持します。

システムのデフォルトのロールアウト設定の指定

システムの既定値として使用するロールアウト設定を指定します。 デフォルトを指定するには、OSGi サービスを設定します。

  • Day CQ WCM Live Relationship Manager
    サービス PID は com.day.cq.wcm.msm.impl.LiveRelationshipManagerImpl

このサービスを設定するには、Web コンソールまたはリポジトリノードを使用します。

  • Web コンソールの場合、設定するプロパティの名前は Default rollout config です。
  • リポジトリーノードを使用する場合、設定するプロパティの名前は liverelationshipmgr.relationsconfig.default です。

このプロパティの値を、システムのデフォルトとして使用するロールアウト設定のパスに指定します。デフォルト値は /libs/msm/wcm/rolloutconfigs/default です。これは​標準のロールアウト設定​です。

このページ