Upgrading to CQ5

An Overview of the Upgrade Process

An Upgrade enables the automated, or partially automated, convertion of an existing instance, of either Communiqué 3 or 4, to CQ5.

Therefore Day has provided a Upgrade Tool for existing customers. This provides a straight-forward, time-efficient upgrade. This transfers the basic elements from Communiqué 3 or 4; you can then extend these to cater for new functionality available in CQ5:

What the Upgrade Tool covers

The automatic upgrade can include different parts of the instance, including:

  • Content

  • Designs

  • Components

  • Templates

  • User and Group accounts, with ACLs

  • Version History

  • Audit Log

  • Log files

  • Media Library

  • CFC Dialogs

  • Workflows

  • MSM

[Note]Note

Highly customized items might need to be upgraded separately.

What you need to start an Upgrade

  • The URL to your existing Communiqué 3 or 4 installation.

  • A fresh installation of CQ5; as installed without content or customization.

What the Upgrade Tool generates

After upgrading you will have an instance that contains content, design, and so on (as above). The user can start to edit content on this new CQ5 instance.

Content Pages

Upgrade of a page will include the versioning history and operates as follows:

  1. Create the CQ5 page from the oldest version in the version history.

  2. For each version in the version history:

    1. Check in the page node to create a version.

    2. Check out the page node for update.

    3. Update to the version in the history.

The resulting CQ5 page holds the most recent version (HEAD) and is checked out.

Components and Templates

Upgrading components consists of multiple parts:

  • Descriptor - the component descriptor (such as component name) is upgraded into the node data of the new component.

  • display.any - this is upgraded into the display descriptor of the new node structure.

  • Script(s) - the component scripts are upgraded to the new location using the new naming convention.

To ease the upgrade, a limited ContentBus API is available to components through a JCR Adapter.

Audit Log

Importing the Communiqué 4 Audit Log is a straight import of the file entries into a node structure.

User

The upgrade of user definitions consists of several parts:

  1. For each user a principal is generated from the User Page.

  2. ACLs, these are processed on the same basis as Groups.

  3. Any additional data stored, is upgraded into a Preferences structure in the CQ5 user home.

Groups

New group principals are created and the appropriate users assigned to these groups.

Component coded applications

Will be upgraded, with the exception of objects of the type CFC.Tools.

Media Library

/etc/medialib will be moved to /content/dam.