IDOL Server 24.4
IDOL Server Help

# XMLFullStructure

Set `XMLFullStructure` to `True` to enable the `WHEN` operator for the Query action Text parameter.

The `WHEN` operator allows you to return only those XML documents in which two fields with the same parent field contain specified terms or phrases. Setting `XMLFullStructure` to `True` ensures each occurrence of the same field name in an XML document is given a different field code so that each one can be uniquely identified.

If you perform a geographical search, a single XML document can contain multiple latitude and longitude pairs, as long as each pair has a unique parent tag. In such documents:

    FieldText=DIST*

Matches any of the pairs in the document.

    FieldText=BIASDIST*

Biases according to the closest pair to the center point.

    Sort=DIST*

Sorts according to the closest pair to the center point.

You can use the `DISTSPHERICAL` operator with the `WHEN` operator when you have set `XMLFullStructure` to `True`.

Notes

- Setting `XMLFullStructure` to `True` also ensures that IDOL Server treats multiple occurrences of the same field name in an IDX document uniquely.

- `XMLFullStructure` supports the `BEFORE` and `AFTER` operators in FieldText queries for IDX documents. The `BEFORE` and `AFTER` operators allow you to return only those XML or IDX documents in which two fields appear in the specified order. You cannot use the `WHEN` operator for IDX documents, because there are no parent fields in IDX documents.

  For example:

      FieldText=MATCH{Ford}:MAKE BEFORE MATCH{Ferrari}:MAKE

- When you set `XMLFullStructure` to `True`, text queries for exact phrases return only phrases that occur in the same instance of a field.

  For example, if an IDX document lists:

      #DREFIELD author="W.C. Henry"
      #DREFIELD author="James Joyce"

  The following query returns this document if you set `XMLFullStructure` to `False` in the IDOL Server configuration file.

      action=Query&Text="Henry James":author

  If you set `XMLFullStructure` to `True`, the document does not return.

- `XMLFullStructure` applies to XML documents that you submit in a query that uses the TextParse action parameter. For example, if you have an AgentBoolean rule that uses the `WHEN` operator, IDOL Server applies this rule correctly to XML in the Text parameter when you set TextParse to `True`.

Type: | Boolean
Default: | False
Required: | No
Configuration Section: | Server
Example: | `XMLFullStructure=False`
See Also: | Query action FieldText parameter Query action

NOTE: If you change this setting after you have indexed content into IDOL Server, you must reindex the content.

Copyright 2024 Open Text
Version 24.4 | Last updated September 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 Server 24.4

Topic Title: XMLFullStructure