Category Component 25.4
Category Component Help

# SUBSTRING

The `SUBSTRING` field specifier (case sensitive) allows you to return documents whose field value is a substring of a specified string (or equal to a specified strings).

## Format

    FieldText=SUBSTRING{yourStrings}:yourFields

`yourStrings` | One or more strings. A document returns only if one of `yourFields` contains a substring of one of the specified strings. You can match strings that contain punctuation (but see Note) or consist of several words. NOTE: Strings in the query must be percent-encoded to ensure that any commas or curly braces that are part of a string are not interpreted as query syntax. If you send HTTP requests using the content-type `application/x-www-form-urlencoded` you must then percent-encode all parameter values, meaning that any commas or curly braces that are part of a string are percent-encoded twice (such that a comma is represented by the sequence `%252c`). For more information, see Percent Encoding in Queries.
`yourFields` | One or more fields. A document returns only if it contains one of these fields, and if the value in this field is a substring of `yourStrings`. Separate multiple fields with colons (`:`). There must be no space before or after a colon.

## Example

    FieldText=SUBSTRING{Telecommunications,Technology}:SECTOR

The `SECTOR` field must contain a string that is a substring of `Telecommunications` or `Technology`. For example, if the `SECTOR` field has the value `Telecom` or `Tech`, the document returns. If the `SECTOR` field has the value `Latest Technology`, the document does not return.

    FieldText=SUBSTRING{scattering,doggedly}:ANIMAL

The `ANIMAL` field value must contain a substring of `scattering` or `doggedly`. For example, if the `ANIMAL` field has the value `cat` or `dog`, this document returns.

Copyright 2025 Open Text
Version 25.4 | Last updated October 2025

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: Knowledge Discovery Category Component 25.4

Topic Title: SUBSTRING