Working with Packages

You are reading the CRX 2.3 version of Working with Packages.
This version has reached End of core support. For further details see our technical support periods.
This documentation is also available for the following versions:  CRX 2.2  CRX 2.1  CRX 2.0 (for CQ 5.3) 

This section describes how to use the following in CRX:

  • Package Manager, which you use to manage the packages in your local CRX installation, including how to upload, create, and download packages. It also explains what packages are and how to provide permissions to them.
  • Package Share, which lets you find, share, and download packages, components, and hotfixes from the Day server. You can also upload packages for internal company use.

Note

Since CQ 5.5, CQ Package Manager is completely replaced by CRX Package Manager.

What are Packages?

Packages can include content and project-related data. A package is a zip file that contains the content in the form of a file-system serialization (called "vault" serialization) that displays the content from the repository as an easy-to-use-and-edit representation of files and folders.

Additionally, it contains vault meta information, including a filter definition, and import configuration information. Additional content properties can be included in the package, such as a description, a visual image, or an icon that are not used for package extraction; these properties are for the content package consumer for informational purposes only.

You can perform the following actions with packages:

  • Create new packages
  • Modify existing packages
  • Build packages
  • Upload packages (CRX does not automatically install packages after uploading)
  • Install packages
  • Download packages, such as hotfixes, from the Package Share library
  • Upload packages to the internal company section of the Package Share library
  • Download packages from CRX to a local machine
  • Apply package filters
  • View package information
  • Uninstall packages, which reverts to the snapshop of in-repository content at the time of the last installation.
  • Delete packages, which deletes the zip package from the repository.

As a package can contain an icon, Day uses the following conventions for official packages:

Note

To avoid a mix-up, use a descriptive icon for your package and do not use one of the official Day icons.

   Official Day Hotfix package
 
 Official Day CRX/CQ5 Installation or Extension package
 
Official Feature packs

Using the Package Manager

The Package Manager manages the packages on your local CRX installation. You access the Package Manager from the welcome screen located at http://<server name>:<port number>/. Click Package to open the Package Manager. Alternatively you can access it directly at http://<server name>:<port number>/crx/packmgr/.

Welcome Screen

In the Package Manager, you can sort and filter your packages by using the selections in the Sort By, Show, and Groups areas in the left-hand frame. To search for packages, enter the name (or part of a name) of a package in the Search field and click the magnifying glass.

Note

You may need to log into the repository to see available packages for your user. Also, if you make changes, logging in means that the action includes information about who performed the action, for example "last installed by john."

Package Manager

In this example, all packages display in the right-hand frame.The buttons on the right side indicate the status of the package and provide quick access to the action most likely to be executed next:

Status Description  
Build The package is new and has not yet been built.  
OK The package is installed. No modifications have been made to the package since the last build.  
Share The package has been built and can be shared on Day's Package Share.  
Install The package was downloaded from package share or manually uploaded and was not yet installed on the local system.  
Rebuild The package has been modified from the last build and can be rebuilt.  

To open a package, click its icon to expand it. All possible commands for packages are available from the toolbar. Package Manager functionality is covered in detail in this documentation.

Package

Hover your mouse over the status indicators for more information. The first square indicates whether the package is installed, and when it has been installed. The second square indicates whether the package is modified.

file

Note

A package is considered modified if metadata such as name, description, etc, changed or if the filters have been adjusted, but the zip package has not been rebuilt. 

Creating Packages

You create packages to share with other users or to install content on multiple CRX instances.

When you create a package, you can add it to a group. Doing so, lets you define the location and grouping of your package, and the package will be placed in the corresponding group (location) when shared on Package Share.

To create a package in CRX:

  1. Open Package Manager.

  2. Click Create Package at the top toolbar.

    Create Package
  3. Enter the name of the package, the version number (e.g. 1.0) and either enter a new group name or select the group name from the drop-down menu and click OK. CRX creates the package in the selected group. If the group didn't exist, it creates a group for you.

    After you create a package, you must