fulltextsettings (Domino DTD)

Defines the settings used to perform a full text search on a Domino database.

Containment Hierarchy

Contained by: <database>

Contains: <lastindexed>

Syntax

<!ELEMENT fulltextsettings (lastindexed?) >

Content

lastindexed?

Contains an optional <lastindexed> element.

Attributes

<!ATTLIST fulltextsettings

size

%integer;

#IMPLIED

update

(%fulltextsettings.updatetypes;)

#IMPLIED

unindexeddocumentcount

%integer;

#IMPLIED

casesensitive

%boolean;

"false"

breakat

(%fulltextsettings.breaktypes;)

"words"

includeattachments

%boolean;

"false"

attachmenttype

(%fulltextsettings.attachment.type;)

"rawtextonly"

includeencryptedfields

%boolean;

"true"

>

attachmenttype

Types of attachments to include in a full-text index of a database. See the %fulltextsettings.attachment.type; entity for a list of options. This attribute is only evaluated if the includeattachments attribute equals true.

breakat

Level to break the search at, as defined in the %fulltextsettings.breaktypes; entity. Word breaks are always indexed, but you can also specify to index sentence and paragraph breaks as well.

casesensitive

If true, allows you to use the EXACTCASE keyword to narrow the search using case-sensitive words.

includeattachments

If true, indicates that the types of attachments specified in the attachmenttype attribute should be included in the full text index for the database. This means that a search on the database will return any occurrences of the query that are found in a document attachment, though the text is not highlighted in an attachment.

includeencryptedfields

If true, includes encrypted fields in the full-text index for the database. Encrypted fields hide content from unauthorized users. Setting this attribute to true compromises encrypted fields, by returning any matches despite the encryption settings.

size

Size of the database in kilobytes.

unindexeddocumentcount

Number of documents not indexed.

update

Frequency with which to update the full-text index on the server. See the %fulltextsettings.updatetypes; entity for a list of options.

Defined entities for <fulltextsettings> element

The %fulltextsettings.attachment.type; entity lists the types of text attachments that can be included in a full text index for searching.

Syntax:

<!ENTITY % fulltextsettings.attachment.type "rawtextonly | includebinary ">

includebinary

Searches attachments in binary data format, which is more accurate than searching for raw text only.

rawtextonly

Searches attachment in raw text (ASCII) format, which occurs faster, but is less accurate.

The %fulltextsettings.breaktypes; entity defines where to break the text when performing a full text search.

Syntax:

<!ENTITY % fulltextsettings.breaktypes "words | wordssentencesparagraphs ">

words

Indexes each word and searches the text per word. This is the standard indexing break level.

wordssentencesparagraphs

Enables you to break the text at the sentence or paragraph level in addition to the word level. Using the SENTENCE and PARAGRAPH keywords between words, you can narrow the search to find only documents in which sentences or paragraphs contain both of the specified words.

The %fulltextsettings.updatetypes; entity lists the types of server update schedules you can set for a full text search.

Syntax:

<!ENTITY % fulltextsettings.updatetype "daily | hourly | immediate | scheduled ">