Creating and Synchronizing Live Copies

You are reading the AEM 6.2 version of Creating and Synchronizing Live Copies.
This documentation is also available for the following versions:  AEM 6.3  AEM 6.1  AEM 6.0 

You can create a live copy from a page or blueprint configuration, then can manage inheritance and synchronization.

Creating a Blueprint Configuration

Create a blueprint configuration to identify an existing website that you want to use as the source for one or more live copy pages.

Note

Blueprint configurations enable you to push content changes to live copies. See Live Copies - Source, Blueprints and Blueprint Configurations.

When you create a blueprint configuration, you select a template that defines the internal structure of the blueprint. The default blueprint template assumes that the source website 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. When creating a live copy, the languages are presented as optional content to include in the copy.
  • The root of each language branch has one or more child pages. When creating a live copy, child pages are presented as a chapter that you can include in the live copy.

Note

A different structure requires another blueprint template.

For example, the Geometrixx Demo Site has /content/geometrixx as a root page, and contains the language branches en, fr, de, es, it, ja, and zn. Each language branch contains chapters such as Products and Services.

After you create the blueprint configuration, you configure the following properties:

  • Name: The name of the blueprint configuration.
  • Description. (Optional) A description of the blueprint configuration. The description appears in the list of blueprint configurations to choose from when creating a site. 
  • Source Path: The path of the root page of the site that you are using as the source (blueprint).
  • Thumbnail Image: (Optional) An image to associate with the blueprint configuration. The image appears in the list to choose from when creating a site.

When your blueprint configuration is used, you can associate it with a rollout configuration that determines how the live copies of the source/blueprint are synchronized. See Specifying the Rollout Configurations To Use.

To create a blueprint configuration:

  1. Open the Tools console in the classic UI. (http://localhost:4502/miscadmin#/etc)

    Note

    In the touch-optimized UI you can navigate to the classic UI Tools console using the rail entries Tools, Operations and then Configuration.

  2. In the folder tree, select Tools, then MSM Control Center.

  3. Click New, followed by New Page.

  4. In the Create Page dialog, provide the following information

    • Title: A title that identifies the blueprint configuration.
    • Name: (Optional) A name to use in ithe URL. If left blank, the name will be derived from the Title property.
    • Select the required template from the list provided.

    Then click Create.

  5. Double-click the blueprint configuration that you created from the list in the right-hand pane of the console.

  6. Click Edit.

  7. Use the Blueprint Settings dialog to configure:

    • Settings: Name, Description, Source Path
    • Thumbnail Image

    Then click OK.

Creating a Live Copy

Creating a Live Copy of a Page

You can create a live copy of any page or branch. When you create the live copy, you can specify the rollout configurations to use for synchronizing the content:

  • The selected rollout configurations apply to the live copy page and its child pages.
  • If you do not specify any rollout configurations, MSM determines which rollout configurations to use. See Specifying the Rollout Configuration To Use.

You can create a live copy of any page:

  • Pages are that are referenced by a blueprint configuration,
  • And pages that have no connection to a configuration.
  • AEM also supports creating a live copy within the pages of another live copy.

The only difference is that availability of the Rollout command on the source/blueprint pages is dependent on whether source is referenced by a blueprint configuration:

  • If you create the live copy from a source page that is referenced in a blueprint configuration, then the Rollout command will be available on the source/blueprint page(s).
  • If you create the live copy from a source page that is not referenced in a blueprint configuration, then the Rollout command will not be available on the source/blueprint page(s).

To create a live copy:

  1. In the Sites console select Create, then Live Copy.

    file
  2. Select the source page then click or tap Next. For example:

    file
  3. Specify the destination path of the live copy (open the parent folder/page of the live copy) and then click or tap Next.

    Note

    The destination path cannot be within the source path.

  4. Enter:

    • a Title for the page.
    • a Name, that is used in the URL.
    file
  5. Use the Exclude sub pages checkbox:

    • Selected: create a live copy of the selected page only (shallow live copy)
    • Not Selected: create a live copy that includes all descendents of the selected page (deep live copy)
  6. (Optional) To specify one or more rollout configurations to use for the livecopy, use the Rollout Configs drop-down list to select them; selected configurations will be shown underneath the drop-down selector.

  7. Click or tap Create. A confirmation message will be shown, from here you can select either Open or Done.

Creating a Live Copy of a Site from a Blueprint Configuration

Create a live copy using a blueprint configuration to create a site based on the blueprint (source) content. When you create a live copy from a blueprint configuration, you select one or more language branches of the blueprint source to copy, then you select the chapters to copy from the language branches. See Creating a Blueprint Configuration.

If you omit some language branches or chapters from the live copy, you can add them later; see Creating a Live Copy Inside a Live Copy (Blueprint Configuration).

Caution

When the blueprint source contains links and references that target a paragraph in a different branch, the targets are not updated in the live copy pages, but remain pointed to the original destination.

For example, a live copy is created from the Geometrixx Demo Site blueprint. Links in the Toolbar branch that target the Services branch are not updated in the live copy, and continue to target the original pages in the Geometrixx Demo Site.

When you create the site, provide values for the following properties:

  • Initial Languages: The language branches of the blueprint source to include in the live copy. 
  • Initial Chapters: The child pages of the blueprint language branches to include in the live copy.
  • Destination Path: The location of the root page of the live copy site.
  • Title: The title of the root page of the live copy site.
  • Name: (Optional) The name of the JCR node that stores the root page of the live copy. The defaut value is based on the title.
  • Site Owner: (Optional)
  • Live Copy: Select this option to establish a live relationship with the source site. If you do not select this option, a copy of the blueprint is created but is not subsequently synchronized with the source.
  • Rollout Configs: (Optional) Select one or more rollout configurations to use for synchronizing the live copy. By default, the rollout configurations are inherited from the blueprint; see Specifying the Rollout Configurations to Use for more details.

To create a live copy of a site from a blueprint configuration:

  1. In the Sites console, select Create, then Site from the drop down selector.

  2. Select the blueprint configuration to use as the source of the live copy and proceed with Next.

  3. Use the Initial Languages selector to specify the language(s) of the blueprint site to use for the live copy.

    All available languages are selected by default. To remove a language, click or tap the X that appears next to the language.

    For example:

    file
  4. Use the Initial Chapters drop-down to select the sections of the blueprint to include in the live copy. Again all available chapters are included by default, but can be removed.

  5. Provide values for the remaining properties and then select Create. In the confirmation dialog box, select Done to return to the Sites console, or Open Site to open the root page of the site.

Creating a Live Copy Inside a Live Copy (Blueprint Configuration)

When you create a live copy inside the existing live copy (created using a blueprint configuration), you can insert any language copy or chapters that were not included when the live copy was originally created.

For example, after you created a live copy of the Geometrixx Demo Site blueprint having specified that only the English languge copy is included in the live copy and only a sub-set of the English chapters. 

Monitoring your Live Copy

Seeing the Status of a Live Copy

The properties of a live copy page show the following information about the live copy:

  • Source: The source page of the live copy page.
  • Status: The synchronization status of the live copy. The status includes whether the live copy is up to date with the source, and when the last synchronization occurred and who performed the synchronization.
  • Configuration:
    • Whether the page is still subject to live copy inheritance.
    • Whether the configuration is inherited from the parent page.
    • Any rollout configurations that the live copy uses.

To view the properties:

  1. In the Sites console, select the live copy page and open the properties. 

  2. Select the Live Copy tab.

    For example:

    file

Seeing the Live Copies of a Blueprint Page

Blueprint pages (that are referenced in a blueprint configuration) provide you with a list of the live copy pages that use the current (blueprint) page as the source. Use this list to keep track of the live copies. The list appears on the Blueprint tab of the page properties.

file

Synchronizing your Live Copy

Rolling Out a Blueprint

Roll out a blueprint page to push content changes to live copies. A Rollout action executes the rollout configurations that use the On Rollout trigger.

Note

Conflicts can occur if new pages with the same page name are created in both the blueprint branch and a dependent live copy branch.

Such conflicts need to be handled and resolved upon rollout.

Rolling Out a Blueprint from Page Properties

  1. In the Sites console, select the page in the blueprint and open the properties. 

  2. Open the Blueprint tab.

  3. Select Rollout.

    file
  4. Specify the pages and any sub-pages, then confirm with the checkmark:

    file

Roll Out a Blueprint from the Reference Rail

  1. In the Sites console, select the page in the blueprint and open the References panel (from the toolbar). 

  2. Select the Blueprint option from the list, to show the blueprints associated with this page.

  3. Select the required blueprint from the list.

  4. Click or tap Rollout.

  5. You will be asked to confirm details of the rollout:

    • Rollout scope:
      Specify whether the scope is for the selected page alone, or should include subpages.
    • Background rollout:
      If many pages/subpages are involved you can run the rollout as a background task.
  6. After confirming these details, select Rollout to perform the action.

Synchronizing a Live Copy

Synchronize a live copy to pull changes from the source to the livecopy.

Note

Synchronizing executes the rollout configurations that use the On Rollout trigger.

  1. In the Sites console, select the live copy page and open the properties. 

  2. Open the Live Copy tab.

  3. Click or tap Synchronize.

    file

    Confirmation will be requested, use Sync to proceed.

Changing Live Copy Content

To change live copy content, you can:

  • Add parapraphs to the page.
  • Update existing content by breaking the live copy inheritance for any page or component.

Note

If you manually create a new page in the live copy, then it is local to the live copy, meaning it does not have a corresponding source page to attach to.

The best practice to create a local page that is part of the relationship would be to create it in the source and to do a (deep) rollout. That will create the page locally as live copies.

Note

Conflicts can occur if new pages with the same page name are created in both the blueprint branch and a dependent live copy branch.

Such conflicts need to be handled and resolved upon rollout.

Adding Components to a Live Copy Page

Add components to a live copy page at any time. The inheritance status of the live copy and its paragraph system does not control your ability to add components.

When the live copy page is synchronized with the source page, the added components remain unchanged. See also Changing the Order of Components on a Live Copy Page.

Suspending Inheritance for a Page

When you create a live copy, the live copy configuration is saved on the root page of the copied pages. All child pages of the root page inherit the live copy configurations. The components on the livecopy pages also inherit the live copy configuration.

You can suspend the live copy inheritance for a live copy page so that you can change page properties and components. When you suspend inheritance, the page properties and components are no longer synchronized with the source. 

Note

You can also detach a live copy from its blueprint to remove all connections. The Detach action is permanent and non-reversible.

To suspend inheritance on a page:

  1. Open the properies of the live copy page either using the View Properites command of the Sites console or using Page Information on the page toolbar.

  2. Click or tap the Live Copy tab.

  3. Select Suspend from the toolbar. You can then select either:

    • Suspend: current page only
    • Suspend with children: current page together with any child pages
  4. Select Suspend on the confirmation dialog.

Resuming Inheritance for a Page

Suspending live copy inheritance for a page is a temporary action. Once suspended the Resume action becomes available to re-instate the live relationship:

file

Note

When you re-enable inheritance, the page is not automatically synchronized with the source. You can manually request a synchronization if this is required.

Changing Inheritance Depth (Shallow/Deep)

On an existing live copy you can change the depth for a page; i.e. whether child pages are included.

  • Switching to a shallow live copy:
    • Will have immediate effect and is non-reversible.
      • Child pages are explicitly detached from the live copy. Further modifications on children cannot be preserved if undone.
    • Will remove any descendant LiveRelationships even if there are nested LiveCopies.
  • Switching to a deep live copy:
    • Child-pages remain untouched.
    • To see the effect of the switch, you can make a roll-out, any content modifications are applied according the roll-out configuration.
  • Switching to a shallow live copy, then back to deep:
    • All children of the (formerly) shallow live copy are treated as if they had been created manually and are therefore moved away using [oldname]_msm_moved name.

To specify or change the depth:

  1. Open the properties of the live copy page either using the View Properties command of the Sites console or using Page Information on the page toolbar.

  2. Click or tap the Live Copy tab.

  3. In the Configuration section, set or clear the Live Copy Inheritance option depending on whether child pages are included:

    • checked - a deep live copy (the child pages are included)
    • clear - a shallow live copy (child pages are excluded)
    You must configure the project and path.

    Caution

    Switching to a shallow live copy will have immediate effect and is non-reversible.

    See Live Copies - Composition for more information.

  4. Click or tap Save to persist your updates.

Cancelling Inheritance for a Component

Cancel the live copy inheritance for a component so that the component is no longer synchronized with the source component. You can enable inheritance at a later point if required.

Note

When you re-enable inheritance, the component is not automatically synchronized with the source. You can manually request a synchronization if this is required.

Cancel inheritance to change the component content or delete the component:

  1. Click or tap the component for which you want to cancel inheritance.

    file
  2. On the component toolbar, click or tap the Cancel Inheritance icon.

    file
  3. In the Cancel Inheritance dialog box, confirm the action with Yes.

    The component toolbar is updated to include all (appropriate) editing commands.

Re-enabling Inheritance for a Component

To enable inhertance for a component, click or tap the Re-enable Inheritance icon on the component toolbar.

file

Changing the Order of Components on a Live Copy Page

If a live copy contains components that are part of a paragraph system, inheritance of that paragraph system adheres to the following rules:

  • The order of components in an inherited paragraph system can be modified, even with inheritance established.
  • On rollout, the order of the components will be restored from the blueprint. if new components were added to the live copy before rollout, they will be reordered along with the components above which they were added. 
  • If inheritance of the paragraph system is cancelled, the order of components will not be restored on rollout and will remain as is in the live copy.

Note

When reverting a cancelled inheritance on a paragraph system, the order of components will not be automatically restored from the blueprint. You can manually request a synchronization if this is required.

Use the following procedure to cancel inheritance of the paragaraph system.

  1. Open the live copy page.

  2. Drag an existing component to a new location on the page.

  3. In the Cancel Inheritance dialog box, confirm the action with Yes.

Overriding Properties of a Live Copy Page

The page properties of a Live Copy page are inherited (and not editable) from the source page by default.

You can cancel inheritance for a property when you need to change the property value for the live copy. A link icon indicates that inheritance is enabled for the property.

file

When you cancel inheritance, you can change the property value. A broken-link icon indicates that inheritance is cancelled.

file

You can later re-enable inheritance for a property if required.

Note

When you re-enable inheritance, the live copy page property is not automatically synchronized with the source property. You can manually request a synchronization if this is required.

  1. Open the properies of the live copy page using either the View Properites option of the Sites console or Page Information icon on the page toolbar.

  2. To cancel inheritance of a property, click or tap the link icon that appears to the right of the property.

    file
  3. In the Cancel Inheritance confirmation dialog, click or tap Yes.

Revert Properties of a Live Copy Page

To enable inhertance for a property, click or tap the Revert Inheritance icon that appears next to the property.

file

Resetting a Live Copy Page

Reset a live copy page to:

  • Remove all inheritance cancellations and
  • Return the page to the same state as the source page.

Resetting affects changes that you have made to page properties, the paragraph system and components.

  1. In the Sites console, select the live copy page and select View Properties.

  2. Open the Live Copy tab.

  3. Select Reset from the toolbar.

    file
  4. In the Reset Live Copy dialog box, confirm with Reset.

Detaching a Live Copy

Detach permanently removes the live relationship between a live copy and its source/blueprint page. All MSM-relevant properties are removed from the live copy and the live copy pages become a standalone copy.  

Caution

You cannot reinstate the live relationship after you detach the live copy.

To remove the live relationship with the option of later reinstating it, you can cancel live copy inheritance for the page.

There are implications on where within the tree that you use Detach:

  • Detach on a Root Page of a LiveCopy

    When this operation is performed on the root page of a live copy it removes the live relationship between all pages of the blueprint and its livecopy.

    Further changes to pages in the blueprint (as was) will not impact the livecopy (as was).

  • Detach on a Sub-Page of a LiveCopy

    When this operation is performed on a sub-page (or branch) within a live copy the live relationship is removed for that sub-page (or branch) and the (sub-)pages in the live copy branch are treated as if they had been manually created.

    However, the sub-pages are still subject to the live relationship of the parent branch so a further rollout of the blueprint page(s) will both:

    1. Rename the detached page(s):
      • This is because MSM considers them as manually created pages that cause a conflict as they have the same name as the livecopy pages it is trying to create.
    2. Create a new (livecopy) page with the original name, containing the changes from the rollout.

    Note

    See MSM Rollout Conflicts for details of such situations.

To detach a live copy:

  1. In the Sites console, select the live copy page and click or tap View Properties.

  2. Open the Live Copy tab.

  3. On the toolbar, select Detach.

    file
  4. A confirmation dialog will be shown, select Detach to complete the action.

Any questions?

Have a question about this or any other AEM topic? Ask our Community.
Learn more about AEM topics on our help hub.
Was this helpful?

By submitting your feedback, you accept the Adobe Terms of Use.

Thank you for submitting your feedback.