Installing packages

Installing a package creates its items on the site: content classes, content objects, extension files, settings and design files. Packages of the types content class, content object and extension are installed; site packages and site style packages are not (the setup wizard handles site packages, see Package types).

Before you install

Open the package's page and press Compare: it shows how each class and object of the package differs from what the site has, and lets you import single items instead of the whole package. The install page itself also shows what the install meets here: each content object of the package looked up by its remote ID, as new, existing, a conflict, or without its class.

Installing

1. Open Setup > Packages, find the package and open it.
2. Press Install (/package/install/<name>, policy package/install for the package's type). The page lists what will be installed. Read it, then press Install package; Skip installation leaves without installing.
3. Answer the steps the items ask for, described below.
4. The result page lists what was installed.

A package that is installed already says so; installing it again repeats every item.

Steps a package may ask for

• Class conflicts (content class packages): when a class of the package exists already, choose Replace existing class, Update existing class (attributes are added and updated, none removed), Skip installing this class or Keep existing and create a new one. Replacing a class removes the objects of the existing class and their sub-items; the choice says how many.
• Siteaccess mapping (content object packages with templates): which siteaccess the package's templates go to.
• Top node placements (content object packages): where the top objects of the package are placed in the content tree; another location can be chosen.
• Object conflicts: when an object with the same remote ID exists, how to handle it.
• Custom steps: a package can bring steps of its own (see Custom install scripts).

Install as drafts

Install as drafts writes the content objects of a package as drafts instead: nothing is published, an existing object gets a new draft, classes, settings and design files are not installed, and the result page links every draft for review.

Large packages

Install in the background runs the same install as a content job, as you, with the choices you made; the page suggests it for a package with more objects than [ContentJobSettings] SynchronousLimit. The package's page shows the progress. From a shell, php ezpm.php install <name> installs without a browser time limit.

More

• Packages, section 7.
• Look inside a package, compare it with your site, import single items.
• Package installer batching.