IDOL Server 23.2

# DREADD

Allows you to index IDX or XML files located on a machine that IDOL can access directly into the IDOL Server. Parameters you use with `DREADD` override any equivalent settings in the IDOL Server configuration file.

You must specify the file to index either by adding the path to the file directly after the action name (see <IndexFile>), or by setting FileName.

NOTE: If your IDOL Server configuration file does not contain a field process to allow it to read the destination databases from a document field, you must also specify either DREDbName or DatabaseFields.

The IDX or XML file that you want to index must be either on the same machine as IDOL, or on a network share that IDOL has permission to access.

If you have set DelayedSync to `true` or you have set a high MaxSyncDelay in the configuration file, some time might elapse before a file is available for searching.

## Example

    http://12.3.4.56:9001/DREADD?Filename=C:\Documents\News\today.idx&DREDbName=News

This index action indexes a file called `today.idx` into the IDOL Server `News` database.

## Required Parameters

The following action parameters are required.

Parameter | Description
--- | ---
FileName | The full path to the IDX or XML file to index. You can also specify this file name directly after the action name (see <IndexFile>).

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
ACLFields | Fields that contain ACLs (Access Control Lists)
CantHaveFields | Fields to discard.
CreateDatabase | Whether to create unknown databases in the index action.
DatabaseFields | Fields that identify the database to store a document in. You must set either DatabaseFields or DREDbName unless your IDOL Server configuration allows it to read the destination database from a document field.
DateFields | Fields from which to read the document date.
Delete | Deletes the IDX or XML file after indexing.
DocumentDelimiters | Fields that indicate the beginning and end of a document.
DocumentFormat | The format of the file to index.
DREDbName | The database in which to store a document. You must set either DatabaseFields or DREDbName unless your IDOL Server configuration allows it to read the destination database from a document field.
ExpiryDateFields | Fields that contain the document expiry date.
FlattenIndexFields | Fields in an XML document to index as one level.
IDXFieldPrefix | An alternative name for the `DOCUMENT` sub-tree.
IndexFields | Fields to store as index fields.
KeepExisting | Modifies the KillDuplicates operation.
KillDuplicates | Determines how IDOL Server handles duplicate content.
KillDuplicatesDB | The database to move duplicate documents to.
KillDuplicatesDBField | The name of a field in duplicate documents containing the name of the database to move duplicate documents to.
KillDuplicatesMatchDBs | The databases to search for duplicate matches.
KillDuplicatesMatchTargetDB | The databases to search for duplicate documents.
KillDuplicatesPreserveFields | Whether to copy existing IDX fields to a newer copy of the same document.
LanguageFields | Fields that contain the document language type.
LanguageType | The language type of the file to index.
MustHaveFields | IDX file fields to store in IDOL Server.
SectionFields | Fields that indicate the start of a new document section.
SecurityFields | Fields that contain a document’s security type.
SecurityType | The security type of the document to index.
TitleFields | Fields that contain a document’s title.

This index action accepts the following standard index action parameters.

Parameter | Description
--- | ---
IgnoreMaxPendingItems | Whether to ignore the IndexQueueMaxPendingItems limit for this index action.
IndexUID | An identification code for any document tracking events.
NoArchive | Turn off configured archiving for the index action.
Priority | The priority for the index job.

Copyright 2023 Open Text
Version 23.2 | Last updated March 2023

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL Server 23.2

Topic Title: DREADD