MSM Best Practices msm-best-practices
General general
MSM is a configurable framework for automating content deployment. Implementations often involve major portions of a website and span organizations and geographies. It is therefore highly recommended to plan MSM implementations as carefully as you plan your website:
- Carefully plan structure and content flows before starting implementation.
- Customize as much as necessary, but as little as possible. While MSM supports a high degree of customization (for example, rollout configurations), typically the best practice for the performance, reliability and upgradeability of your website is to minimize customization.
- Establish a governance model early, and train users accordingly, to ensure success. A best practice from a governance point of view is to minimize the authority that local content producers have to allocate/connect content to other local users and their respective Live Copies. This is because un-governed, chained inheritances can significantly increase the complexity of a MSM structure and compromise its performance and reliability.
- Once a plan exists for your structure, content flows, automation, and governance, prototype and thoroughly test your system before starting a live implementation.
- Keep in mind that ÃÛ¶¹ÊÓƵ Consulting and leading System Integrators have deep experience planning and implementing content automation with MSM, so they can help you both get started with your MSM project and throughout its entire implementation.
Live Copy Sources and Blueprint Configurations live-copy-sources-and-blueprint-configurations
Keep in mind that a Live Copy can be created using either regular pages or a blueprint configuration. Both are valid use cases.
The additional benefits of using a blueprint configuration are that they:
- Allow the author to use the Rollout option on a blueprint to explicitly push modifications to Live Copies that inherit from this blueprint.
- Allow the author to use Create Site to easily select languages and configure the structure of the Live Copy.
- Define a default rollout configuration for Live Copies that have a relationship with the blueprint.
In the case that a blueprint configuration is not referenced, rollouts can only be initiated from the Live Copies themselves, essentially pulling content from source.
When creating a site with Live Copy, it is advantageous to create blueprint configurations to ensure the availability of the full MSM feature set.
Components and Container Synchronization components-and-container-synchronization
In general, the rollout rule in MSM regarding the synchronization of components is:
- Components are rolled out syncing any resources contained in the blueprint.
- Containers synchronize only the current resource.
This means that components are treated as an aggregate, and in a rollout the component itself and all its children are replaced with those in the blueprints. This means that if a resource is added to such a component locally, it is lost to the content of the blueprint at rollout.
To support the nesting of components such that locally added components are maintained in a rollout, the component must be declared as a container.
cq:isContainer to the component to designate it as a container.Create Site create-site
Notice that AEM has two main approaches for creating Live Copies:
-
When creating a Live Copy - This can be considered as the more generic approach, allowing you to create Live Copies from any page. The content structure of a Live Copy exactly matches the source.
-
When creating a Site - This is a more specialized approach, primarily for creating websites with a multilingual structure.
The following are a few considerations to keep in mind when creating a site:
- To create a site, you need a blueprint configuration.
- To allow the selection of language paths to create in a new site, the corresponding language roots must exist in the blueprint (source).
- Once a new site has been created as a Live Copy (using Create, then Site), the first two levels of this Live Copy are shallow. Children of the page do not belong to the live-relationship, but a roll-out will still descend if a live-relationship that matches the trigger is found.
It is helpful to avoid:
- Manually adding languages in the blueprint (below the first level).
- Manually adding content directly below the language root, as this does not result in automatically carrying this new content over to the Live Copy on rollout.
MSM and Multilingual Websites msm-and-multilingual-websites
MSM can assist in the creation of multilingual websites in two ways:
When creating language masters keep in mind the following:
-
While MSM itself does not provide content translation, it can be integrated with third-party translation connectors that do. Note the following:
-
MSM lets you cancel inheritance at the page and/or component level. This helps prevent overwriting translated content (from a Live Copy, with not-yet-translated content from a blueprint) on the next rollout.
- Some third-party translation connectors automate this management of MSM inheritances.
- Check with your translation service provider for more information.
- An alternative approach for creating and translating language masters is to use language copies in conjunction with AEM’s out-of-the-box translation integration framework.
-
For more information see Translating Content for Multilingual Sites and the Translation Best Practices.
Structure Changes and Rollouts structure-changes-and-rollouts
Modifications to the content structure in a blueprint/source tree are reflected differently in a Live Copy. This is dependent on the modification type:
-
Creating new pages in a blueprint will result in corresponding pages being created in Live Copies after rollout with the standard rollout configuration.
-
Deleting pages in a blueprint will result in corresponding pages being deleted from Live Copies after rollout with standard rollout configuration.
-
Moving pages in a blueprint will not result in corresponding pages being moved in Live Copies after rollout with standard rollout configuration:
-
The reason for this behavior is that a page move implicitly includes a page delete. This could potentially lead to unexpected behavior on publish, as deleting pages on author automatically deactivates corresponding content on publish. This can also have an additional effect on related items such as links, bookmarks, and others.
- Content inheritance in the respective Live Copy pages is updated to reflect the new location of their sources in the blueprint.
- To fully realize a page move from a blueprint to Live Copies, consider the page move best practices.
-
Page Move Best Practices page-move
When considering moving pages in a Live Copy, consider the following best practice.
-
Create a custom rollout configuration.
- This new configuration must include the action
PageMoveAction. - Do not add other actions to this configuration.
- This new configuration must include the action
-
Position the new configuration.
-
To fully roll out the page move while deleting respective pages at their old location in the Live Copy:
- Position the created configuration before the standard rollout configuration. The standard rollout configuration will take care of deleting the pages in their old locations.
- To roll out the page move while keeping respective pages in their old locations in the Live Copies (essentially duplicating the content):
- Position the created configuration after the standard rollout configuration. This will ensure no content is deleted in the Live Copy or deactivated from publish.
-
Customizing Rollouts customizing-rollouts
MSM rollout configurations are highly customizable. Automating rollouts can have far reaching consequences. As a best practice, you should plan very carefully before engaging in the following activities:
- Automating rollouts such as with onModify triggers
- Customizing node types/properties
- Starting subsequent workflows
- Activating content as part of rollouts
onModify onmodify
When using the rollout trigger onModify you should consider that:
-
Automating rollouts with
onModifytriggers may have a negative impact on authoring performance as they trigger rollouts after every page modification. -
The rollout result may differ from the one expected as:
- You cannot specify the order of the resulting modify events.
- The event-based architecture cannot guarantee the sequence of the events passed to the Rollout Manager.
-
Using such a rollout configuration could lead to commit conflicts if concurrent updates of the same resource occur.
Therefore, it is recommended that you only use onModify triggers if the benefits of automatic rollout initiation outweigh any potential performance issues.
Node Types/Properties node-types-properties
In addition to customizing rollout actions, MSM also lets you customize node properties that are being rolled out. The MSM OSGi configuration lets you exclude node types from being copied from the source to the Live Copy.
Further Information further-information
See the following articles for more details on MSM and Live Copy.