3-1-Tags:CFIndex

last edited by usericon

lmajano on 23-Aug-2009

cfindex

cfindex

Description

Populates collections with indexed data. The cfindex and cfsearch tags encapsulate the Verity indexing and searching utilities. Verity collections can be populated from text files in a directory you specify, or from a query generated by a ColdFusion query. Before you can populate a Verity collection, you must create the collection using either the cfcollection tag or the ColdFusion Administrator. Use cfsearch to search collections you populate with cfindex.

Implemented

Usage Syntax

<cfindex  
	collection="String"
	action="String"
	[type="String"]
	[title="String"]
	[key="String"]
	[body="String"]
	[custom1="String"]
	[custom2="String"]
	[custom3="String"]
	[custom4="String"]
	[URLpath="String"]
	[extensions="String"]
	[query="String"]
	[recurse="Boolean"]
	[external="Boolean"]
	[language="String"]
	[category="String"]
	[categoryTree="String"]
	[status="String"]
	[prefix="String"]
 />

[] = Optional attribute

Attributes

Name	Type	Required	Default	Description
collection	String	Yes		Specifies a collection name. If you are indexing an external collection external = "Yes", specify the collection name, including fully qualified path.
action	String	Yes		Specifies the index action.
type	String	No		Specifies the type of entity being indexed. Default is CUSTOM.
title	String	No		Title for collection; Query column name for type and a valid query name; Permits searching collections by title or displaying a separate title from the key
key	String	No
body	String	No
custom1	String	No		A custom field you can use to store data during an indexing operation. Specify a query column name for type and a query name.
custom2	String	No		A custom field you can use to store data during an indexing operation. Usage is the same as for custom1.
custom3	String	No		A custom field you can use to store data during an indexing operation. Usage is the same as for custom1.
custom4	String	No		A custom field you can use to store data during an indexing operation. Usage is the same as for custom1.
URLpath	String	No		Specifies the URL path for files if type = "file" and type = "path". When the collection is searched with cfsearch, the pathname is automatically be prepended to filenames and returned as the url attribute.
extensions	String	No		Specifies the comma-separated list of file extensions that ColdFusion uses to index files if type = "Path". Default is HTM, HTML, CFM, CFML, DBM, DBML. An entry of "*." returns files with no extension
query	String	No		Specifies the name of the query against which the collection is generated.
recurse	Boolean	No		Yes or No. Yes specifies, if type = "Path", that directories below the path specified in key are included in the indexing operation.
external	Boolean	No		Yes or No. Yes indicates that the collection specified in collection was created outside of ColdFusion using native Verity indexing tools.
language	String	No		To use the language attribute you must have the ColdFusion International Search Pack installed.
category	String	No
categoryTree	String	No
status	String	No
prefix	String	No