IDOL Category Component 24.2

# DREADD Parameters

The following parameters are available for the `DREADD` index action.

Required Parameters

You must include the following 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.
`DREDbName``=database` | The name of the IDOL database into which you want to index the file content. You do not require this parameter if your IDX or XML files already contain a database field. By default, the IDOL Content component reads from this field.

Optional Parameters

You can include any of the following parameters. Separate parameters with an ampersand (&).

`ACLFields=fields` | One or more document fields from which Content reads ACLs (access control lists).
`CantHaveFields=fields` | One or more document fields to discard (not index). By default, all fields are indexed.
`DatabaseFields=fields` | One or more document fields that contain the name of the database into which you want to index the document.
`DateFields=fields` | One or more document fields from which you want Content to read the date of the document.
`Delete` | Content deletes the IDX or XML file after it is indexed.
`DocumentDelimiters=fields` | One or more fields in a file that indicates the beginning and end of an individual document, when the file contains multiple documents. Document delimiters cannot be nested.
`DocumentFormat=XML|IDX` | The format (XML or IDX) that Content assigns to a file when a file format is ambiguous.
`ExpiryDateFields=fields` | One or more fields that contain the expiration date of the document (the date when it is deleted or—if you set `ExpireIntoDatabase` in the Content configuration file—when it is moved into another database).
`FlattenIndexFields=fields` | One or more fields in a hierarchically structured document whose content you want to index as one level.
`IDXFieldPrefix=prefix` | When you index an IDX file, Content transforms it into XML by placing it under the `Document` subtree (each of the IDX fields is given the prefix `Document`, to construct a simple XML hierarchy). If you do not want to call the subtree `Document`, use this parameter to specify a different name.
`IndexFields=fields` | One or more fields that you want to index explicitly into Content. Explicitly indexing fields optimizes the query process when you use these fields to restrict queries. 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.
`KeepExisting=True|False` | 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.
`KillDuplicates=option` | Specify one of the options described in Deduplication Options—KillDuplicates to determine how Content 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 Content configuration file.
`KillDuplicatesDB=database` | The database to which Content moves duplicate documents.
`KillDuplicatesDBField=fields` | The name of a field in duplicate documents that contains the name of the database to which Content moves duplicate documents. If the field does not exist in the document, it uses the value of `KillDuplicatesDB`.
`KillDuplicatesMatchDBs=Db1+Db2+Db3` | Lists the databases to search for duplicate matches, separated by plus signs (+).
`KillDuplicatesMatchTargetDB=True|False` | Whether to search the database that the document is to index into for duplicate matches. Set to `True` to search the database.
`KillDuplicatesPreserveFields=True|False` | The name of IDX fields that Content must copy to a newer copy of the same document, when it performs `KillDuplicates`.
`LanguageFields=fields` | One or more fields that contain the language type of the document.
`LanguageType=type` | The language type to apply to a document if it has no fields that specify the language type. You define language types and how to handle them in the `[LanguageTypes]` section of the Content configuration file.
`MustHaveFields=fields` | One or more fields (in an IDX document only) that Content must store. By default, Content stores all fields. If you use this parameter, Content discards all document fields that are not specified—which means that you cannot query or print them.
`SectionFields=fields` | One or more fields that indicate the start of a new section in the document (for IDX only; Content automatically sections XML data).
`SecurityFields=fields` | One or more fields that contain the security type of the document.
`SecurityType=type` | 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 Content configuration file.
`TitleFields=fields` | One or more fields from which Content reads the document title.

Related Topics

- Specify Field Names

- Use KeepExisting to Minimize the Index Load

NOTE: Parameters used in the `DREADD` index action override the equivalent settings specified in the IDOL Content component configuration file.

Copyright 2024 Open Text
Version 24.2 | Last updated March 2024

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 IDOL Category Component 24.2

Topic Title: DREADD Parameters