Multi Site Manager

You are reading the Adobe Experience Manager 5.6.1 version of Multi Site Manager.
This documentation is also available for the following versions: AEM 5.6  CQ 5.5  CQ 5.4  CQ 5.3 

Multi Site Manager (MSM) enables you to easily manage multiple web sites that share common content. MSM lets you define relations between the sites so that content changes in one site are automatically replicated in other sites.

For example, web sites are often provided in multiple languages for international audiences. When the number of sites in the same language is low (three to five), a manual process for syncronizing content across sites is possible. However, as soon as the number of sites grows or when multiple languages are involved, it becomes more efficient to automate the process.

MSM reduces the time it takes to manage your websites and increases the re-use of common content:

  • Efficiently manage different language versions of a website.
  • Automatically update one or more sites based on a source site:
    • Enforce a common base structure and use common content across multiple sites.
    • Maximize the use of available resources.
    • Maintain a common look and feel.
    • Focus efforts on managing the content that differs between the sites.

The content and structure that a site inherits from the source site can be managed at a page and paragraph level. Generally, using MSM involves performing the following tasks:

  • Identifying the source content.
  • Identifying the location of the copy.
  • Configuring what items of source content are automatically updated in the copy.
  • Configuring when content updates occur in the copy. 

Typical Use Cases for the Multi Site Manager

This section describes several scenarios where using the MSM is easier than maintaining sites manually.

Multinational Site

ENT Corporation, a large distributed enterprise, has a large number of subsidiaries in various countries. All of them share a similar look-and-feel. These sites share various components and most are centrally hosted.

Corporate Communications at ENT use MSM features to propagate press release content to the various press release pages of each of the countries' websites. The press releases section of the source website is configured to be mandatory for all countries' websites.

Additionally, the Knowledge Management department at ENT has gathered a large collection of FAQs that apply to most countries. To allow the surfer to access the FAQ that is appropriate to his or her country, this content is configured to be optional on the MSM source site. As a result, the owner of a particular country's web site can subscribe to the content that is appropriate for that site. 

Some time later, because of the reorganization of the site, the press releases section is moved to another location in the navigation on the source site. Because of MSM, this change is reflected automatically in all subsidiary sites.

Multilingual Site

UNORG, a multinational organization, hosts a website in 15 languages. Multilingual websites often share a number of characteristics:

  • Content trees are not identical in different languages.
  • There is almost never a "base" language in which all the content is available.
  • It is not just about text (images mean different things in different cultures).
  • Internal document structures (content objects) in different languages, or even different geographies with the same language, are often different, for example, because of differing legal requirements.
  • Switching to a default language for some content is not effective. For example, a French surfer does not appreciate suddenly being thrown into a section of English content.

Despite the differences between different language sections, there is also a certain coherence between the languages that needs to be maintained.

The Language Manager monitors the differences between language sections and allows for the clean up of any differences between the various language trees, thus helping to keep the sections synchronized.

Multinational Multilingual Site

ENT Corporation, a large distributed enterprise, with a large number of subsidiaries also has a number of subsidiaries in countries like Switzerland, Belgium, and Canada that have to support a number of different languages per national site. But the set of supported languages per site must be decided on a per-country basis.

The combination of the Language Manager and the Multi-Site Manager lets you precisely control which content is visible in which country and how the various languages are managed and kept synchronized on a per-country level.

Managing Different Language Versions of a Website

This section describes how to add a new language version of a web site and how to change language names and default countries. To use MSM for managing language versions of a website, the website must use the following structure:

  • The web site has a single page as the root.
  • Each child page is the root page of each language version.
  • The name of the child page is the language code.

The sample Geometrixx Demo Site illustrates this structure.

file

After you create the root page of a language version, you can generate content for the language version using copies of pages that exist in other language versions.

Adding a new language version

The following procedure adds a language version of a web site using the Language Copy tool and the classic AEM UI.

  1. In the Websites console, in the Websites tree, select the root page of the site. (http://localhost:4502/siteadmin#)

  2. Add a new child page that represetns the language version of the site:

    1. Click New > New Page.

    2. In the dialog, specify the Title and the Name. The Name needs to be in the format of <language-code> or <language-code>_<country-code>, for example en, en_US, en_us, en_GB, en_gb.
      • The supported language code is lower-case, two-letter code as defined by ISO-639-1
      • The supported country code is lower-case or upper-case, two-letter code as defined by ISO 3166
    3. Select the Template and click Create.
    file
  3. In the Websites console, in the Websites tree, select the root page of the site.

  4. In the Tools menu, select Language Copy.

    file

    The Language Copy dialog displays a matrix of available language versions and web pages. An x in a language column means that the page is available in that language.

    file
  5. To copy an existing page or page tree to a language version, select the cell for that page in the language column. Click the arrow and select the type of copy to create.

    In the following example, the equipment/sunglasses/irian page is being copied to the French language version.

    file
    Type of language copy Description
    auto Uses the behavior from parent pages
    ignore Does not create a copy of this page and its children
    <language>+ (e.g. French+) Copies the page and all its children from that language
    <language> (e.g. French) Copies only the page from that language
  6. Click OK to close the dialog.

  7. In the next dialog, click Yes to confirm the copy.

Changing language names and default countries

AEM uses a default set of language and country codes. 

  • The default language code is the lower-case, two-letter code as defined by ISO-639-1.
  • The default country code is the lower-case or upper-case, two-letter code as defined by ISO 3166.

MSM uses a stored list of language and country codes to determine the name of the country that is associated with the name of the language version of your page. You can change the following aspects of the list if required:

  • Language titles
  • Country names
  • Default countries for languges (for codes such as "en,""de," and so on)

The language list is stored below the  /libs/wcm/core/resources/languages node. Each child node represents a language or a language-country:

  • The name of the node is the languge code (such as en or de), or the language_country code (such as en_us or de_ch).
  • The language property of the node stores the full name of the language for the code.
  • The country property of the node stores the full name of the country for the code.
  • When the node name consists only of a language code (such as en), the country property is *, and an additional defaultCountry property stores the code of the language-country to indicate the country to use.
file

To modify the languages:

  1. Open CRXDE Lite in your web browser. (http://localhost:4502/crx/de)

  2. Select the /apps folder and click Create > Create Folder. Name the folder wcm.

  3. Repeat the previous step to create the /apps/wcm/core folder tree. Create a node of type sling:Folder in core called resources.

    file
  4. Right-click the /libs/wcm/core/resources/languages node and click Copy.

  5. Right-click the /apps/wcm/core/resources folder and click Paste. Modify the child nodes as required.

  6. Click Save All.

  7. Click Tools > Server Config to open the Web Console. Click OSGi > Configuration.

  8. Locate and click Day CQ WCM Language Manager, and change the value of Language List to /apps/wcm/core/resources/languages, then click Save.

    file

Managing the Translation of your Language Branches

When your website consists of several language branches and when you create a new page in your reference language branch, you can start a translation workflow that automatically creates new pages in the language branches of your choice and helps you translate the pages by displaying side-by-side the page to be translated and the reference page.

This procedure describes how to start the translation workflow and how to display the reference page beside the page that needs to be translated.

The website must have at least two language branches.

  1. In the Websites tab create a new page in your reference language branch, for example, English.

  2. Open the new page and add the desired text.

  3. In the Sidekick, open the Workflow tab, then expand the Translation group:

    1. Check the language branch(es) into which you would like to have a new page created.
    2. In the Workflow drop-down menu, select Translation.
    3. Click Translate.

    The reference page is being copied into the selected language branch(es).

  4. Activate the reference page. A new version of the page is created.

  5. Open the page that needs to be translated. Edit the text that has been copied from the reference page and translate it. Save your changes.

  6. Open the reference page and add new content to it.

  7. Activate the reference page. A new version of the page is created.

  8. Open the page that needs to be translated.

  9. In the Sidekick, open the Workflow tab, then expand the Translation group. Here you will see the changes that have been made in the reference page since a specified version. Select a particular version and click Show Side-By-Side.  Now, in the right pane you will see a diff of the reference page's latest content vs. the version you selected.

    Note

    The Show Side-By-Side button is only shown when the page is opened together with the Content Finder.

    file
  10. The reference page is displayed to the right of the page that needs to be translated. The text that has been added since the selected version is green, removed text is red with a strike through it and modified text is highlighted yellow.

    file

    The reference page is only displayed and cannot be edited.

  11. On the left side, edit and translate the text. Save your changes.

  12. To close the view of the reference page, click Hide in the Sidekick.

Repeat previous steps every time new content is added to the reference page and needs to be translated in one or more language branches.

Creating Blueprints and Live Copies

MSM enables you to create a copy of an existing site and automatically update the copy with changes that occur to the source site. The copy is called a Live Copy. 

For each Live Copy, a Rollout Config determines how content is automatically updated. A Rollout Config consists of the following items:

  • An event that triggers the update, such as a change to the content of the source page.
  • One or more actions that occur, such as updating the content on the Live Copy.

Live Copy pages can use any page as the source. A Live Copy can also use a blueprint as the source. Blueprints define a source website for Live Copy pages and consist of the following items:

  • The path of the root page of a website. The path defines the pages that are copied as Live Copy pages.
  • One or more Rollout Configs. Live Copy pages made from blueprints inherit the blueprint Rollout Configs.

Blueprints provide control over the generation of Live Copy pages, however websites must have a specific structure to be used as a blueprint. (See Creating a Blueprint.) Creating Live Copy pages from non-blueprint pages is more flexible but they are more difficult to track. (See Creating a Live Copy Based On an Existing Branch or Page.)

CQ provides the Blueprint Control Center tool for tracking the status of blueprint content and the Live Copy pages that have been generated from them.

Note

A live copy can only be linked to one blueprint.

A blueprint can be linked to several live copies.

Creating a Live Copy Based on an Existing Branch or Page

Create a Live Copy of any page and its child pages, or of a single page. When you create the Live Copy, you can optionally specify the rollout configurations to use for automatically updating the content:

  • The selected rollout configurations apply to all of the Live Copy pages that are created for the source page and its child pages.
  • If you specify no rollout configurations, either the system default rollout configuration is used, or the default rollout configuration for the branch is used. (See set a default rollout configuration for a branch.)

The following procedure creates a Live Copy using the classic UI.

  1. Open the Websites console.
  2. Select the folder or page below which you want to locate the Live Copy pages.
  3. Click New > New Live Copy.
  4. In the Source selection tab, define the Live Copy:
    • Title: The title of the root Live Copy page, e.g. My Geometrixx Live Copy
    • Name: The name of the page node, e.g. mygeometrixx_livecopy
    • Live Copy From: Browse to select the page to use as the source of the Live Copy, e.g. /content/geometrixx
    • Exclude sub pages: Select this option to exclude the child pages from the Live Copy.
  5. On the Sync config tab, specify one or more Rollout Configs to use for the Live Copy. For information about each Rollout Config, see Rollout Configurations Available in CQ.
  6. Click Create.

Note

In the Websites console, you can create a live copy by holding the Ctrl-Shift keys and dragging and dropping a page into the location of your choice. Refresh the tree-browse panel to view the live copy icon.

Creating a Blueprint

Create a blueprint to identify an existing web site that you want to use as the source for one or more Live Copy pages. When you create a blueprint, you select a template that defines the internal structure of the blueprint. The default Blueprint Template assumes that the source web site has the following characteristics:

  • The web site has a root page.
  • The immediate child pages of the root are language branches of the web site. The Name of each page is a language code. When creating a Live Copy, the languages are presented as optional content to include in the copy.
  • Each language page contains one or more child pages. When creating a Live Copy, child pages are presented as a chapter that you can include in the copy.

For example, the Geometrixx Demo Site contains language folders named en, fr, de, es, it, ja, and zn. The language folders contain chapters such as toolbar, products, and services.

file

 

Using a blueprint has the following advantages over creating a Live Copy from a page:

  • Blueprints define a source that is consistent for multiple Live Copies.
  • Blueprints define the rollout configurations that are consistently used by all Live Copies.
  • Blueprints can be rolled out, pushing the modifications to all Live Copies. (See Rolling Out Changes To The Live Copy (Manually)

To create a blueprint:

  1. Open the Tools console.
  2. Select Tools, then MSM Control Center. Click New... in the top-middle toolbar.
  3. In the Create Page dialog, define the blueprint:
    • Title, the page title, e.g. My Blueprint
    • Name, the page (node) name, e.g. myblueprint
    • Select the Blueprint Template
    Click Create.
  4. Open the newly created page and click the Edit button beside Settings.
  5. In the Blueprint Settings dialog, define the blueprint:
    • Name, the blueprint name that was defined earlier can be changed.
    • Description, e.g. This is my blueprint
    • Source Path: set the path of the blueprint, e.g. /content/geometrixx
    • Thumbnail Image (optional): this thumbnail will appear in the live copy creation.

The following procedure uses the classic UI to change the properties of a blueprint.

  1. In the Websites folder tree of the Websites console, select the parent page or folder of the blueprint site.

  2. In the list of pages, right-click root page of the blueprint and click Properties.

  3. Click the Blueprint tab, modify the properties, and click OK.

    When the page is not a blueprint, the Blueprint tab is disabled.

Creating a Live Copy Based on a Blueprint

Create a Live Copy of a blueprint to create a site based on the blueprint content. When you create a Live Copy of a blueprint, you select one or more language branches of the blueprint source to copy and then you select the chapters to copy from the language branches. (See the previous Creating a Blueprint section.)

If you omit some language branches or chapters from the Live Copy, you can add them later. (See Creating a Live Copy Within a Live Copy.) 

Note

When the blueprint source contains links and references that target a paragraph in a different chapter, the targets are not updated in the Live Copy pages. For example, a Live Copy is created from the Geometrixx Demo Site blueprint. Any links from the Toolbar chapter to the Services chapter are not updated in the Live Copy, and continue to target the original pages in the Geometrixx Demo Site Services pages.

The Rollout Configs that are used for the Live Copy are inherited from the blueprint. However, when creating the Live Copy, you can override the blueprint and specify the Rollout Configs to use. The following procedure creates a Live Copy from a blueprint using the classic UI.

  1. Open the Websites console.
  2. Select the folder or page below which you want to locate the Live Copy pages.
  3. Click New > New Site.
  4. In the Create Site dialog, define:
    • Title: The title of the root page of the Live Copy, e.g. My Geometrixx Live Copy
    • Name: The name of the page node, e.g. mygeometrixx_livecopy
    • Select the blueprint to use as the source and click Next.
  5. Select the language versions of the blueprint site to include in the Live Copy, and click Next.
  6. Select the chapters to include in the Live Copy and click Next.
  7. Specify values for the following properties to define the Live Copy:
    • Site Owner: choose an existing user. Note: The Site Owner entry is a descriptive property and does not affect feature behavior.
    • Live Copy: Clearing this option creates a static copy of the blueprint.
    • Rollout Configs: Select one or more Rollout Configs to override the blueprint. Specify no Rollout Configs to use those that the blueprint defines. For information about available Rollout Configs, see Rollout Configurations Available in CQ.
  8. Click Next.
  9. Click Create Site.

Creating a Live Copy for different Channels

The Geometrixx Outdoors Mobile  Site has a setup that enables to create a special live copy from the Geometrixx Outdoors Site (the standard, non-mobile one): when the live copy is created and when the standard site is rolled out, the content of the mobile site is synced with the standard site and the rendering components are transformed into mobile ones (the sling:resourceType properties are rewritten) to best suit the rendering on mobile devices.

The following process shows how to create a live copy of the Geometrixx Outdoors Community branch within the Geometrixx Outdoor Mobile site:

  1. Open the Websites console.
  2. In the left panel, select the folders Websites > Geometrixx Outdoors Mobile Site > English.
  3. Expand the New... menu and select New Live Copy...
  4. In the Source selection tab, define the live copy:
    • Title, the page title, e.g. Support
    • Name, the page (node) name, e.g. support
    • Live Copy From: /content/geometrixx-outdoors/en/support
    • Exclude sub pages: uncheck this box.
  5. In the Sync config tab, add a rollout configuration and select Geometrixx Outdoors Mobile.
  6. Click Create.

Note

The Geometrixx mobile rollout config is specific to the Geometrixx site as it depends on the Geometrixx templates and component.

To enable this feature for your own site, you need to create your own mobile rollout configuration by adapting the Geometrixx mobile rollout config: please refer to the section Creating a Rollout Configuration.

Creating a Live Copy within a Live Copy

CQ enables you to create a Live Copy within another Live Copy. The process is similar to the one described in Creating a Live Copy Based on an Existing Branch or Page, except that you select a page of an existing Live Copy as the parent of the new Live Copy.

When you insert a Live Copy into the Live Copy of a blueprint, you can insert any language versions or chapters that were not included when the Live Copy of the blueprint was originally created. For example, a Live Copy of the Geometrixx Demo Site blueprint is created, but only the English version is included in the LiveCopy, and only a some of the English chapters were included. 

file

In this case, you can insert the content of the Geometrixx Demo Page blueprint that was not included:

  • Select the root page of the Live Copy to insert one or more of the language versions.
  • Select the English page of the Live Copy to insert any of the chapters that were not included.

When you are inserting a Live Copy into a Live Copy of a blueprint, and the Live Copy does not include all content of the blueprint, the Create Live Copy dialog includes a collapsible fieldset called Select missing pages. You use this fieldset to add the missing content. 

To insert a Live Copy of other content, use the Or Choose Live Copy Source fieldset to select the source content as you normally would.

file

Overriding Live Copy Configurations

When you create a Live Copy, the Live Copy configuration is saved to the properties of the root page of the copied pages. All child pages of the root page inherit the Live Copy configurations. The Live Copy configuration is applied to all components on each of the copied pages. Components within container components inherit the status of the container component.

You can override the Live Copy configurations for any page that inherits the root Live Copy page, as well as for any component on a Live Copy page.

Overriding Live Copy Inheritance for Components On a Page

When you open a Live Copy page, a closed or an open lock icon represents the Live Copy inheritance status for each component. The inheritance for a component can be disabled or enabled.

Live Copy Inheritance Status Description
Enabled

Modifications to the source component are propagated to the Live Copy component.This is the default status when a Live Copy page is created.  

The status icon is a locked padlock and the component border is green when it is highlighted. 

Disabled

Deletion, update or reordering of the source component does not affect the Live Copy component. The component has this status under the following conditions:

  • The Live Copy component has been modified, for example the text or styles are edited.
  • Inheritance is disabled.

When a Live Copy component container (such as a paragraph system) has this status, the order of the components inside the container is not inherited from the source.

The status icon is an unlocked padlock and the component border is green when it is highlighted.

Note

When no Live Copy inheritance status appears for a component, the component was added to the Live Copy page and does not exist on the source page.

The following example shows a Live Copy page and the Live Copy inheritance status icons for each component:

file
  1. Open the Live Copy page.

  2. In Sidekick, click the Live Copy Status button to view the status of all the components of the page.

    file

    This button appears only when you are editing a Live Copy page.

  3. Locate the component in which you are interested and note the Live Copy status icon.

  4. Click the Live Copy status icon to toggle inheritance, then click Yes in the dialog to confirm the change.

    Note: You can also change the Live Copy inheritance status using the component Edit dialog box. The status icon appears in the bottom left-hand corner of the edit dialog.

Deleting and Restoring Components on Live Copy Pages

Delete a component from a Live Copy page when the content is not needed. When you delete a component, a placeholder appears in its place, and includes the message Placeholder for a deleted Inherited Component.

file

If you decide that the conent is needed, you can restore the component. To restore, right-click the placeholder and click Restore.

file

You can restore a component even if the source component is deleted from the source page after the Live Copy component was deleted. In this situation, the component is restored from the last version of the Live Copy page that included the component.

Overriding Live Copy Inheritance and Rollout Configurations for a Page

For any page in a Live Copy, you can override the inherited Live Copy configurations:

  • Disable the Live Copy inheritance for child pages. Child pages and their components no longer behave as Live Copy pages.
  • Suspend Live Copy rollouts for the page. The actions of the Rollout Configs of the page do not occur. Optionally, you can also suspend rollouts for child pages.
  • Change the rollout configurations that are applied to the page. 
  1. Open the page properties dialog of the Live Copy page using either of the following methods:

    • On the Siteadmin page, right-click that page and click Properties.
    • With the pag open in Edit mode, on the Page tab of SideKick click Page Properties.
  2. Click the Live Copy tab and configure the following properties:

    • Live Copy Inheritence: Select to cause child pages to inherited the Live Copy configruation of the current page. This property is selected by default.
    • Live Copy Suspended: Select to suspend rollout actions for this page.
    • Suspend For Children Pages: Select to suspend Live Copy inheritance from child pages. This option appears when Live Copy Suspended is selected.
    • Rollout Config: Add or remove the Rollout Configs to apply to the page. (See Installed Rollout Configurations.)
  3. Click OK.

Overriding Page Properties on a Live Copy page

The page properties of a Live Copy page are inherited from the source page by default. When you open the page properties of a live copy page, you can view the inheritance status of each property, represented by a closed or an open lock icon. The inheritance for a page property can be cancelled or restored.

To cancel the inheritance of a page property in a live copy page:

  1. Open page properties of a live copy page.
  2. Click the lock icon beside a locked property.
  3. Click Yes to cancel the inheritance. An open lock icon is displayed beside the property.
  4. You can now modify the property.
  5. Click OK to save the changes.

To restore the inheritance of a page property, apply the same procedure to an unlocked property.

The page properties of a live copy page look as follows:

file

Note

By default some page properties are excluded from the MSM inheritance process. The excluded page properties can be configured. See How to define the properties and the nodes that are copied to the Live Copy.

Specifying Default Rollout Configurations

To use a rollout configuration, you apply it to blueprint and/or live copy pages. The following logic determines which rollout configuration to use for a live copy page:

  • When a live copy page has a rollout configuration, that configuration is used.
  • When a live copy page does not have a rollout configuration, the rollout configuration of the corresponding blueprint page is used.
  • When both the live copy page and the blueprint page have no rollout configuration, the rollout configuration that applies to the live copy page's parent page is used.
  • When the rollout configuration of the live copy's parent page cannot be determined, the default rollout configuration is used.

The default configuration can either be:

Setting a Default Rollout Configuration for a Branch

To set a default rollout configuration for a branch:

  1. In CRXDE, go to the jcr:content node of the page.
  2. Create the following node below jcr:content:
    • name: cq:LiveSyncConfig
    • type: nt:unstructured
  3. Create the following property for the cq:LiveSyncConfig node:
    • name: cq:rolloutConfigs
    • type: String[]
    • value: the path to the rollout configuration, e.g.: /etc/msm/rolloutconfigs/mobile
  4. Save the changes.

Changing the System Default Rollout Configuration

The system default rollout configuration is set to: /etc/msm/rolloutconfigs/default.

When working with AEM there are several methods of managing the configuration settings for such services; see Configuring OSGi for full details. For example:

  1. Go to the Configuration tab of the Web Console:
    http://localhost:4502/system/console/configMgr
  2. Open the Day CQ WCM Live Relationship Manager configuration window.
  3. In Default rollout config, set the path of the default rollout configuration.
  4. Click Save.

Configuring Live Copy Synchronization

Define rollout configurations that can be applied to blueprint and live copy pages. A rollout configuration consists of an event and one or more synchronisation actions:

  • An event is a page event that occurs on the blueprint, such as a page activation.
  • Synchronisation actions are performed on the live copy or the blueprint. Example actions are ordering child nodes and activating the live copy page.

When you configure a rollout, you define the actions that are performed on a live copy page when a specific event occurs on the blue print. 

Installed Rollout Configurations

The following rollout configurations are installed by default:

Configuration Name Event on the Source Page that Triggers the Action Performed Actions on the Live Copy
Standard rollout config On Rollout contentUpdate
contentCopy
contentDelete
referencesUpdate
orderChildren
Activate on Blueprint activation On Activation targetActivate
Deactivate on Blueprint deactivation On Deactivation targetDeactivate
Push on modify On Modification contentUpdate
contentCopy
contentDelete
referencesUpdate
orderChildren
Geometrixx Mobile On Rollout contentUpdate
contentCopy
contentDelete
editProperties
referencesUpdate
orderChildren
Geometrixx Outdoors Mobile On Rollout editProperties
Geometrixx Outdoors Mobile Teaser On Rollout editProperties

Creating a Rollout Configuration

Create a rollout configuration when the installed rollout configurations do not meet your application requirements. Create the rollout configuration, then add the trigger and synchronazion actions. The new rollout configuration is available when setting rollout configurations on a blueprint or on a Live Copy page.

The following events are available to use as synchronization triggers:

  • On Rollout: The blueprint page is rolled out.
  • On Modification: The source page is modified. Be careful when choosing this option as it might cause a lot of network traffic.
  • On Activation: The source page is activated.
  • On Deactivation: The source page is deactivated.

To create the rollout configuration and add the synchronization trigger, use the Tools console. To add the synchronization actions, use CRXDE Lite.

The following procecure uses the classic UI to create the rollout configuration and add the trigger.

  1. Go to the Tools console. (http://localhost:4502/miscadmin#/etc)

  2. In the folder tree, select the Tools/MSM/Rollout Configurations folder.

  3. Click New > New Page and provide values for the Rollout Configuration properties:

    • Title: The title of the Rollout Configuration, such as My Rollout Configuration
    • Name: The name of the node that stores the property values, such as myrolloutconfig
    • Select RolloutConfig Template.
  4. Click Create.

  5. Open the rollout configuration that you created.

  6. Click Edit.

  7. In the Rollout Config dialog, use the Sync Trigger drop-down menu to select the action that causes the rollout to occur.

  8. Click OK to save the changes.

Use the following procedure to add synchronization actions to the rollout configuration. Rollout configurations are stored below the /etc/msm/rolloutconfigs node. Add cq:LiveSyncAction child nodes to add synchronization actions to the rollout configuration. The order of the syncronization action nodes determines the order in which the actions occur.

  1. Open CRXDE Lite. (http://localhost:4502/crx/de)

  2. Select the jcr:content node below your rollout configuration node. For example, for the rollout configuration with the Name property of myrolloutconfig, select the /etc/msm/rolloutconfigs/myrolloutconfig/jcr:content node.

  3. Click Create > Create Node, configure the following node properties and click OK:

    • Name: The node name of the synchronization action. The name must be the same as teh Action Name in the table Synchronisation Actions, for example contentCopy, or workflow
    • Typecq:LiveSyncAction
  4. Select the action node that you created and add the following property to the node:

    • Name: The property name of the action. The name must be the same as  the Property Name in the table Synchronisation Actions, for example enabled
    • Type: String
    • Value, the property value of the action. For valid values, see the Property Value column in Synchronisation Actions, for example true.
  5. Add and configure as many syncronization action nodes as you require. Rearrange the action nodes so that their order matches the order in which you want them to occur. The topmost action node occurs first.

  6. Click Save All.

Synchronisation Actions

The following synchronisation actions are available in CQ and can be applied.

For information about creating custom synchronization actions, see Creating a New Syncronization Action.

Title Description Action Name Property Name
Property Value
Copy content On the live copy, it copies the nodes that exist on the blueprint and that do not exist on the live copy
contentCopy enabled
true
Delete content

On the live copy, it deletes the nodes that once existed on the blueprint and that do not exist on the blueprint anymore

contentDelete enabled true
Update content Updates the live copy content with the changes from the blueprint.
contentUpdate enabled true
Edit properties

On the live copy, it edits properties of the live copy: the selection of the properties and their transformation is done by setting a value to the editMap property. editMap needs to have the following format:

[property 1]#[current value (regex)]#[new value (regex)], ...,
[property x]#[current value (regex)]#[new value (regex)]

Example: setting editMap to:

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

transforms the properties of live copy nodes as follows:

- all the sling:resourceType that are either set to contentpage or to homepage are set to mobilecontentpage and

- all the cq:template that are set to contentpage are set to mobilecontentpage

editProperties

enabled

editMap

true

String expression

Send a notification Sends a page event that the page has been rolled out. In order to be notified, one needs to first subscribe to rollout events. notify enabled true
Order children On the live copy, it orders the children (nodes), based on the order on the blueprint
orderChildren enabled true
Update references On the live copy, it updates the references (like links).
It searches for the paths in the live copy pages that point to a resource within the blueprint and replaces them with the paths to the related resource inside the live copy.
referencesUpdate enabled true
Create version of source page Creates a version of the blueprint sourceVersion enabled true
Create version of target page Creates a version of the live copy
targetVersion enabled
true
Activate target page Activates the live copy
targetActivate enabled
true
Deactivate target page Deactivates the live copy
targetDeactivate enabled
true
Start target 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, for example /etc/workflow/models/request_for_activation/jcr:content/model

workflow target
<workflow model path>
Set readonly ACLs on page structure and content to target group Set read-only to group defined in the action config of the relationship (for pages only). Denied ACL are:
 * ActionSet.ACTION_NAME_REMOVE
 * ActionSet.ACTION_NAME_SET_PROPERTY
 * ActionSet.ACTION_NAME_ACL_MODIFY
mandatory target
<group ID>
Set readonly ACLs on page content to target group Set read-ony to group defined in the action config of the relationship (for pages only). Denied ACL are:
 * ActionSet.ACTION_NAME_SET_PROPERTY
 * ActionSet.ACTION_NAME_ACL_MODIFY
mandatoryContent target <group ID>
Set readonly ACLs on page structure to target group Set read-ony to group defined in the action config of the relationship (for pages only). Denied ACL are:
 * ActionSet.ACTION_NAME_REMOVE
mandatoryStructure target <group ID>
VersionCopyAction If the source page has been published at least once, update the target using the revision that has been published.  VersionCopyAction    

Excluding Properties and Node Types From Synchronization

When a content update, copy or delete from blueprint to livecopy is performed, the system does not copy or delete every node and property from the source to the target node. There are, for example, many properties and subnodes related to the internal functioning of CQ itself, that is does not makes sense to treat in this manner. Only the true user-relevant "content" of the page should be copied.

To ensure this, CQ has a set of filters that prevent certain nodes and properties from being copied or deleted in this situation. These nodes and properties are defined by node type and/or explicit name and are configured in the System Console (http://<host>/system/console/configMgr) in the following sections:

  • CQ MSM Content Copy Action
  • CQ MSM Content Delete Action
  • CQ MSM Content Update Action
file

For example, by default the CQ MSM Content Update Action configuration panel specifies under Excluded Page Properties that properties matching the regular expressions jcr:*, sling:* and cq:* will not be updated on rollout.

file

In most cases the default settings need not be changed, however, if necessary the following can be configured:

  • Ignored Mixin Nodetypes
  • Excluded Page Properties
  • Excluded Paragraph Items
  • Excluded Nodetypes

Caution

Prior to 5.5 SP2 the excluded page properties were configured in the system console under the Day CQ WCM Rollout Manager. With 5.5 SP2 and later versions the excluded page properties settings within that panel are ignored. Property exclusion on rollout is configured as described above, in CQ MSM Content Update Action.

Therefore, if you have manually adjusted this setting in a pre-5.5 SP2 installation and are upgrading to 5.5 SP2 or later version, you must manually transfer these settings from the old configuration panel to the new one.

Administering Blueprint and Live Copy Pages

Several tools and features are available for monitoring blueprint and live copy pages and their synchronization.

Rolling out Changes to the Live Copy (Manually)

Rolling out consists of propagating the changes made on the blueprint to the live copy. Only live copy pages that have a rollout configuration with the cq:trigger property set to rollout can be rolled out.

The following rules apply for a rollout:

  • A rollout can only be triggered on the blueprint.
  • A rollout can be triggered for one page or for a page and all its sub-pages.
  • A rollout can be triggered for a (page) component.

There are several ways to perform a rollout:

Note

Media assets originating from CQ DAM (Digital Asset Management) are referenced in both the blueprint and the live copy. When an asset is modified in the DAM, the modified asset is rendered in the blueprint and in the live copy. A rollout is not needed to propagate the change as assets have their own life cycle and are independent from the blueprint and the live copy.

Managing a Blueprint and its Live Copies: the Blueprint Control Center

The Blueprint Control Center enables you to efficiently manage a blueprint and its live copies. You can define the blueprint, navigate to any blueprint page and view the status of all the related live copies. You can also filter, based on a path, the live copies that are displayed. A context menu enables you to perform all necessary actions on a page (like rolling out or restoring a page) and also to access information about the current state of a page.

To open the Control Center:

  1. Go to the Tools console.
  2. Double-click the MSM Control Center folder below Tools.
  3. Specify the blueprint path in the top left path field and click the refresh button.
  4. In the left panel, navigate to a blueprint page. The related live copy pages are displayed in the middle panel with a status icon.
    Note: navigating through the blueprint tree does not update the top left blueprint field.
  5. In the pathfield in the middle panel, specify the live copy path to filter the live copies and click the refresh button.
  6. On the top right, click Legend to display the status icons and their meanings.

The Blueprint Control Center looks as follows:

file

Managing Blueprints with the Control Center

When right-clicking a blueprint page (either in the left panel or in the first column of the central panel), the following context menu is displayed:

file
Open page

Opens the selected blueprint page.

Edit blueprint config

Opens a dialog to define the rollout configurations on the blueprint page:

  1. Click to open the dialog.
  2. Set the rollout configuration.
  3. Click OK to save the changes.

Rollout

 

Opens a dialog to define and perform the rollout:

  1. Click to open the dialog.
  2. Define:
    • Rollout Scope:
      • Rollout entire page: check to only roll out the page.
      • Rollout page and all sub pages: check to roll out the page and all the sub pages.
    • Background rollout: check to execute the rollout as a background task.
      For more information about configuring and managing background tasks, refer to the section Managing Background Tasks.
    Click Next.
  3. Select the live copies on which the rollout will be performed: the top left check button enables you to select/unselect all live copies.
    Click Rollout to perform the rollout: a status icon indicates if the rollout was successful (green icon) or not (red icon).
    Click Audit log to view the errors that happened during the rollout process if the rollout was not successful. Click OK to go back to the rollout dialog.
  4. Click Close.

MSM audit log exception entries look as follows:

file
View server caches

Opens a dialog to view the blueprint paths and the live copy paths in the cache memory:

  1. Click to open the dialog showing the cache content.
  2. Click Flush caches to update the caches.
  3. Close the dialog.

Note

The number of cached items never drops to zero.

Managing Live Copies with the Control Center

When right-clicking a live copy page (in the central panel), the following context menu is displayed:

file
Open page

Opens the selected live copy page.

View relationship details

Opens a dialog to view information about the relationship between the live copy and the blueprint pages.

  1. Click to open the dialog. The dialog has three tabs.
  2. In the Relationship status tab (informative):
    • Blueprint and Live Copy pages field set: displays read-only information.
    • Computed statuses field set: displays read-only informations (changes are not persisted).
  3. In the Livecopy tab (the tab is the same as the one in the page properties dialog):
    • Live Copy from: indicates the blueprint.
    • Live Copy suspended: check to suspend the live copy relationship.
    • Rollout Config:
      • the text indicates if the configuration is inherited from a parent page or persisted on the current page. In the latter case, you can remove the configuration by clicking the reset the configuration link.
      • you can define a rollout configuration for the page. The configuration will be persisted on the page and not inherited from parent pages anymore.
  4. In the Live Copies inheritance tab (informative):
    • Live Copy page: path of the live copy page
    • Inherited from source page(s): path of the blueprint page
  5. Click OK to save the changes.

View side-by-side with Blueprint

Opens the selected live copy page and its blueprint page side-by-side.

Rollout

Opens a dialog to roll out on the live copy: you can roll out either only the page or the page and its sub pages.

Re-create

Opens a dialog to re-create the live copy page and its sub-pages: it deletes the page and runs a fresh rollout (all local modifications on the live copy pages will be lost).

Restore

Opens a dialog to restore the live copy page that had been deleted. You can restore either the page only or the page and its sub pages.

Attach

Opens a dialog to attach the live copy page and its sub pages to the blueprint pages. You can either attach only the page or the page and its sub pages.

The attachment process does not delete or modify any existing content. A rollout is needed afterward.

A page can only be attached if it is in the live copy, considered as a locally created page and if the blueprint has the same page.

Detach

Opens a dialog to detach the live copy page and its sub pages from the blueprint pages and create a standalone copy.

When this operation is performed on a page of a Livecopy, a further Rollout of the former Blueprint page renames the detached page and creates a new page with the original name, containing the changes from the Rollout.

Skip

Opens a dialog to exclude the live copy page and its sub pages from the rollout process.

Unskip

Opens a dialog to include the live copy page and its sub pages to the rollout process.

Rolling Out Specific Paragraphs on a Page

It is possible to select page components in the blueprint page and to perform a rollout (or a delete and a rollout) on those components:

  1. Open the blueprint page in your browser.
  2. Select the component(s) that need to be rolled out.
  3. In the SideKick, select the Page tab and click Rollout Page.
  4. In the Rollout dialog, define:
    • Rollout Scope: select either:
      • Rollout selected components or
      • Delete + rollout selected components
    • Background rollout: check to run as a background task.
    Click Next.
  5. Select the live copy page(s).
  6. Click Rollout to perform the rollout.

Moving Blueprint and Live Copy Pages

Following behaviors apply when moving blueprint and live copy pages:

  • When you move a blueprint root page, you have to reference all the pages of all the live copies in the appropriate dialog. The blueprint root page is moved and all the live copy pages remain linked to this blueprint.
  • When you move any other blueprint page, the page is moved but it is considered deleted on the blueprint by the live copy. The live copy page will be deleted on the next rollout.
  • When you move a live copy root page, the inheritance to the blueprint root page is kept.
  • When you move any other live copy page, the page is moved. If a version of the page has not been created, the original page will be re-created on the next rollout. Otherwise, the page is considered as deleted.

Managing Background Tasks

CQ enables you to perform a rollout as a background task (see Rollout in Managing Blueprints with the Control Center) that can be performed when the server has less load.  The rollout task is splitted into jobs. Each job can be stopped, suspended and resumed. Background jobs can be scheduled to run only at certain times.

Stopping, Suspending and Resuming Background Jobs

To manage a background job:

  1. Open the Tools console.
  2. Open the Background Jobs page below the Tools folder.
  3. You can:
    • view all the background jobs in the All Jobs tab
    • view only active jobs in the Active Jobs tab
    • select one (or more) active job and click:
      • Suspend to pause a job in its current state.
      • Resume to resume a suspended job.
      • Stop to stop a job.

The following information are displayed:

  • State, the job state. A job can have one of the following statuses:
    • REJECTED, the job cannot be executed because the background system is too heavily loaded.
    • RUNNING, the job is running.
    • SUSPENDED, the job is suspended. A suspended job can be resumed.
    • STOPPED, the job has been stopped during its execution.
    • DONE, the job is done.
    A job can have one of the following transient statuses, which are usually not displayed in the console because a job does not stay long in this status:
    • NEW, the job has been created.
    • QUEUED, the job is placed in the background queue.
    • SUSPEND_REQUESTED, a request to suspend the job has been issued.
    • STOP_REQUESTED, a request to stop the job has been issued.
  • Created, the job creation date.
  • Remaining time to perform the job
  • Progress, the job progress in the following format:
    • ROLLOUT: <blueprint-path>, when the job is being executed.
    • DONE, when the job is done.
  • Output: click the link to view the job details. For example:
    STARTING: Rollout of [/content/geometrixx-outdoors/en] to [/content/mgo, /content/mygeooutdoors/en]
    DONE: Page rolled-out: [/content/geometrixx-outdoors/en] .Execution time=1115 ms

The jobs console looks as follows:

file

Note

If you need to delete a job, you have to delete the corresponding node in the repository below /var/bg/jobs/, using for example CRXDE. Make sure that the job is done before deleting it.

Setting Schedules for Background Tasks

Background jobs can be scheduled to run only in a time interval. To define the interval:

  1. In CRXDE, set the intervals property of /etc/jobs/schedule/DEFAULT to a String value in the format:
    hh1:mn1-hh2:mn2,hh1:mn1-hh2:mn2,...
    For example:
    • 9-11 which means: execute background jobs between 9AM and 11AM.
    • 9:15-10:40,14:30-18:15 which means: execute between 9:15 and 10:40 and between 14:30 and 18:15.
  2. Save the changes.

Background jobs are suspended outside of those intervals, they can be resumed manually if desired.

When a new job is started outside the interval, it will first run for approx. 15 seconds before being suspended.

Updates to the intervals property are observed and acted upon within 15 seconds.

Note

By default the time interval for the background tasks is set to an empty value, meaning that the background tasks are performed immediately.


Your comments are welcome!
Did you notice a way we could improve the documentation on this page?
Please leave your comments below and we will make the appropriate changes.

COMMENTS

  • By balaji - 10:09 AM on Apr 16, 2013   Reply
    For creating a live copy based on a blueprint, we need to select the option "new site" or "new live copy", why because if I select the option "new site", only the parent page is seen visible, all the other pages are not.If I select the option "new live copy" then all the pages are seen visible.
    Thanks,
    Balaji
    • By Guillaume Carlino - 11:42 AM on Apr 16, 2013   Reply
      Hi

      I just tested the creation of a live copy based on a blueprint by selecting "new site". I was able to see all the other pages. I suggest you post your question (with full details of what you have tried so far) to the Adobe CQ forum (http://forums.adobe.com/community/digital_marketing_suite/cq5), in order to reach a broader audience.

      Hope that helps,
      Guillaume



    • By Daniel - 1:23 PM on Apr 22, 2013   Reply
      I find this article very good.
      • By Guillaume Carlino - 8:54 AM on May 14, 2013   Reply
        Hi Daniel

        Thank you very much for your positive feedback.
      • By Anurag Sharma - 3:31 PM on Apr 24, 2013   Reply
        Hello Experts,

        I've one quick question, What is the license requirement for MSM. I've just downloaded CQ5.6 and MSM features seems to be working for me. I do not how to figure out if my license contains MSM license and if not then what feature will not work. Language copy and Translation workflow are working for me.

        Thanks for your help.
        • By Anurag - 4:00 PM on Apr 24, 2013   Reply
          Just to clarify..If I don't have MSM license, does Language copy and Translation workflow still works or we will need separate license to be able to use Language Copy and Translation workflow?

          anurag
          • By Guillaume Carlino - 8:53 AM on May 14, 2013   Reply
            Hi Anurag

            I suggest you contact support, they will be able to give you information about licenses and your specific contract.

            Hope that helps,
            Guillaume
        • By Anoop Kumar - 11:39 AM on May 02, 2013   Reply
          Hi,
          I am using live copy for my site for UK locale.
          In UK locale I don't want one component. So when I have deleted that component from the page.Then a placeholder came at that place and when I am seeing this thing in publish this placeholder is taking a space and moving the content down in the page but in should be top align.I am using IE7 browser for this.
          Please suggest.
          • By Scott Brodersen - 2:13 PM on May 02, 2013   Reply
            Hi Anoop,

            I suggest that you post your question to the Adobe forum (http://forums.adobe.com/community/digital_marketing_suite/cq5). You will garner the attention of many who can help with your situation.

            thanks
            scott
            • By Anoop Kumar - 4:13 AM on May 03, 2013   Reply
              Thanks Scott.

              • By khasim - 2:57 PM on Jul 25, 2013   Reply
                Hi ,
                I have seen this page completely and implemented the same , I have got one doubt, how to replicate the changes from live copy to blue print. In this you have mentioned the from blueprint to live copy.

                Thanks,
                khasim.
                • By zumbrunn - 10:17 AM on Aug 01, 2013   Reply
                  Hi khasim, maybe what you are looking for is the Launches feature instead of the livecopy/blueprint, since you seem to be looking for the reverse functionality of live copy/blueprint and Launches does kind of give you that.

                  http://dev.day.com/docs/en/cq/current/wcm/launches.html
                • By Mohammed Shaji Ahmed - 3:25 PM on Aug 23, 2013   Reply
                  When doing step 5 of section Changing language names and default countries
                  5. Right-click the /apps/wcm/core/resources folder and click Paste. Modify the child nodes as required.
                  I get the following error
                  Could not copy node. Received 409 (Conflict). no matching child node definition found for {}languages
                  • By alvawb - 5:28 PM on Aug 23, 2013   Reply
                    I was able to re-create the error you're experiencing. I will have to open a documentation bug for this procedure to be updated. If I'm able to troubleshoot this problem, I will post back to your comment. Thanks for the feedback!
                  • By Mohammed Shaji Ahmed - 8:17 PM on Aug 23, 2013   Reply
                    I have found an alternative way to copy the languages node, instead of copying languages node. I didnt create resources folder I went one level up and copied everything from resources folder. This worked fine for me.
                    One more thing
                    I created a french version of geometrix-outdoors and translated couple of exiting pages, except the french home page none of the pages are editable and all the options for page properties are in disabled state.
                    If I create a page in geometrix-outdoors english site, add text and translate the page, it is not editable in translated site. I tried the same thing in geometrix demo website, this site works fine.
                    • By Mohammed Shaji Ahmed - 8:19 PM on Aug 23, 2013   Reply
                      I am using AEM 5.6 version.
                      • By alvawb - 3:13 PM on Aug 26, 2013   Reply
                        Thanks for your feedback. I'm still investigating the behavior above. I will post back when I have more information.
                        • By alvawb - 7:16 PM on Aug 28, 2013   Reply
                          There was an omission in the documentation that was causing this error. The folder "resources" has to be of type "sling:Folder." I've updated the documentation - under the "core" folder, create a node of type sling:Folder called resources, then copy the languages.
                        • By alvawb - 7:17 PM on Aug 28, 2013   Reply
                          I've updated that page as well with the correct procedure.
                        • By alvawb - 7:28 PM on Aug 28, 2013   Reply
                          Please see my note as to the documentation correction. As to your other issue, I'm not sure what behavior your seeing. Is livecopy being used? You may want to post your question with any details to our forum at http://help-forums.adobe.com/content/adobeforums/en/experience-manager-forum/adobe-experience-manager.html.
                        • By Phani Madhav - 7:00 PM on Sep 26, 2013   Reply
                          Hi,

                          Under Section: "CREATING A LIVE COPY FOR DIFFERENT CHANNELS", the term Live Copy From: /content/geometrixx/en/support should be "/content/geometrixx-outdoors/en/support".

                          • By zumbrunn - 9:44 AM on Sep 28, 2013   Reply
                            Thank you Phani Madhav, it's been updated.
                            • By Phani Madhav - 5:00 PM on Oct 02, 2013   Reply
                              Also zumbrunn, for display of products on mobile pages, one line of code is missing from product_mobile.jsp under /libs/commerce/components/product_mobile/ ....Under this code

                              <%
                              for (Product product : variations) {

                              //Code to be inserted
                              request.setAttribute("cq.commerce.product", product);

                              %>

                              Using this code, products can now be seen for mobile pages.
                          • By Melie - 6:56 PM on Feb 04, 2014   Reply
                            Does anyone know how the inheritances in Launches work or impact with Livecopy/blueprints? example, if I rollout to a language a page containing launches.
                            • By alvawb - 6:36 PM on Feb 07, 2014   Reply
                              The section - Overriding Live Copy Inheritance for Components On a Page - might answer that question. You may also want to see http://dev.day.com/docs/en/cq/current/wcm/launches.html. If neither of those answer your question, please feel free to post on our dedicated AEM user forum at http://help-forums.adobe.com/content/adobeforums/en/experience-manager-forum/adobe-experience-manager.html
                            • By Anonymous - 6:15 PM on Mar 26, 2014   Reply
                              To be honest, I’m still a bit confused as to what translation systems (Clay Tablet or Translations.com’s GlobalLink), offer that MSM by Adobe doesn’t have.
                              Can’t my editors and translators all have direct access to AEM, with the English editor in chief produce blueprints and local translators in Asia work on live copy pages?
                              Can anyone explains to me the added value of these companies ((Clay Tablet or Translations)?
                              Thank you

                              • By Gopal - 8:50 AM on Apr 08, 2014   Reply
                                Claytablet offers you a platform using which you can send your files to translation companies for actual human translation. If for security reasons you don't want to give author instance access to translators then you need these tools.
                                MSM just copies english contents to localized folders. Actual translation has to be done by human translators & these translation job is typically outsourced to company like SDL & they don't have access to CQ author.
                              • This is a simple and inexpensive way of making elegant wedding reception table ...
                                • By Andy Shreve - 9:52 PM on Apr 17, 2014   Reply
                                  This page could be better if you fixed its typos. You might consider running spell-check on this page. Thanks.

                                  ADD A COMMENT

                                   

                                  In order to post a comment, you need to sign-in.

                                  Note: Customers with DayCare user accounts need to create a new account for use on day.com.

                                  ***