User Guide

cfcollection 83
Attributes
Usage
With this tag you can create, register, and administer a Verity collection that was created by
ColdFusion or by a Verity application.
Attribute Req/Opt Default Description
action Required; see
Usage
list • categorylist: retrieves categories from the collection and
indicates how many documents are in each one. Returns
a structure of structures in which the category
representing each substructure is associated with a
number of documents. For a category in a category tree,
the number of documents is the number at or below that
level in the tree.
• create: registers the collection with ColdFusion.
■
If the collection is present: creates a map to it.
■
If the collection is not present: creates it.
• delete: unregisters a collection and deletes its
directories.
• list: returns a query result set, named from the
name
attribute value, of the attributes of the collections that are
registered by ColdFusion.
• map: creates a map to a collection. If the action is
create
and the collection already exists, Coldfusion also creates
a map to the collection.
• optimize: optimizes the structure and contents of the
collection for searching; recovers space. Causes
collection to be taken offline, preventing searches and
indexing.
• repair: deprecated. Does nothing.
collection See Usage • A collection name. The name can include spaces.
path See Usage Absolute path to a Verity collection.
To map an existing collection, specify a fully qualified path
to the collection (not including the collection name); for
example,
"C:\MyCollections\".
language See Usage English Although English is the default language, Englishx, a more
advanced English locale, is also provided. For a list of
options, see Usage.
Requires the appropriate (European or Asian) Verity
Locales language pack.
name See Usage Name for the query results returned by the
list and
categorylist actions.
categories See Usage no Used only for creating a collection:
• yes: this collection includes support for categories.
• no: this collection does not support categories.