IDOL Server 24.1

# IDX Format

IDOL fields in IDX files

`#DREREFERENCE` | A unique reference string for the document. Usually this reference is a file name, URL, or a unique code number.
`#DRETITLE` | The title of the document. You can enter multiple lines.
`#DRECONTENT` | The content of the document. You can enter multiple lines. (This parameter is optional. However, if you do not enter `#DRECONTENT`, you must specify one or more `#DREFIELD NameN` fields. Otherwise, the document does not contain any content).
`#DREFIELD NameN` | The name of each `DREFIELD` that you are defining, and enter an appropriate value for it. You must enclose the field value with quotation marks (`"`). For example, to index customer details:
    #DREFIELD surname1="Smith"
    #DREFIELD forename1="Peter"
    #DREFIELD title1="Mr."
    #DREFIELD surname2="Miller"
    #DREFIELD forename2="Susan"
    #DREFIELD title2="Dr."
If the document contains only one instance of the `DREFIELD` that you are defining, you do not need to add a qualifier to the name of the field. For example:
    #DREFIELD company="Hewlett Packard Enterprise"
You can define the same `DREFIELD` with different values. For example:
    #DREFIELD MyField="value1"
    #DREFIELD MyField="value2"
    #DREFIELD MyField="value3"
The field values can span multiple lines. For example:
    #DREFIELD MyField="line1
    line2
    line3"
`#DREFIELD` is optional. However, if you do not enter a `DREFIELD NameN` field, you must specify `#DRECONTENT`. Otherwise, the document does not contain any content. NOTE: `DREFIELD` names must not contain spaces, accents, or multibyte characters. If you use these text elements, Content removes them when it indexes the fields. You must also change any queries that reference field names that contain these elements to use the modified field name.
`#DREDATE` | The creation date of the document in the format that you specified for the DateFormatCSVs parameter in the IDOL Content component configuration file. By default, this is `yyyy/mm/dd`.
`#DREDBNAME` | The name of the database into which you want to index the document.
`#DRESECTION N` | The section number. If you are indexing a large document and want to divide it into smaller sections, you can give each section a `DRESECTION` number to index the defined sections as individual documents into the IDOL Content component. If you divide a document into sections: the first section must be `#DRESECTION 0`. the section numbers must be in numerical order. apart from the `#DRESECTION` number and the `#DRECONTENT`, each section must contain the same Content field values. (See Section a Document).
`#DREENDDOC` | Indicates the end of the document. You must enter this delimiter.

NOTE: The text file must start with `#DREREFERENCE` and end with `#DREENDDOC`.

## Example

This is an example of a text file that the IDOL Content component can index:

    #DREREFERENCE 392348A0
    #DREFIELD authorname1="Brown"
    #DREFIELD authorname2="Edgar"
    #DREFIELD title="Dr."
    #DREDATE 1998/08/06
    #DRETITLE
    Jurassic Molecules
    #DRECONTENT
    Scientists announced last week the successful reproduction of a possible precursor to all life on Earth. The molecules consist of a part of DNA and the molecular "scissors" responsible for destroying messenger RNA in humans.
    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.
    #DRETYPE text
    #DREDBNAME Science
    #DRESTORECONTENT y
    #DREENDDOC

TIP: You can submit data for Content to index by using the wizard on the Index tab in the Console section of IDOL Admin. For more information, refer to the IDOL Admin User Guide.

Copyright 2023 Open Text
Version 24.1 | Last updated December 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 MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL Server 24.1

Topic Title: IDX Format