vtx.OpenObjectQuery

This job performs a query for an object and returns the result.

Ontological search (ONTOLOGY=1 in the Query parameter) is currently only supported when using OSFTS as the full-text engine, configured with analyzer intrafind there, and the license OKM is present. Whether the search is supported can be determined with vtx.IsOntologySearchEnabled.
When using OSFTS with intrafind, the LIS license must also be present in general — otherwise the job call returns error code 0xC1DA0BDA.

1. Input Parameters

Name Type Required Description

Name	Type	Required	Description
`Flags`	INT	Yes	Flags to be passed to the full-text engine
`Query`	STRING	Yes	Query in INI format (see example below)
`[MessageLanguageId]`	INT	No	Windows language ID for the language in which a returned message (return value `Message`) should be written (e.g., `7` = German)

Flags

INT

Yes

Flags to be passed to the full-text engine

Query

STRING

Yes

Query in INI format (see example below)

[MessageLanguageId]

INT

Windows language ID for the language in which a returned message (return value Message) should be written (e.g., 7 = German)

2. Output Parameters

Name Type Dependency Description

Name	Type	Dependency	Description
`Result`	STRING	—	Found documents as semicolon-separated list; each entry consists of object ID, object type, ranking, and hit ID (comma-separated).
`Guid`	STRING	—	GUID of the query (for vtx.CloseQuery)
`[AlternativeQuerySuggestion]`	STRING	Optional	Suggestion for alternative search terms. Only returned when using OSFTS as full-text engine and an alternative suggestion is available.
`[OntologyTerms]`	STRING	Optional	List of related search terms in the format `term,similarity%;…` (e.g., `horse,55;travel,43;vacation,12`). Only returned when `ONTOLOGY=1` is set in the query.
`[Message]`	STRING	Optional	Message about the search result

Result

STRING

—

Found documents as semicolon-separated list; each entry consists of object ID, object type, ranking, and hit ID (comma-separated).

Guid

STRING

—

GUID of the query (for vtx.CloseQuery)

[AlternativeQuerySuggestion]

STRING

Optional

Suggestion for alternative search terms. Only returned when using OSFTS as full-text engine and an alternative suggestion is available.

[OntologyTerms]

STRING

Optional

List of related search terms in the format term,similarity%;… (e.g., horse,55;travel,43;vacation,12). Only returned when ONTOLOGY=1 is set in the query.

[Message]

STRING

Optional

Message about the search result

3. Example

When using Microsoft SQL Server, only the first three lines of the [PAGE00] section are needed.

[PAGE00]
#OSTYPE#=262144
FULLTEXT=horse
ONTOLOGY=1
#OSACT#=1
FELD0=#OSPOS000#;Author;field1;X;50;0;0
FELD1=#OSPOS001#;Source;field2;X;150;0;0
FELD2=#OSPOS002#;Text2;field3;X;50;0;0
[PDMSPParams]
EXPANSION_LEVEL_PROPERTY=4
FUZZY_SPELL_HALF_WORDS=FALSE
FUZZY_SPELL_THRESHOLD=0
MAX_FUZZY_SPELL_PROPERTY=15
MAX_REG_EXPR_PROPERTY=50
WARN_MAX_REG_EXPR_PROPERTY=FALSE
WORD_EXPANSION_LIMIT_PROPERTY=20
LMPI_SET_LANG_PROPERTY=de
MAX_DOCS_PROPERTY=999
RwareQueryType=P
OSQueryType=Object
OSSelectedTypes=current

4. Return Value

(INT): 0 = Job successful, otherwise error code (e.g., 0xC1DA0BDA, when using OSFTS with intrafind and the LIS license is missing).

Supported engines: all

5. See Also

vtx.IsOntologySearchEnabled