Troubleshooting MSM Issues and FAQ

Last update: February 5, 2025

CREATED FOR:

  • Admin

Troubleshooting First Steps

If you are experiencing what you think is incorrect behavior or an error in MSM, before beginning and detailed troubleshooting be sure to:

  • Check the MSM FAQ because your problems or questions may already be addressed there.
  • Check MSM best practices for several tips, together with clarification of certain misconceptions.

Finding advanced information about your blueprint and Live Copy status

MSM registers several servlets that can be requested with selectors on the resource URLs. These are used by the UI but can also be requested directly to see directly additional advanced computed MSM statuses for your pages:

  1. http://<host>:<port>/content/path/to/bluprint/page.blueprint.json?&maxSize=500&advancedStatus=true&returnRelationships=true&msm%3Atrigger=ROLLOUT

    • Use this on a blueprint page to retrieve the list of all Live Copies linked to it, with additional Live Copy status information.
    • for example:
      http://localhost:4502/content/wknd/language-masters/en.blueprint.json?&maxSize=500&advancedStatus=true&returnRelationships=true&msm%3Atrigger=ROLLOUT

  2. http://<host>:<port>/content/path/to/livecopy/page.msm.json

    • Use this on Live Copy pages to retrieve advanced information on their connection with their blueprint pages. If the page is not a Live Copy, nothing is returned.
    • for example:
      http://localhost:4502/content/wknd/ca/en.msm.json

Those servlets generate DEBUG Log messages through the com.day.cq.wcm.msm logger that can also be helpful.

Checking MSM-specific information in the repository

The prior servlets returned computed information based on the MSM-specific nodes and mixins. The information is stored in the repository in the following way.

  • cq:LiveSync mixin type

    • This is set on jcr:content nodes and define root Live Copy pages.

    • Those pages have a cq:LiveSyncConfig child node of type cq:LiveCopy that contains basic and mandatory information on the Live Copy through the following properties:

      • cq:master points to the blueprint page of the Live Copy.
      • cq:rolloutConfigs indicates active rollout configurations applied to the Live Copy.
      • cq:isDeep is true if the child pages of this root Live Copy page are included in the Live Copy.

  • cq:LiveRelationship mixin type

    • Any Live Copy page has such a mixin type on its jcr:content node.
    • If it does not, the page at some point has been detached or manually created via the authoring interface outside of a Live Copy action (create or roll out).

  • cq:LiveSyncCancelled mixin type

    • Added to jcr:content nodes of Live Copy pages that were suspended.
    • If the suspension is effective for child pages as well, a cq:isCancelledForChildren property is set to true on the same node.

The information present in these properties should be reflected in the UI, however when troubleshooting it may be helpful to observe MSM behavior directly in the repository as MSM actions occur.

Knowing those properties can also be useful so you can query your repository and find out sets of pages that are in particular states. For example:

  • select * from cq:LiveSync returns all Live Copy root pages.