|
How to Work With Packages
Packages are used for importing and/or exporting content into, or out of, your repository. This can be used for a variety of purposes; including amongst others, installing new functionality, transferring content between instances or creating a backup of a localized area of the repository.
Packages can be accessed and/or maintained via:
- Package Manager, which you use to manage the packages in your local CQ instance.
- Package Share, a centralized server holding both publicly available packages and those private to your company. The public packages can contain hotfixes, new functionality, documentation, etc.
Using these, packages can also be transferred between Package Manager, Package Share and/or your file system.
A package is a zip file holding repository content in the form of a file-system serialization (called "vault" serialization). This provides an easy-to-use-and-edit representation of files and folders.
Packages include content, both page-content and project-related content, selected using filters.
A package also contains vault meta information, including the filter definitions and import configuration information. Additional content properties (that are not used for package extraction) can be included in the package, such as a description, a visual image, or an icon; these properties are for the content package consumer and for informational purposes only.
Note
Packages represent the current version of the content at the time the package is built. They do not include any previous versions of the content that CQ keeps in the repository.
You can perform the following actions on or with packages:
- Create new packages; defining package settings and filters as required
- Preview package contents (before build)
- Build packages
- View package information
- View package contents (after build)
- Modify the definition for existing packages
- Rebuild existing packages
- Rewrap packages
- Download packages from CQ to your file system
- Upload packages from your file system into your local CQ instance
- Perform a dry run installation
- Install packages (CQ does not automatically install packages after uploading)
- Delete packages
- Download packages, such as hotfixes, from the Package Share library
- Upload packages to the company-internal section of the Package Share library
A package definition is made up of various types of information:
You can edit a variety of Package Settings to define aspects such as the package description, related bugs, dependencies and provider information.
The Package Settings dialog is available via the Edit button when creating or editing a package and provides three tabs for configuration. After any changes are made click OK to save these.
| Field |
Description |
Format/Example |
| Name |
The name of the package. |
|
| Group |
The name of the group to add the package to, for organizing packages. Type the name of a new group, or select an existing group. |
|
| Version |
Text to use for the custom version. |
|
| Description |
A brief description of the package. HTML markup can be used for formatting. |
|
| Thumbnail |
The icon that appears with the package listing. Click Browse to select a local file. |
|
| Field |
Description |
Format/Example |
|---|
| Name |
The name of the provider. |
CQ Geometrixx
|
| URL |
URL of the provider. |
http://www.cq-geometrixx.com |
| Link |
Package-specific link to a provider page. |
http://www.cq-geometrixx.com/mypackage.html |
Requires
|
- Admin: Select when the package can only be installed by an account with admin privileges.
- Restart: Select when the server needs to be restarted after the package is installed.
|
|
| AC Handling |
Specify how access control information is handled when the package is imported:
- Ignore
- Overwrite
- Merge
- Clear
|
|
|
| Field |
Description |
Format/Example |
|---|
| Tested With |
The product name and version this package is targeted to or is compatible with. |
CQ5.3 |
| Fixed Bugs/Issues |
A text field allowing you to list details of bugs fixed with this package. Please list each bug on a separate line. |
bug-nr summary |
| Depends on |
Lists dependency information that needs to be respected whenever other packages are necessary to let the current package run as expected. This field is important when using hotfixes. |
groupId:name:version |
| Replaces |
A list of deprecated packages that this package replaces. Before installing, check that this package includes all necessary content from the obsolete packages so no content is overwritten. |
groupId:name:version |
To make your package definition as precise as possible CQ allows you to define one, or more, filter definitions. A Filter Definition specifies:
- the Root Path of the desired content
- Rules specifying Include and Exclude criteria to fine-tune the selection
Rules:
- are optional, for simple package definitions it is sufficient to specify only the Root Path.
- can be combined; by using more than one Filter Definition you can package content from multiple root paths.
The following table describes these rules and provides examples:
| Filter |
Description |
Example |
|---|
| include |
You can define a path, or use a regular expression to specify all the nodes that you want to include.
Including a directory will:
- include that directory and all the files and folders in that directory (i.e. the entire subtree)
- not include other files or folders from under the specified root path
|
/libs/sling/install(/.*)? |
| exclude |
You can specify a path or use a regular expression to specify all the nodes that you want to exclude.
Excluding a directory will exclude that directory and all files and folders in that directory (i.e. the entire subtree).
|
/libs/cq/widgets/test(/.*)? |
Note
One package can contain multiple filter definitions, so that nodes from different locations can easily be combined into one package.
Package filters are most often defined when you first create the package, but they can be edited at a later time as well (after which the package should be rebuilt).
You can attach screenshots to your package to provide a visual representation of what the content looks like; for example, by providing screenshots of new functionality.
You can also attach an icon to your package to provide a quick-reference visual representation of what the package contains. This is then shown in the package list and can help you easily identify the package, or the class of package.
As a package can contain an icon, the following conventions are used for official packages:
Note
To avoid confusion, use a descriptive icon for your package and do not use one of the official icons.
 |
Official Hotfix package
|
|
Official CQ5 Installation or Extension package |
|
Official Feature packs |
The Package Manager manages the packages on your local CQ installation. After you have assigned the necessary permissions you can use the Package Manager for various actions, including configuring, building, downloading and installing your packages. The key elements to be configured are:
Permissions needed for using the Package ManagerTo grant users the right to create, modify, upload, and install packages, you must give them the appropriate permissions at the following locations:
- /etc/packages (full rights excluding delete)
- the node that contains the package contents
See Setting permissions for instructions on changing permissions.
To create a new package definition:
On the CQ5 Welcome screen, click Packages (or from the Tools console double-click on Packages).
Then select Package Manager.
Note
If your instance has a lot of packages there might be a folder structure in place, so you can navigate to the required target folder before creating the new package.
Enter the:
- Group Name
The target group (or folder) name. Groups are intended to be used to help you organize your packages.
A folder will be created for the group if it does not already exist. If you leave the group name blank, it will create the package in the main package list (Home > Packages).
- Package Name
The name of your new package. Select a descriptive name to help you (and others) easily identify the contents of the package.
- Version
A textual field for you to indicate a version. This will be appended to the package name to form the name of the zip file.
Click OK to create the package.
CQ lists the new package in the appropriate group folder.
Click on the icon or package name to open.
Note
You can return to this page at a later stage if required.
Click Edit to edit the package settings.
Here, you can add information and/or define certain settings; for example these include a description, the icon, related bugs and add provider details.
Click OK after you are finished editing the settings.
Add Screenshots to the package as required. One instance is available when the package is created, add more if required by using Package Screenshot from sidekick.
Add the actual image by double-clicking the image component in the Screenshots area, adding an image, and clicking OK.
Define the Package Filters by dragging instances of the Filter Definition from the sidekick, then double-clicking to open for editing:
Specify:
- Root Path
The content to be packaged; this can be the root of a subtree.
- Rules
Rules are optional; for simple package definitions, it is not necessary to specify include or exclude rules.
If needed, you can define either Include or Exclude rules to exactly define the package contents.
Add rules using the + symbol, alternatively remove rules using the - symbol. Rules are applied according to their order so position them as required using the Up and Down buttons.
Then click OK to save the filter.
Note
You can use as many filter definitions as you need, though care must be taken to ensure they do not conflict. Use Preview to confirm what the package contents will be.
Note
If you are packaging digital assets, the root path is /content/dam. The DAM workflows at /var/dam are automatically restarted, so including them in a package results in an error.
To confirm what the package will hold you can use Preview. This performs a dry run of the build process and lists everything that will be added to the package when it is actually built.
You can now Build your package.
Note
It is not compulsory to build the package at this point, it can be done at a later point in time.
A package is often built at the same time as you create the package definition, but you can return at a later point in time to either build, or rebuild the package. This can be useful if the content within the repository has changed.
Note
Before building the package it can be useful to preview the contents of the package. To do this click Preview.
Open the package definition from Package Manager (click on the package icon or name).
Click Build. A dialog asks for confirmation that you do want to build the package.
Note
This is of particular significance when you are rebuilding a package as the package contents will be overwritten.
Click OK. CQ will build the package, listing all content added to the package as it does so. When complete CQ displays a confirmation that the package was built and (when you close the dialog) updates the package list information.
Once a package has been built it can be rewrapped, if required.
Rewrapping changes the package information - without changing the package content. Package information is the thumbnail, description, etc., in other words everything you can edit with the Package Settings dialog (to open this click Edit).
A major use case for rewrap is when preparing a package for the package share. For example, you might have an existing package and decide to share it with others. For that you want to add a thumbnail and add a description. Instead of recreating the entire package with all its functionality (which might take some time and bears the risk that the package is no longer identical to the original) you can rewrap it and just add the thumbnail and description.
Open the package definition from Package Manager (click on the package icon or name).
-
Click Rewrap, a dialog will ask for confirmation.
Viewing and Editing Package InformationTo view, or edit, information about a package definition:
In the Package Manager navigate to the package you want to view.
Click the package icon of the package you want to view. This will open the package page listing information about the package definition:
Note
You can also edit and perform certain actions on the package from this page.
The buttons available will depend on whether the package has already been built or not.
If the package has already been built click Contents, a window will open and list the entire contents of the package:
Viewing Package Contents and Testing InstallationAfter a package has been built you can view the contents:
In the Package Manager navigate to the package you want to view.
Click the package icon of the package you want to view. This will open the package page listing information about the package definition.
To view the contents click Contents, a window will open and list the entire contents of the package:
To perform a dry run of the installation click Test Installation. After you confirm the action, a window will open and list the results as if installation was performed:
Downloading Packages to Your File SystemThis section describes how to download a package from CQ to your file system by using Package Manager.
Note
See Package Share for information on downloading hotfixes, feature packs, and packages from the public area and your company's internal area of package share.
From Package Share you can:
On the CQ5 Welcome screen, click Packages, then select Package Manager.
Navigate to the package you want to download.
Click the link formed by the name of the zip file (underlined) for the package you want to download; for example export-for-offline.zip.
CQ downloads the package to your computer (using a standard browser download dialog).
Uploading Packages from Your File SystemA package upload allows you to upload a package from your file system into the CQ Package Manager.
Navigate to the Package Manager. Then to the group folder into which you want the package to uploaded.
- File
You can either type the file name directly, or use the Browse... dialog to select the required package from your local file system (after selection click OK).
- Force Upload
If a package with this name already exists you can click this to force upload (and overwrite the existing package).
Click OK so that the new package is uploaded and listed in the Package Manager list.
After you upload a package, you need to install the content. To have the package content installed and functional, it needs to be both:
Caution
Installing a package can overwrite or delete existing content. Only upload a package if you are sure that it does not delete or overwrite content that you need.
To see the contents, or impact, of a package you can:
- Perform a test installation of the package without modifying any of the contents:
Open the package (click on the package icon or name) and click Test Install.
- See a list of package contents:
Open the package and click Contents.
Note
Immediately prior to installation of your package, a snapshot package is created to contain the content that will be overwritten.
This snapshot will be re-installed if/when you uninstall your package.
Caution
If you are installing digital assets, you must:
- Deactivate the WorkflowLauncher.
Use the Components menu option of the OSGi console to deactivate com.day.cq.workflow.launcher.impl.WorkflowLauncherImpl.
- When installation is complete, reactivate the WorkflowLauncher.
Deactivating the WorkflowLauncher ensures that the CQ DAM importer framework does not (unintentionally) manipulate the assets upon installation.
In the Package Manager navigate to the package you want to install.
An Install button is shown at the side of Packages that have not yet been installed.
Note
Alternatively, you can open the package by clicking on its icon to access the Install button there.
Click Install to start the installation. A dialog will request confirmation and list all changes being made. When finished click Close on the dialog.
The word Installed appears next to the package after it has been installed.
CQ lets you uninstall packages. This action reverts the contents of the repository that are impacted to the snapshot made immediately prior to the package installation.
Note
Upon installation, a snapshot package is created containing the content that will be overwritten.
This package will be re-installed when you uninstall the package.
In the Package Manager navigate to the package you want to uninstall.
Click the package icon of the package you want to uninstall.
Click Uninstall to remove the contents of this package from the repository. A dialog will request confirmation and list all changes being made. When finished click Close on the dialog.
To delete a package from the Package Manager list(s):
Note
The installed files/nodes from the package are not deleted.
In the Tools console, expand the Packages folder to show your package in the right-hand pane.
Click the package you want to delete so that it is highlighted and then either:
- Click Delete in the toolbar menu.
- Right-click and select Delete.
CQ asks for confirmation that you want to delete the package. Click OK to confirm the deletion.
Caution
If this package has already been installed, then the installed content will not be deleted.
The Package Share is a centralized server made publicly available to share Content-Packages.
With Package Share you can download these packages, which can include official hotfixes, feature sets, CQ-updates or CQ-content generated by other users.
You can also upload and share packages within your company.
There is no anonymous access to the Package Share; that is, only registered users are allowed to view, download and upload packages.
Access to the Package Share is available for our partners and customers. Registration details must be submitted for access rights to be assigned.
To gain access to Package Share:
- Use the Sign In page
- The first time you use the sign in page you will need to:
Signing In to Package Share
On the CQ5 Welcome screen, click Packages (or from the Tools console double-click on Packages).
Then select Package Share. You will be required to either:
Note
If you have forgotten your password, please use the Help pages link (also on the sign in dialog).
The first time you sign into Package Share with your Adobe ID your email address will be validated.
- You will receive an email containing a link.
- You need to click on this link.
- A webpage will be opened.
The action of opening this webpage is taken as validation.
- Sign in will continue.
Registering for Package ShareIf you need access to Package Share, you will need to register for an Adobe ID:
An Adobe ID can be created by providing:
- your e-mail address
- a password of your choice
- some additional information such as your name and country of residence
The validity of your application will be checked before:
- Your user account is created with the required/allowed permissions
- Your account is added to your company's group.
Note
A user from one of our partner companies can also be a member of his/her customer groups.
IPv6
You may experience problems when trying to access Package Share from a pure IPv6 environment.
This is because package share is service hosted on a server, meaning your connection is made through various networks on the internet. It cannot be ensured that all the connecting networks support IPv6; if not the connection might fail.
To avoid this issue, you can access Package Share from an IPv4 network, download the package and then upload it to the IPv6 environment.
HTTP Proxy
Package Share is currently unavailable if your company runs an http proxy that requires authentication.
Package Share is only available when your CQ server has access to the Internet without authentication being required. To configure the proxy for all services that use the http client (including package share) use the OSGi configuration of the Day Commons HTTP Client 3.1 bundle.
In Package Share packages are arranged in two subtrees:
- Public
This share group gives overall read permission to the package share and the public folder. Individual company share homes are denied. This folder is called Public and provides access to the official public packages. These include
- official Packages provided for the software (for example, updates, feature packs, and hotfixes)
- as well as packages made available by the community.
- Company-name / Internal
Each company is assigned its own group with read/write privileges on its company home. This gives access to packages specific to your company; available for sharing internally. In the following example, the user works for (the fictional company) AAA, so the user has access to their private packages.
Note
The list of packages that are visible to you is determined by the license type of your CQ server and the company group you belong to.
In Package Share, each package has a status indicator to let you know whether you have already downloaded or installed the package. The indicator appears to the right of the package name as in the following example:
| Status |
Description |
| Download |
This package is available for download. It has not been downloaded to your local CQ installation. |
| Downloaded |
This package has already been downloaded to your local CQ installation but has not yet been installed. |
| Installed |
This package has been downloaded and installed onto your local CQ installation. |
Downloading and Installing Packages from Package ShareTo download packages from Package Share, then install them on your local instance it is easiest to access Package Share from your CQ instance. This will download the package and immediately register it in your Package Manager, from where it can be installed.
From the CQ Welcome screen, click Packages, then select Package Share to open the Package Share page.
Using your account details, log into Package Share. The landing page is shown, listing the Public folder and one specific to your company.
Note
Before starting to download packages from Package Share, make sure you have the required access.
Navigate to the package you want to download and click Download. Once the package has been downloaded, the word Downloaded appears next to the package.
Note
If the package has already been downloaded to your instance, the Downloaded indicator appears next to the package instead of the Download button.
Return to, or navigate to the Package Manager on your CQ instance. Then navigate to the package you just downloaded.
Note
To find the package you downloaded, follow the same path as in Package Share.
For example, if you downloaded a package from the following path in Package Share:
Packages > Public > Hotfixes
Then in Package Manager on your local instance the package will also appear under:
Packages > Public > Hotfixes
Click Install to install the package to your local CQ installation.
Note
If the package has already been installed on your instance, the Installed indicator appears next to the package instead of the Install button.
Caution
Installing a package can overwrite existing content in the repository. Therefore, we recommend that you perform a Test Install first. This allows you to inspect whether the content that the package contains conflicts with your existing content.
Downloading Packages to your File System from Package ShareDownloading and installing is very convenient, but if required you can also download the package and save it to your local file system:
In Package Share click on the package icon or name.
Full package details will be displayed.
At the top of these details is a Download link. Click this link to download the package to your file system (using a standard browser download dialog).
Uploading Packages to Package ShareWith Package Share, you can upload packages to your company-internal area of package share. This makes them available for sharing within your company.
These packages are not available to the general CQ community, but are available to all users registered with your company.
To upload your packages you can use the company-internal Package Share:
Caution
To upload a package to Package Share, you first have to create a group folder named after your company on your local Package Manager. For example, geometrixx. All packages to be uploaded for sharing must be placed in this group folder.
Packages in the Package Manager home list or in other folders cannot be shared.
Open the Package Manager and navigate to the package you want to upload.
Click the package icon to open it.
Click Share to open the dialog for uploading the package to Package Share.
If are not already logged into Package Share you will need to enter your login credentials.
When you are logged in, CQ will display details about the package to be uploaded:
Click Share to upload the package to your company's internal Package Share.
CQ displays the status and indicates when the package has finished uploading, after which you can click the x (upper right hand corner) to exit the Share Package window.
After the upload has completed, you can navigate to your company's internal folder to see the package you just shared.
Note
To modify a package available on Package Share, you need to download it, re-build it, and then upload it again to Package Share.
To make a package available to the CQ community in the public area of Package Share:
-
After your package is uploaded, click Sign Up in the Public Sharing area of the page. The Support department will evaluate the package and post it to the public folder, if considered appropriate.
|
|
Thanks for your feedback. This typo has been corrected.
Alex
As part of build & release management we are exploring the option of using package share.
a. Is package share advisable to be used for porting template,components,osgi repository config, i18n etc across environments as part of a structured build & release management
b. Is there script(vlt?) based to option to create, export & import packages across environments, that could be automated
Thanks
Note: Customers with DayCare user accounts need to create a new account for use on day.com.