Home >	Contents >	Index >
Template Tag TOC  |   Alpha TOC  |   Tag Family TOC  |   Purpose TOC  |   Annotated TOC  |   Index

INDEXREPLACE

Replaces an existing entry in a search index.

Syntax

<INDEXREPLACE
  ENTRY="ENTRY_NAME"
  INDEX="INDEX_NAME"
  DETAIL="ENTRY_DETAIL"
  [WORDLIST="WORDS"]
  [WORDLISTDELIMITERS="DELIMITERS"]
  [FILELIST="FILES"]
  [DATE="DATE_STRING"]
  [CHARACTERSET="CHAR_SET"]
  [SEARCHENGINE="NAME">]
  <FILEARGUMENT
 NAME="FILEARG_NAME" 
    VALUE="FILEARG_VALUE"/>
  <DATEARGUMENT
 NAME="DATEARG_NAME" 
    VALUE="DATEARG_VALUE"/>
  <TEXTARGUMENT
 NAME="TEXTARG_NAME" 
    VALUE="TEXTARG_VALUE"/>
</INDEXREPLACE>

Parameters

WORDLIST (optional)

Words to add to the index. These are whitespace-separated by default but you can use the WORDLISTDELIMITERS parameter to specify something else. Use this parameter to replace text that is not associated with a field of the index.

WORDLISTDELIMITERS (optional)

String containing delimiter characters to use to separate words in the value of the TEXTARGUMENT tag and the WORDLIST parameter. White space is used as delimiter characters if WORDLISTDELIMITERS is not specified.

FILELIST (optional)

For AltaVista, specify a comma-separated list of files to add. For Verity, specify a single file (not a list of files). Use this parameter to replace text that is not associated with a field of the index.

DATE (optional)

Date string to replace to the index entry. If no DATE_STRING is specified, the INDEXADD time is returned in the search results. Format is in Java SQL.

CHARACTERSET (optional)

Constant value representing the character set the index uses. For the AltaVista search engine this value may be 0, 1, or 2 (ISO_LATIN1, ASCII8, UTF8). If you do not specify CHARACTERSET, Content Server uses the value of av.charset from the Content Server properties file. Because Java Strings are transformed to UTF8, as they pass through the JNI interface to AltaVista, the 0 value only works for 7-bit ASCII. For all other cases, use the value for UTF8. For the Verity search engine, this value specifies the name of the subdirectory of the common directory where the locale is defined. If you do not specify CHARACTERSET, Content Server uses the value of verity.charset in the Content Server properties file.

SEARCHENGINE (optional)

Name of the search engine to use. If SEARCHENGINE is not specified, Content Server uses the value of cs.searchengine in the Content Server properties file.

Description

The INDEXREPLACE tag replaces an existing entry in a search index.

Arguments are optional using FILEARGUMENT, DATEARGUMENT and TEXTARGUMENT tags. These arguments specify the index field (the NAME parameter) to which the data (the VALUE parameter) is to be added to. The FILEARGUMENT value is a comma separated list of files whose content is added to the index with the given name. The DATEARGUMENT is a date string specified in JAVASQL format. The TEXTARGUMENT value is a string delimited by white space. The white-space delimiter characters may be overridden by the WORDLISTDELIMITERS tag.

The search engine collects arguments with the same name into a concatenated single value for that field.

errno

The possible values of errno include:

Value	Description
-300	File not found.
-801	Cannot load search engine.
-804	Index remove failed.
-805	No default index specified.
-806	Unknown search engine.
-811	Could not call native method.
-812	Index does not exist.
-815	Duplicate field values. (Verity only)
-816	Could not create temporary populated file. (Verity only)
-817	Could not create temporary data file. (Verity only)

Example

This example replaces the search information for Article083742132.

<SETVAR NAME="errno" VALUE="0"/>
<INDEXREPLACE INDEX="c:/ArticleIdx" 
   SEARCHENGINE="AV" ENTRY="Article083742132">
   <FILEARGUMENT NAME="body" 
                 VALUE="c:/articledata/083742132.body"/>
   <FILEARGUMENT NAME="body" 
                 VALUE="c:/articledata/083742132/*.txt"/>
   <TEXTARGUMENT NAME="headline" 
                 VALUE="Clinton to vacation in New Jersey."/>
</INDEXREPLACE>
<IF COND="IsError.Variables.errno=true">
	 	 <THEN>
	 	 <!--Handle error-->
	 	 </THEN>
</IF>

See Also

INDEXADD

		Home >	Contents >	Index >
	FatWire XML Tag Reference Copyright 2005 by FatWire Software All rights reserved.