NrtIdx_Setup - Near-Realtime-Index einrichten

Port: Biz

Beschreibung

Service um Near-Realtime-Index einzurichten, anzupassen oder auch zu löschen. Ausserdem kann Zusammenfassung der aktuell aktiven Konfiguration abgefragt werden (Aufruf mit leeren Werten für alle Argumente).

Argumente

Nr.
Key
Name
Beschreibung
1
Activate
Erstellen/Aktualisieren oder Löschen
Wenn leer wird der aktuelle Zustand ohne Manipulationen zurückgegeben. Wenn 1, werden die adressierten Indizes erstellt respektive (wenn bereits vorhanden) aktualisiert. Wenn 0, werden die adressierten Indizes gelöscht.
2
IsTest
Test-Modus
Im Test-Modus werden keine effektiven Manipulationen vorgenommen. Wenn leer, wird im Sinne eines defensiven Verhaltens angenommen, dass Test-Modus gewünscht ist. Anders formuliert: Um effektiv Änderungen durchzuführen, muss explizit 0 übergeben werden.
3
TopBoType
Adressierter Top-BO-Typ
Adressierter Top-BO-Typ (beispielsweise "Addr"). Wenn alle Top-BO-Typen respektive die dazugehörigen Near-Realtime-Indizes adressiert werden sollen, muss "*" übergeben werden.
4
IncludeOptional
Inklusive optionale Elemente
Sollen optionale Elemente (insbesondere freie BO-Attribute) miteinbezogen werden?
5
NrtIdxLangModeCd
Sprach-Modus
Sprach-Modus beschreibt, wie relevante Datensprachen für Near-Realtime-Indexierung spezifiziert werden. Kann leer übergeben werden, wenn alle Datensprachen indexiert werden sollen (Index noch nicht vorhanden) respektive keine Änderungen erwünscht sind (Index bereits vorhanden).
6
DataLangNoSet
Datensprachen (Set)
Set mit den gewünschten Datensprachen (beispielweise " 1 2 15 "; nur relevant, wenn Sprach-Modus auf "Explizit" gesetzt ist).
7
TopBoFilterAdditional
Zusätzliches Top-BO-Filter
Zusätzliches Top-BO-Filter (zusätzlich gegenüber allfällig vordefiniertem Filter). Filter muss in Query-Syntax erfasst werden und gültig sein.
8
ReturnModeCd
Rückgabe-Modus
Rückgabe-Modus welcher definiert, in welcher Form Enterprise-Search-Index-Konfiguration zurückgegeben werden soll
9
ReturnBoCount
BO-Anzahl zurückgeben
BO-Anzahl zurückgeben (inkl. Berücksichtigung von allfälligem Filter)
10
ReturnStorageEstimation
Speicherbedarfs-Schätzung zurückgeben
Soll Speicherbedarfs-Schätzung zurückgegeben werden? Berücksichtigt werden Anzahl BOs (Top-BO und Children), Anzahl Attribute in Index, Anzahl Sprachen und allfällig definierte Filter. Für inaktive Indizes kann keine Schätzung zurückgegeben werden, weil diese Parameter noch nicht definiert sind. Hier hilft Aktivieren im Test-Modus.

Rückgabewerte

Nr.
Key
Name
Beschreibung
1
NrtIndex
Near-Realtime-Indexname
Near-Realtime-Indexname
2
NrtIdxStateCd
Index-Status
Index-Status (vereinfachte Sicht)
3
ESearchIndexConfigNo
Enterprise-Search-Konfigurations-Nummer
Enterprise-Search-Konfigurations-Nummer (0 wenn Index nicht existiert)
4
ESearchIndexBoType
Enterprise-Search-BO-Typ
Enterprise-Search-BO-Typ
5
ESearchIndexBoFilter
Enterprise-Search-BO-Filter
Enterprise-Search-BO-Filter (in Query-Syntax)
6
ESearchIndexDataLangNoSet
Enterprise-Search-Index-Sprachen
Set mit den relevanten Datensprachen resp. deren Nummern. Jeweils zum Zeitpunkt der Index-Erstellung.
7
ESearchIndexStateCdVal
Enterprise-Search-Index-Status-Nummer
Enterprise-Search-Index-Status-Nummer
8
ESearchIndexStateCdId
Enterprise-Search-Index-Status-Id
Enterprise-Search-Index-Status-Id
9
ESearchIndexStateDesc
Enterprise-Search-Index-Status-Beschreibung
Enterprise-Search-Index-Status-Beschreibung (insbesondere mit Informationen bezüglich Indexier-Status)
10
ESearchIndexConfig
Enterprise-Search-Konfiguration
Enterprise-Search-Konfiguration (Umfang abhängig von "ReturnModeCd"-Service-Argument)
11
BoCount
BO-Anzahl
BO-Anzahl (allfälliger Filter wird hierbei berücksichtigt)
12
EstimatedStorageMBytes
Speicherbedarfs-Schätzung in MBytes
Speicherbedarfs-Schätzung in MBytes

Message Keys

keine