Store Content in IDOL Server > Index Data > DREADD: Index IDX and XML Files Directly > DREADD Parameters

DREADD Parameters
The following parameters are available for the DREADD index action:
 
Required Parameters
filename
or
path
The name or location of the IDX or XML file you want to index.
The DREADD index action also accepts IDX or XML files that are compressed by gzip.
You do not require this parameter if your IDX or XML files already contain a database field. (By default, IDOL server reads from this field).
Optional Parameters
Include any of these parameters as required. Separate parameters with an ampersand (&).
One or more document fields from which IDOL server reads ACLs (Access Control Lists).
One or more document fields to discard (not index). By default, all fields are indexed.
One or more document fields containing the name of the database into which you want to index the document.
One or more document fields from which you want IDOL server to read the document's date.
One or more fields in a multi-document file indicating the beginning and end of an individual document. Note that document delimiters cannot be nested.
The format (XML or IDX) that IDOL server assigns to a file when a file format is ambiguous.
One or more fields containing the expiry date of the document (the date when it is deleted or—if you set ExpireIntoDatabase in IDOL server's configuration file—when it is moved into another database).
One or more fields in a hierarchically structured document whose content you want to index as one level.
When you index an IDX file it is transformed into XML by placing it under the Document subtree (each of the IDX file's fields is prefixed with Document, so that a simple XML hierarchy is constructed). If you do not want the subtree to be called Document, use this parameter to specify a different name.
Explicitly indexing fields optimizes the query process when you restrict queries using these fields. Use Index fields to hold data that is particularly significant to you (for example, the title of the document), and that you are likely to use frequently to restrict queries.
If you set KillDuplicates to Reference or FieldName, you can set KeepExisting to true to discard the document received for indexing and keep the matching document that already exists in the database.
Specify one of the options described in Deduplication Options—KillDuplicates and IndexMode to determine how IDOL server handles indexing of duplicate text.
If you do not use the KillDuplicates option, indexing defaults to the setting specified for the KillDuplicates parameter in the [Server] section of the IDOL server configuration file.
The name of a field in duplicate documents containing the name of the database to which IDOL server moves duplicate documents. If the field does not exist in the document, it uses the value of KillDuplicatesDB.
Lists the databases to search for duplicate matches, separated by plus signs (+).
Whether to search the database that the document is to index into for duplicate matches. Set to true to search the database.
The name of IDX fields that IDOL server must copy to a newer copy of the same document, when KillDuplicates is performed.
The language type to apply to a document if it has no fields that specify the language type.
Define Language types and how to handle them in the [LanguageTypes] section of the IDOL server configuration file.
One or more fields (in an IDX document only) that IDOL server must store. By default, it stores all fields. If you use this parameter, IDOL server discards all document fields that are not specified—which means that you cannot query or print them.
One or more fields indicating the start of a new section in the document (for IDX only; IDOL server automatically sections XML data).
One or more fields containing the security type of the document.
The security type to apply to a document if the document has no fields that specify the security type.
You define security types and how to handle them in the IDOL server configuration file.
One or more fields from which IDOL server reads the document's title. See for more information.
Related Topics 
*
*
 
NOTE Parameters used in the DREADD index action override the equivalent settings specified in the IDOL server configuration file.