User Guide

cfcollection 81
Attributes
Usage
With this tag you can create, register a Verity collection and administer a collection that was
created by ColdFusion or by a Verity application.
The following table shows the dependence relationships among this tag’s attribute values:
If more than instance of the
cfcollection tag might access or modify a collection
simultaneously, use the
cflock tag to protect the collection from attempts at simultaneous
operations.
To register a collection with K2Server, you update the k2server.ini file.
Attribute Req/Opt Default Description
action Required; see
Usage section
list • create: registers the collection with ColdFusion.
- If the collection is present: creates a map to it
- If the collection is not present: creates it
• repair: fixes data corruption in a collection.
• delete: unregisters a collection.
- If the collection was registered with
action = create:
deletes its directories
- If the collection was registered and mapped: does not
delete collection directories
• map: creates a map to the collection. It is not necessary
to specify this value. (ColdFusion maps collections
automatically.)
• optimize: optimizes the structure and contents of the
collection for searching; recovers space.
• list: returns a query result set, named from the
name
attribute value, of the attributes of the collections that are
registered by ColdFusion and K2 Server.
collection See Usage
section
• A collection name. The name can include spaces.
path See Usage
section
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
section
English Options are listed in Usage section. Requires the
appropriate (European or Asian) Verity Locales language
pack.
name See Usage
section
Name for the query results returned by the
list action.
Specifying this attribute
is required, optional or
unnecessary (blank):
For this action attribute value:
list create map optimize repair delete
collection
Required Required Required Required Required
path
Required Optional
language
Optional Optional
name
Required