vtx.OpenObjectQuery

Dieser Job stellt eine Anfrage nach einem Objekt und gibt das Ergebnis zurück.

Die ontologische Suche (ONTOLOGY=1 im Query-Parameter) wird derzeit nur unterstützt, wenn als Volltext-Engine OSFTS verwendet wird, dort als Analyzer intrafind konfiguriert ist und die Lizenz OKM vorhanden ist. Ob die Suche unterstützt wird, kann mit vtx.IsOntologySearchEnabled ermittelt werden.
Wenn OSFTS mit intrafind verwendet wird, muss zudem generell die Lizenz LIS vorhanden sein — andernfalls liefert der Job-Aufruf den Fehlercode 0xC1DA0BDA.

1. Eingabeparameter

Name Typ Pflicht Beschreibung

Name	Typ	Pflicht	Beschreibung
`Flags`	INT	Ja	Flags, die der Volltextengine übergeben werden
`Query`	STRING	Ja	Anfrage im INI-Format (siehe Beispiel unten)
`[MessageLanguageId]`	INT	Nein	Windows-Sprach-ID für die Sprache, in der eine ggf. zurückgegebene Meldung (Rückgabewert `Message`) verfasst sein soll (z. B. `7` = Deutsch)

Flags

INT

Flags, die der Volltextengine übergeben werden

Query

STRING

Anfrage im INI-Format (siehe Beispiel unten)

[MessageLanguageId]

INT

Nein

Windows-Sprach-ID für die Sprache, in der eine ggf. zurückgegebene Meldung (Rückgabewert Message) verfasst sein soll (z. B. 7 = Deutsch)

2. Ausgabeparameter

Name Typ Abhängigkeit Beschreibung

Name	Typ	Abhängigkeit	Beschreibung
`Result`	STRING	—	Gefundene Dokumente als durch Semikolon getrennte Liste; jeder Eintrag besteht aus Objekt-ID, Objekt-Typ, Ranking und Hit-ID (kommagetrennt).
`Guid`	STRING	—	GUID der Abfrage (für vtx.CloseQuery)
`[AlternativeQuerySuggestion]`	STRING	Optional	Vorschlag für alternative Suchbegriffe. Wird nur geliefert, wenn als Volltext-Engine OSFTS verwendet wird und ein Alternativvorschlag vorliegt.
`[OntologyTerms]`	STRING	Optional	Liste verwandter Suchbegriffe im Format `Begriff,Verwandtheitsgrad%;…` (z. B. `Flug,55;Reise,43;Urlaub,12`). Wird nur geliefert, wenn in der Anfrage `ONTOLOGY=1` gesetzt ist.
`[Message]`	STRING	Optional	Meldung zum Suchergebnis

Result

STRING

—

Gefundene Dokumente als durch Semikolon getrennte Liste; jeder Eintrag besteht aus Objekt-ID, Objekt-Typ, Ranking und Hit-ID (kommagetrennt).

Guid

STRING

—

GUID der Abfrage (für vtx.CloseQuery)

[AlternativeQuerySuggestion]

STRING

Optional

Vorschlag für alternative Suchbegriffe. Wird nur geliefert, wenn als Volltext-Engine OSFTS verwendet wird und ein Alternativvorschlag vorliegt.

[OntologyTerms]

STRING

Optional

Liste verwandter Suchbegriffe im Format Begriff,Verwandtheitsgrad%;… (z. B. Flug,55;Reise,43;Urlaub,12). Wird nur geliefert, wenn in der Anfrage ONTOLOGY=1 gesetzt ist.

[Message]

STRING

Optional

Meldung zum Suchergebnis

3. Beispiel

Bei Verwendung von Microsoft SQL Server werden nur die ersten drei Zeilen des [PAGE00]-Abschnitts benötigt.

[PAGE00]
#OSTYPE#=262144
FULLTEXT=Pferd
ONTOLOGY=1
#OSACT#=1
FELD0=#OSPOS000#;Autor;feld1;X;50;0;0
FELD1=#OSPOS001#;Quelle;feld2;X;150;0;0
FELD2=#OSPOS002#;Text2;feld3;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. Rückgabe

(INT): 0 = Job erfolgreich, sonst Fehlercode (z. B. 0xC1DA0BDA, wenn OSFTS mit intrafind verwendet wird und die Lizenz LIS fehlt).

Unterstützte Engines: alle

5. Siehe auch

vtx.IsOntologySearchEnabled