User Guide

236 Chapter 2: ColdFusion Tags
body Required if
type =
custom
• ASCII text to index.
• Query column names, if name is specified in query.
You can specify columns in a delimited list; for example:
"emp_name, dept_name, location".
This attribute is ignored if
type is file or path, and is
invalid if
action is delete.
custom1 Optional Use to index discrete values in collection records, which
lets you search for specific records using the Verity
MATCHES operator. By contrast, values specified in the
body attribute are concatenated and searched as a body
of text using the specified criteria.
If
type = query, a query column name. If type = custom, a
data field to be indexed.
custom2 Optional Usage is the same as for
custom1.
custom3 Optional Usage is the same as for
custom1.
custom4 Optional Usage is the same as for custom1.
category Optional A string value that specifies one or more search
categories for which to index the data. You can define
multiple categories, separated by commas, for a single
index.
categoryTree Optional A string value that specifies a hierarchical category or
category tree for searching. It is a series of categories
separated by forward slashes ("/"). You can specify only
one category tree.
URLpath Optional If
type is file or path, specifies the URL path. During
indexing, this pathname is prefixed to filenames and
returned from a search as the
url.
extensions Optional htm,
html,
cfm,
cfml,
dbm,
dbml
Delimited list of file extensions that ColdFusion uses to
index files, if
type = "Path".
"*." returns files with no extension. “.*” returns all files.
For example, the following code returns files with a listed
extension or no extension:
extensions == ".htm, .html, .cfm, .cfml, "*."
query Optional. The name of the query against which the collection is
generated.
recurse Optional no • yes: if
type = "path", indexes qualified files in directories
below the path specified in the key attribute.
• no
language Optional English For options, see
cfcollection. Requires the appropriate
Verity Locales language pack (Western Europe, Asia,
Multilanguage, Eastern Europe/Middle Eastern).
status Optional The name of the structure into which ColdFusion MX
returns status information.
Attribute Req/Opt Default Description