MSM Rollout Conflicts
Conflicts can occur if new pages with the same page name are created in both the blueprint branch and a dependent live copy branch.
Such conflicts need to be handled and resolved upon rollout.
When conflicting pages do exist (in the blueprint and live copy branches), MSM allows you to define how (or even if) they should be handled.
To ensure that the rollout is not blocked, possible definitions can include:
- which page (blueprint or live copy) will have priority during rollout,
- which pages will be renamed (and how),
- how this will affect any published content.The default behavior of AEM (out-of-the-box) is that published content will not be impacted. So if a page that was manually created in the live copy branch has been published, that content will still be published after the conflict handling and rollout.
In addition to the standard functionality, customized conflict handlers can be added to implement different rules. These can also allow publishing actions as an individual process.
In the following sections we use the example of a new page b , created in both the blueprint and the live copy branch (created manually), to illustrate the various methods of conflict resolution:
- blueprint: /bA master page; with 1 child page, bp-level-1.
- live copy: /bA page manually created in the live copy branch; with 1 child page, lc-level-1 .
- Activated on publish as /b , together with the child page.
|blueprint before rollout||live copy before rollout||publish before rollout|
|b (created in blueprint branch, ready for rollout)||b (manually created in live copy branch)||b (contains the content of the page b that was manually created in the live copy branch)|
|/bp-level-1||/lc-level-1 (manually created in live copy branch)||/lc-level-1 (contains the content of the page child-level-1 that was manually created in the live copy branch)|
Rollout Manager and Conflict Handling
The rollout manager allows you to activate or deactivate conflict management.
This is done using OSGi configuration of Day CQ WCM Rollout Manager :
- Handle conflict with manually created Pages :( rolloutmgr.conflicthandling.enabled )Set to true if the rollout manager should handle conflicts from a page created in the live copy with a name that exists in the blueprint.
AEM uses conflict handlers to resolve any page conflicts that exist when rolling out content from a blueprint to a live copy. Renaming pages is one (the usual) method of resolving such conflicts. More than one conflict handler can be operational to allow for a selection of different behaviors.
- The default conflict handler :
- The possibility to implement a customized handler .
- The service ranking mechanism that allows you to set the priority of each individual handler. The service with the highest ranking is used.
Default Conflict Handler
The default conflict handler:
- Is called ResourceNameRolloutConflictHandler
- With this handler the blueprint page is given precedence.
- The service ranking for this handler is set low ( ``i.e. below the default value for the service.ranking property) as the assumption is that customized handlers will need a higher ranking. However, the ranking is not the absolute minimum to ensure flexibility when required.
This conflict handler gives precedence to the blueprint. The live copy page /b is moved (within the live copy branch) to /b_msm_moved .
- live copy: /bIs moved (within the live copy) to /b_msm_moved . This acts as a backup and ensures that no content is lost.
- lc-level-1 is not moved.
- blueprint: /bIs rolled out to the live copy page /b .
- bp-level-1 is rolled out to the livecopy.
|blueprint after rollout||live copy after rollout||live copy after rollout||publish after rollout|
|b||b (has the content of the blueprint page b that was rolled out)||b_msm_moved (has the content of the page b that was manually created in the live copy branch)||b (no change; contains the content of the original page b that was manually created in the live copy branch and is now called b_msm_moved)|
|/bp-level-1||/bp-level-1||/lc-level-1 (no change)||/lc-level-1 (no change)|
Customized conflict handlers allow you to implement your own rules. Using the service ranking mechanism you can also define how they interact with other handlers.
Customized conflict handlers can:
- Be named according to your requirements.
- Be developed/configured according to your requirements; for example, you can develop a handler so that the live copy page is given precedence.
- Can be designed to be configured using the OSGi configuration ; in particular the:
- Service Ranking :Defines the order related to other conflict handlers ( service.ranking ).The default value is 0.
Behavior When Conflict Handling Deactivated
If you manually deactivate conflict handling then AEM takes no action on any conflicting pages (non-conflicting pages are rolled out as expected).
AEM does not give any indication that conflicts are being ignored as this behavior must be explicitly configured, so it is assumed that it is the required behavior.
In this case the live copy effectively takes precedence. The blueprint page /b is not copied and the live copy page /b is left untouched.
- blueprint: /bIs not copied at all, but is ignored.
- live copy: /bStays the same.
|blueprint after rollout||live copy after rollout||publish after rollout|
|b||b (no change; has the content of the page b that was manually created in the live copy branch)||b (no change; contains the content of the page b that was manually created in the live copy branch)|
|/bp-level-1||/lc-level-1 (no change)||/lc-level-1 (no change)|
The OSGi service ranking can be used to define the priority of individual conflict handlers.