- Administering User Guide overview
- Sites Features
- Website Administration
- Asynchronous Jobs
- Reusing Content: Multi Site Manager and Live Copy
- Live Copy Overview Console
- Configuring Live Copy Synchronization
- Creating and Synchronizing Live Copies
- MSM Rollout Conflicts
- Troubleshooting MSM Issues and FAQ
- MSM Best Practices
- Translating Content for Multilingual Sites
- Managing Translation Projects
- Identifying Content to Translate
- Preparing Content for Translation
- Creating a Language Root Using the Classic UI
- Connecting to Microsoft Translator
- Configuring the Translation Integration Framework
- Language Copy Wizard
- Translation Enhancements
- Translation Best Practices
- Configurations and the Configuration Browser
- AEM FAQs
- Operations
- Dashboards
- Operations Dashboard
- Backup and Restore
- Data Store Garbage Collection
- Monitoring Server Resources Using the JMX Console
- Working with Logs
- Audit Log Maintenance in AEM 6
- Configure the Rich Text Editor
- Configuring RTE for Producing Accessible Sites
- Configuring Undo for Page Editing
- Configure the Rich Text Editor plug-ins
- Configure the Video component
- The Bulk Editor
- Configuring Email Notification
- The Link Checker
- Troubleshooting AEM
- Managing Access to Workflows
- Starting Workflows
- Administering Workflows
- Administering Workflow Instances
- Using cURL with AEM
- Proxy Server Tool (proxy.jar)
- Configuring for AEM Apps
- Configuring Search Forms
- Tools Consoles
- Reporting
- Configuring Layout Container and Layout Mode
- Editor
- Enabling Access to Classic UI
- Admin Consoles
- Security
- User Administration and Security
- User, Group and Access Rights Administration
- Security Checklist
- OWASP Top 10
- Running AEM in Production Ready Mode
- Identity Management
- Adobe IMS Authentication and Admin Console Support for AEM Managed Services
- Creating a Closed User Group
- Mitigating serialization issues in AEM
- User Synchronization
- Encapsulated Token Support
- Single Sign On
- How to Audit User Management Operations in AEM
- SSL By Default
- SAML 2.0 Authentication Handler
- Closed User Groups in AEM
- Granite Operations - User and Group Administration
- Enabling CRXDE Lite in AEM
- Configuring LDAP with AEM 6
- Configure the Admin Password on Installation
- Service Users in AEM
- Encryption Support for Configuration Properties
- Handling GDPR Requests for the AEM Foundation
- Principal View for Permissions Management
- Content Disposition Filter
- Custom User Group Mapping in AEM 6.5
- Same Site Cookie Support
- Personalization
- Integration
- Integrating with Third-Party Services
- Integrating with Salesforce
- Integrating with Adobe Target
- Integrating with Adobe Learning Manager
- Integrating with Adobe Analytics
- Connecting to Adobe Analytics and Creating Frameworks
- Configuring Link Tracking for Adobe Analytics
- Mapping Component Data with Adobe Analytics Properties
- Configuring Video Tracking for Adobe Analytics
- Integration with Adobe Analytics using IMS
- HTTP2 Delivery of Content FAQ
- Troubleshooting your Adobe Campaign Integration
- SharePoint Connector Licenses, Copyright Notices, and Disclaimers
- SharePoint Connector
- DHTML Viewer End-of-Life FAQs
- Integrating with Adobe Campaign Classic
- Related Community Articles
- Integrating with Adobe Campaign Standard
- Flash Viewers End-of-Life Notice
- Integrating with Adobe Dynamic Tag Management
- Opting Into Adobe Analytics and Adobe Target
- AEM Portals and Portlets
- Integrating with Dynamic Media Classic (Scene7)
- AEM Livefyre Recipes
- Troubleshooting Integration Issues
- Integrating with BrightEdge Content Optimizer
- Catalog Producer
- Integrating with Silverpop Engage
- Integrating with Adobe Campaign
- Integrating with ExactTarget
- Analytics with External Providers
- Integrating with the Adobe Marketing Cloud
- Manually Configuring the Integration with Adobe Target
- Prerequisites for Integrating with Adobe Target
- Integration with Adobe Target using IMS
- Adobe Classifications
- Solutions Integration
- Exporting Experience Fragments to Adobe Target
- Best Practices for Email Templates
- Integrating with Livefyre
- Best Practices
- Content Management
Configuring Live Copy Synchronization
Perform the following tasks to control how and when live copies are synchronized with their source content.
- Decide whether existing rollout configurations meet your requirements, or whether you need to create one or more.
- Specify the rollout configurations to use for your live copies.
Installed and Custom Rollout Configurations
This section provides information about the installed rollout configurations and the synchronization actions that they use, and how to create custom configurations if necessary.
Updating or changing an out of the box (installed) rollout configuration is not recommended. If there is a requirement for a custom live action then it should be added in a custom rollout configuration.
Rollout Triggers
Each rollout configuration uses a rollout trigger that causes the rollout to occur. Rollout configurations can use one of the following triggers:
-
On Rollout: The Rollout command is used on the blue print page, or the Synchronize command is used on the live copy page.
-
On Modification: The source page is modified.
-
On Activation: The source page is activated.
-
On Deactivation: The source page is deactivated.
Use of the On Modification trigger can impact performance. See MSM best practices for more information.
Installed Rollout Configurations
The following table lists the rollout configurations that are installed with AEM. The table includes the trigger and synchronization actions of each rollout configuration. If the installed rollout configuration actions do not meet your requirements, you can create a rollout configuration.
| Name | Description | Trigger | Synchronization Actions see also Installed Synchronization Actions |
|---|---|---|---|
| Standard rollout config | Standard rollout configuration which allows to start rollout process on rollout trigger and runs actions: create, update, delete content and order children nodes. | On Rollout | contentUpdate contentCopy contentDelete referencesUpdate productUpdate orderChildren |
| Activate on Blueprint activation | Publishes the live copy when the source is published. | On Activation | targetActivate |
| Deactivate on Blueprint deactivation | Deactivates the live copy when the source is deactivated. | On Deactivation | targetDeactivate |
| Push on modify | Pushes the content to the live copy when the source is modified. Use this rollout configuration sparingly as it uses the On Modification trigger. |
On Modification | contentUpdate contentCopy contentDelete referencesUpdate orderChildren |
| Push on modify (shallow) | Pushes content to the live copy when the blueprint page is modified, without updating references (for example, for shallow copies). Use this rollout configuration sparingly as it uses the On Modification trigger. |
On Modification | contentUpdate contentCopy contentDelete orderChildren |
| Promote Launch | Standard rollout configuration for promoting launch pages. | On Rollout | contentUpdate contentCopy contentDelete referencesUpdate orderChildren markLiveRelationship |
| Catalog Page Content Rollout Config | Applies page templates from a catalog blueprint. | On Rollout | contentUpdate contentCopy contentDelete referencesUpdate productCreateUpdate orderChildren |
| Catalog page update rollout config | Applies target properties from a catalog blueprint. Must run after Catalog Page Content Rollout Config. | On Rollout | catalogRolloutHooks |
| DPS Publications Rollout Config | DPS Publication rollout configuration which allows to start rollout process on rollout trigger while excluding FolioProducer binding properties on initial rollout | On Rollout | contentUpdate contentCopy contentDelete referencesUpdate orderChildren dpsMetadataFilter |
| Legacy (5.6.0) Catalog Rollout Config | Deprecated. Use Catalog Generator instead of MSM for catalog rollouts. | On Rollout | editProperties |
Installed Synchronization Actions
The following table lists the synchronization actions that are installed with AEM. If the installed actions do not meet your requirements, you can Create a New Synchronization Action.
| Action Name | Description | Properties |
|---|---|---|
| contentCopy | When nodes of the source do not exist on the live copy, copies the nodes to the live copy. Configure the CQ MSM Content Copy Action service to specify the node types, paragraph items, and page properties to exclude. |
|
| contentDelete | Deletes nodes of the live copy that do not exist on the source. Configure the CQ MSM Content Delete Action service to specify the node types, paragraph items, and page properties to exclude. |
|
| contentUpdate | Updates the live copy content with the changes from the source. Configure the CQ MSM Content Update Action service to specify the node types, paragraph items, and page properties to exclude. |
|
| editProperties | Edits properties of the live copy. The editMap property determines which properties are edited and their value. The value of the editMap property must use the following format:
The For example, consider the following value for editMap:
This value edits the properties of the live copy nodes as follows:
|
editMap: (String) Identifies the property, the current value, and the new value. See the Description for information. |
| notify | Sends a page event that the page has been rolled out. To be notified, one needs to first subscribe to rollout events. | |
| orderChildren | On the live copy, it orders the children (nodes), based on the order on the blueprint |
|
| referencesUpdate | On the live copy, this synchronization action updates references such as links. Configure the CQ MSM References Update Action service to specify the node types, paragraph items, and page properties to exclude. |
|
| targetVersion | Creates a version of the live copy. This action must be the only synchronization action included in a rollout configuration. |
|
| targetActivate | Activates the live copy. This action must be the only synchronization action included in a rollout configuration. |
|
| targetDeactivate | Deactivates the live copy. This action must be the only synchronization action included in a rollout configuration. |
|
| workflow | Starts the workflow that is defined by the target property (for pages only) and takes the live copy as payload. The target path is the path of the model node. |
target: (String) The path to the workflow model. |
| mandatory | Sets the permission of several ACLs on the live copy page to read-only for a specific user group. The following ACLs are configured:
Use this action for pages only. |
target: (String) The ID of the group for which you are setting permissions. |
| mandatoryContent | Sets the permission of several ACLs on the live copy page to read-only for a specific user group. The following ACLs are configured:
Use this action for pages only. |
target: (String) The ID of the group for which you are setting permissions. |
| mandatoryStructure | Sets the permission of the ActionSet.ACTION_NAME_REMOVE ACL on the live copy page to read-only for a specific user group. Use this action for pages only. | target: (String) The ID of the group for which you are setting permissions. |
| VersionCopyAction | If the blueprint/source page has been published at least once, creates a live copy page using the version that is published. Note: this action is only available for creating a live copy page based on a published source page, not for updating an existing live copy page. | |
| PageMoveAction | The PageMoveAction applies when a page has been moved in the blueprint. The action copies rather than moves the (related) LiveCopy page from the location before the move to the location after. The PageMoveAction does not change the LiveCopy page at the location before the move. Therefore, for consecutive RolloutConfigurations it has the status of a LiveRelationhip without Blueprint. Configure the CQ MSM Page Move Action service to specify the node types, paragraph items, and page properties to exclude. This action must be the only synchronization action included in a rollout configuration. |
prop_referenceUpdate: (Boolean) Set to true to update references. Default is true.
|
| productCreateUpdate | Creates or updates Product resources within a catalog. This action is meant to be used in one of the following situations:
|
|
| markLiveRelationship | Indicates a live relationship exists for launch-created content. | |
| catalogRolloutHooks | Executes catalog-generation-specific rollout hooks. Calls the executePageRolloutHooks and executeProductRolloutHooks methods of the CatalogGenerator. See com.adobe.cq.commerce.pim.api.CatalogGenerator in the AEM Javadocs. |
|
| productUpdate | Updates product pages in a live copy of a product catalog |
Creating a Rollout Configuration
You can create a rollout configuration when the installed rollout configurations do not meet your application requirements:
The new rollout configuration is then available to you when setting rollout configurations on a blueprint or live copy page.
Excluding Properties and Node Types From Synchronization
You can configure several OSGi services that support corresponding synchronization actions so that they do not affect specific node types and properties. For example, many properties and subnodes related to the internal functioning of AEM should not be included in a live copy. Only the content that is relevent to the user of the page should be copied.
When working with AEM, there are several methods of managing the configuration settings for such services; see Configuring OSGi for more details and the recommended practices.
The following table lists the synchronization actions for which you can specify the nodes to exclude. The table provides the names of the services to configure using the Web Console and the PID for configuring using a repository node.
| Synchronization Action | Service Name in Web Console | Service 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 |
The following table describes the properties that you can configure:
| Web Console property / OSGi property | Description |
|---|---|
Excluded Nodetypes cq.wcm.msm.action.excludednodetypes |
A regular expression that matches the node types to be excluded from the synchronization action. |
Excluded Paragraph Items cq.wcm.msm.action.excludedparagraphitems |
A regular expression that matches the paragraph items to be excluded from the synchronization action. |
Excluded Page Properties cq.wcm.msm.action.excludedprops |
A regular expression that matches the page properties to be excluded from the synchronization action. |
Ignored Mixin NodeTypes cq.wcm.msm.action.ignoredMixin |
Availalbe only for CQ MSM Content Update Action. A regular expression that matches the names of mixin node types to be excluded from the synchronization action. |
In the Classic UI, the lock icon that appears in the Page Properties dialog box for LiveCopy pages does not reflect the configuration of the Excluded Page Properties property. The lock icon appears even for properties that are excluded from the synchronization action.
In the touch-optimized UI see also Configuring MSM Locks on Page Properties(Touch-Optimized UI).
CQ MSM Content Update Action - Exclusions
Several properties and node types are excluded by default, these are defined in the OSGi configuration of CQ MSM Content Update Action, under Excluded Page Properties.
By default properties matching the following regular expressions are excluded (that is, not updated) on rollout:
You can change the expressions defining the exclusion list as required.
For example, if you want the page Title to be included in the changes considered for rollout, remove jcr:title from the exclusions. For example, with the regex:
jcr:(?!(title)$).*
Configuring Synchronization for Updating References
You can configure several OSGi services that support corresponding synchronization actions related to updating references.
When working with AEM, there are several methods of managing the configuration settings for such services; see Configuring OSGi for more details and the recommended practices.
The following table lists the synchronization actions for which you can specify the reference update. The table provides the names of the services to configure using the Web Console and the PID for configuring using a repository node.
| Web Console property / OSGi property | Description |
|---|---|
Update Reference across nested LiveCopies cq.wcm.msm.impl.action.referencesupdate.prop_updateNested |
Only available for CQ MSM References Update Action. Select this option (Web Console) or set this boolean property to true (repository configuration) to replace references that target any resource that is within the branch of the top-most LiveCopy. |
Update Referencing Pages cq.wcm.msm.impl.actions.pagemove.prop_referenceUpdate |
Only available for CQ MSM Page Move Action. Select this option (Web Console) or set this boolean property to true (repository configuration) to update any references to use the original page to instead reference the LiveCopy page. |
Specifying the Rollout Configurations to Use
MSM enables you to specify sets of rollout configurations that are used generally, and when required you can override them for specific live copies. MSM provides several locations for specifying the rollout configurations to use. The location determines whether the configuration applies to a specific live copy.
The following list of locations where you can specify the rollout configurations to use describes how MSM determines which rollout configurations to use for a live copy:
- Live copy page properties: When a live copy page is configured to use one or more rollout configurations, MSM uses those rollout configurations.
- Blueprint page properties: When a live copy is based on a blueprint, and the live copy page is not configured with a rollout configuration, the rollout configuration that is associated with the blueprint source page is used.
- Live copy parent page properties: When neither the live copy page nor the blueprint source page are configured with a rollout configuration, the rollout configuration that applies to the live copy page’s parent page is used.
- System default: When the rollout configuration of the live copy’s parent page cannot be determined, the system default rollout configuration is used.
For example, a blueprint uses the We.Retail Reference Site as source content. A site is created from the blueprint. Each item in the following list describes a different scenario regarding the use of rollout configurations:
- None of the blueprint pages or the live copy pages are configured to use a rollout configuration. MSM uses the system default rollout configuration for all the live copy pages.
- The root page of the We.Retail Reference Site is configured with several rollout configurations. MSM uses these rollout configurations for all the live copy pages.
- The root page of the We.Retail Reference Site is configured with several rollout configurations, and the root page of the live copy site is configured with a different set of rollout configurations. MSM uses the rollout configurations that are configured on the root page of the live copy site.
Setting the Rollout Configurations for a Live Copy Page
Configure a live copy page with the rollout configurations to use when the source page is rolled out. Child pages inherit the configuration by default. When you configure the rollout configuration to use, you are overriding the configuration that the live copy page inherits from its parent.
You can also configure the rollout configurations for a live copy page when you create the live copy.
-
Use the Sites console to select the live copy page.
-
Select Properties from the toolbar.
-
Open the Live Copy tab.
The Configuration section shows the rollout configurations that the page inherits.
-
If necessary, adjust the Live Copy Inheritance flag. If checked the live copy configuration is effective on all children.
-
Clear the Inherit Rollout Configuration From Parent property, then select one or more rollout configurations from the list.
The selected rollout configurations appear below the drop-down list.
-
Click Save.
Setting the Rollout Configuration for a Blueprint Page
Configure a blueprint page with the rollout configurations to use when the blueprint page is rolled out.
The child pages of the blueprint page inherit the configuration. When you configure the rollout configuration to use, you could be overriding the configuration that the page inherits from its parent.
- Use the Sites console to select the root page of the blueprint.
- Select Properties from the toolbar.
- Open the Blueprint tab.
- Select one or more Rollout Configurations using the drop-down selector.
- Persist your updates with Save.
Setting the System Default Rollout Configuration
Specify a rollout configuration to use as the sytem default. To specify the default, configure the OSGi service:
- Day CQ WCM Live Relationship Manager
the service PID iscom.day.cq.wcm.msm.impl.LiveRelationshipManagerImpl
Configure the service using either the Web Console or a repository node.
- In the web console, the name of the property to configure is Default rollout config.
- Using a repository node, the name of the property to configure is
liverelationshipmgr.relationsconfig.default.
Set this property value to the path of the rollout configuration to use as the system default. The default value is /libs/msm/wcm/rolloutconfigs/default, which is the Standard Rollout Config.
Resources
Adobe Account
