Help Center

Menu

create-collection.pl

This feature is not available in the Squiz DXP.

create-collection.pl creates the collection defined by an existing collection.cfg file and produces the corresponding folder structure required by the collection. Note: the collection’s conf folder is not created by this script and is assumed to exist before the script is run.

Table of Contents

Usage

$ create-collection.pl <config_file> [-l=licenseId] [-lunl] [-lsingle] [-lnoexit]

The collection configuration file must be specified, and must be a filesystem path to an existing, readable and valid collection configuration file.

A license is required for a collection to function correctly, a license can be applied by supplying one of the following arguments. If a license argument is not provided, then the collection will be created without a license.

Optional arguments:

  • -l=licenseId: Adds the collection to the license with the given id or fails if the license with the given id does not exist.

  • -lunl: Adds the collection to a unlimited license, if the collection could not be added to a license the script fails.

  • -lsingle: If only one license is installed the collection is added to that license, if the collection could not be added to a license the script fails.

  • -lnoexit: Dont exit if a license could not be found with -lunl or -lsingle, the collection will still be created.

Caveat: -lunl and -lsingle are ignored when -l=licenseId is set.

See also