User Guide

cfindex 235
ColdFusion MX:
• The action attribute value optimize is obsolete. It does not work, and might cause an error,
in ColdFusion MX.
• Changed the external attribute behavior: it is not necessary to specify the external
attribute. (ColdFusion automatically detects whether a collection is internal or external.)
• Changed Verity operations behavior: ColdFusion supports Verity operations on Acrobat PDF
files.
• Changed thrown exceptions: this tag can throw the SEARCHENGINE exception.
• Changed acceptable collection naming: this tag accepts collection names that include spaces.
• Changed query result behavior: the cfindex tag can index the query results from a cfsearch
tag.
Attributes
Attribute Req/Opt Default Description
collection Required Name of a collection that is registered by ColdFusion; for
example,
"personnel".
action Required • update: updates a collection and adds
key to the index.
• delete: removes collection documents as specified by
the
key attribute.
• purge: deletes all of the documents in a collection.
Causes the collection to be taken offline, preventing
searches.
• refresh: deletes all of the documents in a collection, and
then performs an update.
type Optional
custom, if
query
attribute is
specified.
Otherwise,
file.
• file: applies
action value to filename, including path.
Expects a filename in the
key attribute.
• path: applies
action to files in a directory path that pass
the
extensions filter. Expects a directory name in the
key attribute.
• custom: applies
action to custom data; for example, to
data from a query.
title Optional Provides a title for the document if one cannot be
extracted from the document.
key Required (empty
string)
The value specified for key depends on the
type attribute:
• If
type = "file", the directory path and filename for the
file,
• If
type = "path", the directory path for the location of the
files.
• If
type = "custom", a unique identifier that specifies the
location of the data, For a query, the name of the
column that holds the primary key, for example. If not a
query, an identifier such as the URL for a web page, for
example.