DREADDDATA

NOTE: This index action requires a POST request method. For details on how to use a POST request method, refer to the IDOL Server Administration Guide.

Allows you to index data over a socket into an DIH. Use this index action if the data is not accessible by the DIHs that you are indexing into. Parameters that you use with DREADDDATA override any equivalent settings in the IDOL Server configuration file.

You specify the data to index in the POST data (see Data).

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.

You can choose a deduplication option either by setting the KillDuplicates index action parameter, or by adding your KillDuplicatesOption directly to the end of the #DREENDDATA string in your POST request. If you do not set either option, IDOL Server uses the value of the KillDuplicates configuration parameter.

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 query.

NOTE: The request body must end with a blank line (\r\n\r\n)

Request Structure

DREADDDATA?[optionalParameters] HTTP/1.0
[OptionalHeaders]

Data  
#DREENDDATAKillDuplicatesOption

You can also use HTTP/1.1.

Examples

The following examples show a HTTP request performing a DREADDDATA index action.

Example 1:

POST /DREADDDATA?LanguageType=EnglishUTF8 HTTP/1.0
Content-Length: 604
#DREREFERENCE 392348A0
#DREFIELD authorname1="Brown"
#DREFIELD authorname2="Edgar"
#DREFIELD title="Dr."
#DREDATE 1998/08/06
#DRETITLE
Jurassic Molecules
#DRECONTENT
Using a technique called test tube evolution, scientists created a nucleic acid enzyme, the first known enzyme that uses an amino acid to start chemical activity. Scientists hope that the creation of this molecule will lead to the elusive precursor. The precursor, by definition, will have to contain both the genetic code for replication and an enzyme to trigger self replication.
#DREDBNAME Science
#DREENDDOC
#DREENDDATAREFERENCE

Example 2:

POST /DREADDDATA?DREDbName=Poetry&DateFields=*/Date HTTP/1.0
Content-Length: 515
Content-Type: application/xml
<DOCUMENT>
<DREREFERENCE>572801A2</DREREFERENCE>
<AUTHOR>George Eliot</AUTHOR>
<Date>2005/24/03</Date>
<DRETITLE>Roses</DRETITLE>
<DRECONTENT>
You love the roses - so do I. I wish
The sky would rain down roses, as they rain
From off the shaken bush. Why will it not?
Then all the valley would be pink and white
And soft to tread on. They would fall as light
As feathers, smelling sweet; and it would be
Like sleeping and like waking, all at after!
</DRECONTENT>
</DOCUMENT>
#DREENDDATANOOP

Required Parameters

The following action parameters are required.

Parameter Description
Data The IDX or XML file to index.

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 a document’s 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 a document’s 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 KillDuplicatesOption operation.
KillDuplicates Determines how IDOL Server handles duplicate content.
KillDuplicatesOption 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 the document 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.