Packaging Cheatsheet

This cheatsheet is on how to package up an application and a set of content pages that you have developed in the following folders in the JCR structure. Alter as necessary.

/content/DemoSite
/content/dam/DemoSite
/apps/DemoSite
/apps/DemoSiteService
/apps/wcm

1. Create the package

Click on Create Package

Fill in the following details

Package Name: DemoSite
Version: 0.1
Leave group as default

Click on OK

Then click on Edit

2. General Tab

Add your description, and a Thumbnail. Thumbnails are good to quickly recognise the different packages.

3. Filters Tab

Enter /content/DemoSite into Root path: and click on Done.
repeat for the remaining directories:

/content/dam/DemoSite
/apps/DemoSite
/apps/DemoSiteService
/apps/wcm

You can add rules to specifically exclude directories and include sub directories of excluded directories here as well.

4. Dependencies Tab

It is important to keep an eye upon which version of CQ5, uncluding service packs that the package has been built and tested with. There are differences between the varying versions, and this can be useful later on to track what may have gone wrong between them.

As of Adobe CQ5-5.5.0, Package Depends on and Replaces is simply a text list. Although useful, and an item that should be filled in to make maintenance easier, it does not enforce replacement, nor dependency.

5. Advanced Tab

The Advanced Tab allows you to put your details in, so that anyone installing the package in future has an easy reference for whom to contact.

If you need Admin priviliges or a restart, check the check boxes.

IMPORTANT:
Set the AC Handling to what your default should be.

(From http://dev.day.com/docs/en/cq/current/core/how_to/package_manager.html)

Ignore

Ignores the packaged access control and leaves the target unchanged.

Overwrite

Applies the access control provided with the package to the target. This also removes existing access control.

Merge

Tries to merge access control provided with the package with the one on the target. This is currently not fully supported and behaves like Overwrite for existing ACLs. ACLs not in the package are retained.

MergePreserve

Tries to merge access control provided with the package with the one on the target. This is currently not fully supported and behaves like Ignore for existing ACLs. ACLs not in the package are retained.

Clear

Clears all access control on the target system.

By default we pick Overwrite to force ACL settings in.

6. Screenshots Tab

This is where you can place any images that you wish to keep with the packages. We generally have no use for this feature. Please comment below if there is a good use case for them.

Click on Save, and your settings are complete.

7. Building the package

Click on the build button.

You can now download the package using the download button. You will get a zip file, which you can then deploy onto another cq5 instance, as outlined in this post.