Führt eine Suche nach Elementen im Artikelbaum durch, deren zugehörige Artikel-Elmente einer gegebenen Hierarchie angehören.
Wir erwarten, daß die Suchbedingungen zuvor mit Hilfe von „if_im_SearchTreeNodes_Conds“ übergeben wurden. Die Erläuterungen zu den Möglichkeiten und Optionen bzgl. der Bedingungen sind der Dokumentation dort zu entnehmen.
Anmerkung zum Parameter „OutputIntoOneID“ :
Hiermit kann man steuern, ob eine Ergebnismenge zurückgeben werden soll, oder ob stattdessen die gefundenen „TreeNodeID“s in die Tabelle „tempdb.dbo.OneID“ eingefügt werden sollen - um dann anschließend z.B. im_GetNodeProperties aufrufen zu können. Folgende Werte sind möglich :
Anmerkung zur Sortierung der Rückgabemenge nach Eigenschaften :
Man hat die Möglichkeit, das Ergebnis nach Eigenschaften der Elemente zu bestimten Merkmalen zu sortieren. Die Merkmal-IDs (maximal 3 !) sind (durch „¶“ getrennt) in „SortByCharacteristicIDList“ zu übergeben.
Sortiert wird in einem solchen Fall zuerst nach den Eigenschaften zum ersten Merkmal, dann (falls angegeben) zum zweiten Merkmal und schließlich (falls angegeben) zum dritten Merkmal.
WIE zu sortieren ist, muß man im Parameter „SortOptionList“ angeben. Dabei handelt es sich um eine Summe von Optionen, bzw. um eine Liste von „Options-Summen“ (durch „¶“ getrennt), die sich auf das Merkmal in „SortByCharacteristicIDList“ beziehen, das an der entsprechenden Stelle kommt.
Folgende Optionen sind derzeit möglich :
Logischerweise kann nur EINE von den Optionen „1“, „2“, „4“ und „8“ gewählt werden, und es kann natürlich nur entweder Option „16“ oder „32“ gewählt werden !
Haben zwei Elemente zu allen Merkmalen gleichwertige Eigenschaften, wird aufsteigend nach der „TreeNodeID“ sortiert !
Es ist möglich, für „SortOptionList“ nichts (also „NULL“) anzugeben - dann wird automatisch immer der Wert „17“ (also Optionen „1“ und „16“) gewählt.
Bei der Ermittlung der Eigenschaften gibt es durch die Parameter „InheritDepthOptionList“ und „RecursiveEvaluationOptionList“ die Möglichkeit, bzgl. Vererbung und rekursiver Auswertung Einschränkungen vorzunehmen. Es handelt sich wieder jeweils um eine Liste von Werten (durch „¶“), die sich auf das Merkmal in „SortByCharacteristicIDList“ beziehen, das an der entsprechenden Stelle kommt :
1.) Mit dem jeweiligen „InheritDepth“-Wert hat der Aufrufer die Möglichkeit, bei der Ermittlung der Eigenschaften zum entsprechenden Merkmal hinsichtlich der Vererbung Einschränkungen vorzunehmen :
usw.
2.) Es gibt sogenannte „REKURSIVE“ Merkmale, die als Ausprägung wiederum Merkmale haben, d.h. alle (vordefinierten) Eigenschaften sind IDs.
Beispiel : Es sind mehrere „Preis“-Merkmale definiert, „Preis in EUR“, „Sonderpreis in EUR“, etc. Das Merkmal „Verkaufspreis (EUR)“ sei die Angabe, welches von den Preisen denn der für den Verkauf relevante ist. Möchte ich nun nach dem Verkaufspreis sortieren, ist es in der Regel gewünscht, daß nach dem tatsächlichen Preis sortiert werden soll - und nicht nach den Merkmal-IDs, die direkt zum Merkmal Verkaufspreis gespeichert sind !
In diesem Fall übergebe ich an der entsprechenden Stelle im Parameter „RecursiveEvaluationOptionList“ den Wert „1“. Ist das nicht gewünscht oder ist das Merkmal überhaupt kein rekursives Merkmal, ist „0“ anzugeben.
Wie schon bei „SortOptionList“ kann man auch für diese beiden Parameter „NULL“ angeben. Es wird dann automatisch KEINE Vererbung berücksichtigt und auch KEINE rekursive Auswertung durchgeführt !
HTTP-Method | GET |
HTTP-Auth | Optional |
Tags | |
Engine-Kategorie | item management |
Engine-Typ | Daten-Ermittlung |
Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
---|---|---|---|---|
LevelID | ID einer Hierarchiestufe (mögliche Werte : s. im_GetLevels_Pu). Im Ergebnis der Suche werden nur Elemente dieser Hierarchie ausgegeben. | tinyint | 5.5.1 | |
DomainTreeNodeID | 0 | ID eines Elementes im Artikelbaum. Die Suche bezieht sich nur auf Nachfolger (nicht nur direkte sondern auch Nachfolger der Nachfolger usw.) dieses Elementes. | integer | 5.5.1 |
StartAtRowNo | 1 | Erste Zeile der Ausgabe innerhalb des gesamten Suchergebnisses. Zusammen mit „RowCount“ kann man sich so durch das gesamte Ergebnis „blättern“. | integer | 5.5.1 |
RowCount | 100 | Anzahl der auszugebenden Datensätze des Suchergebnisses („0“ für alle Datensätze). Zusammen mit „StartAtRowNo“ kann man sich so durch das gesamte Ergebnis „blättern“. | integer | 5.5.1 |
IncludeInactiveNodes | 0 | „0“ : Nur aktive Elemente berücksichtigen „1“ : Auch inaktive Elemente können im Suchergebnis sein | bit | 5.5.1 |
Country | 'german' | Für Bedingungen anhand von Datums-Werten gibt dieser Parameter das Format an : * 'Germany' oder 'German' : Tag-Monat-Jahr (Standardwert) * 'England' oder 'English' : Monat-Tag-Jahr | varchar(10) | 5.5.1 |
BinaryCharacteristicValueID | NULL | ID einer Eigenschaft die „Binaries“ haben können (eine Dateigröße z.B.). Ermöglicht zu jedem gefundenen Element die Ausgabe einer (kleinsten) „BinaryCodeID“ (siehe Rückgabemenge), das diese Eigenschaft besitzt. | integer | 5.5.1 |
SortByCharacteristicIDList | NULL | Liste von (durch „¶“ getrennt) bis zu drei Merkmal-IDs, zu denen die Eigenschaften der ermittelten Elemente bestimmt werden und nach denen dann („SortOptionList“ entsprechend) sortiert wird | varchar(50) | 5.5.1 |
SortOptionList | NULL | Liste von (durch „¶“ getrennt) Optionen, WIE nach der Eigenschaft zum entsprechenden Merkmal in „SortByCharacteristicIDList“ (heißt : an der gleichen Position in der Liste) sortiert werden soll. Genaueres : s. Beschreibung ! | varchar(50) | 5.5.1 |
InheritDepthOptionList | NULL | Gibt an, ob bei der Ermittlung der Eigenschaften zum entsprechenden Merkmal in „SortByCharacteristicIDList“ (heißt : an der gleichen Position in der Liste) die Vererbung beachtet werden soll oder nicht. Genaueres : s. Beschreibung ! | varchar(50) | 5.5.1 |
RecursiveEvaluationOptionList | NULL | Gibt an, ob bei der Ermittlung der Eigenschaften zum entsprechenden Merkmal in „SortByCharacteristicIDList“ (heißt : an der gleichen Position in der Liste) evtl. eine rekursive Auswertung durchgeführt werden soll oder nicht. Genaueres : s. Beschreibung ! | varchar(50) | 5.5.1 |
GetValuesForSortByCharacs | 0 | Gibt an, ob die zur Sortierung ermittelten Eigenschaften zu den in „SortByCharacteristicIDList“ angegeben Merkmalen auch in der Rückgabemenge (s. Spalten „Value_1“, „Value_2“ und „Value_3“) enthalten sein sollen („1“) oder nicht („0“). | bit | 5.5.1 |
OutputIntoOneID | 0 | s. Beschreibung ! Ergebnismenge ? | IDs in OneID ein-/hinzufügen ? „0“ : ja | nein „1“ : nein | alle einf. „2“ : nein | RowCount viele einf. „3“ : ja | alle einf. „4“ : ja | die des Ergebn. einf. „5“ : nein | alle hinzuf. „6“ : ja | alle hinzuf. | tinyint | 5.5.1 |
FilterTreeNodesInOneID | 0 | Soll eine Menge von Elementen des Artikelbaums anhand der Suchebedingungen GEFILTERT werden, übergibt man die entsprechenden „TreeNodeID“s in „tempdb.dbo.OneID“ und setzt diesen Parameter auf „1“ | bit | 5.5.1 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
SortNo5) | Wird nicht zurückgegeben, aber zur Sortierung der Rückgabemenge verwendet. Bestimmt die Reihenfolge des Elementes „TreeNodeID“ innerhalb aller Nachfolger von „PredecessorsTreeNodeID“ | smallint | 5.5.1 |
PredecessorSortNo6) | Wird nicht zurückgegeben, aber zur Sortierung der Rückgabemenge verwendet. Bestimmt die Reihenfolge des Elementes „PredecessorsTreeNodeID“ innerhalb aller Nachfolger von „PrePredecessorsTreeNodeID“ | smallint | 5.5.1 |
ValueSortNo_17) | Diese Spalte wird nicht ausgegeben, sondern dient nur dazu, die Sortierung zu erklären, falls „SortByCharacteristicIDList“ angegeben wurde ! Dieser Wert bestimmt die Reihenfolge der Eigenschaft „Value_1“ von „NodeID“ innerhalb aller „Value_1“-Werte. | integer | 5.5.1 |
ValueSortNo_28) | Diese Spalte wird nicht ausgegeben, sondern dient nur dazu, die Sortierung zu erklären, falls „SortByCharacteristicIDList“ angegeben wurde ! Dieser Wert bestimmt die Reihenfolge der Eigenschaft „Value_2“ von „NodeID“ innerhalb aller „Value_2“-Werte. | integer | 5.5.1 |
ValueSortNo_39) | Diese Spalte wird nicht ausgegeben, sondern dient nur dazu, die Sortierung zu erklären, falls „SortByCharacteristicIDList“ angegeben wurde ! Dieser Wert bestimmt die Reihenfolge der Eigenschaft „Value_3“ von „NodeID“ innerhalb aller „Value_3“-Werte. | integer | 5.5.1 |
PrePredecessorsTreeNodeID | ID des Vor-Vorgänger-Elementes im Artikelbaum des gefundenen Elementes | integer | 5.5.1 |
PrePredecessorsDescription | Bezeichnung des Vor-Vorgängers | varchar(100) | 5.5.1 |
PredecessorsTreeNodeID | ID des Vorgänger-Elementes im Artikelbaum des gefundenen Elementes | integer | 5.5.1 |
PredecessorsDescription | Bezeichnung des Vorgängers | varchar(100) | 5.5.1 |
TreeNodeID | ID des gefundenen Elementes im Artikelbaum | integer | 5.5.1 |
Active | Ist „TreeNodeID“ z.Zt. aktiviert ? („0“ : Nein, „1“ : Ja) | bit | 6.0.2 |
NodeID | ID des gefundenen Artikel-Elementes (der Hierarchie „LevelID“) | integer | 5.5.1 |
NodeDescription | Bezeichnung des gefundenen Elementes | varchar(100) | 5.5.1 |
BinaryCodeID | ID eines „Binaries“, das der „NodeID“ zugeordnet ist, und das „BinaryCharacteristicValueID“ als Eigenschaft besitzt. Da es prinzipiell mehrere „Binaries“ mit dieser Eigenschaft geben könnte, wird immer das Binärobjekt mit der KLEINSTEN ID zurückgegeben | integer | 5.5.1 |
Value_1 | Eigenschaft der „NodeID“ zum ersten in „SortByCharacteristicIDList“ angegeben Merkmal. Immer „NULL“, wenn „GetValuesForSortByCharacs = 0“ ! | varchar(1000) | 5.5.1 |
Value_2 | Eigenschaft der „NodeID“ zum zweiten in „SortByCharacteristicIDList“ angegeben Merkmal. Immer „NULL“, wenn „GetValuesForSortByCharacs = 0“ ist oder wenn nur ein Merkmal in „SortByCharacteristicIDList“ angegeben wurde ! | varchar(1000) | 5.5.1 |
Value_3 | Eigenschaft der „NodeID“ zum dritten in „SortByCharacteristicIDList“ angegeben Merkmal. Immer „NULL“, wenn „GetValuesForSortByCharacs = 0“ ist oder wenn nur zwei Merkmale in „SortByCharacteristicIDList“ angegeben wurden ! | varchar(1000) | 5.5.1 |
wenn SortByCharacteristicIDList is NULL
wenn SortByCharacteristicIDList is NOT NULL
NumberOfElementsInResult | Ausgabeparameter, um zu erfahren, wieviele Elemente insgesamt gefunden wurden |
Code | Beschreibung | Quelle 10) |
---|---|---|
-621 | Fehlender oder falscher Eintrag in PersonTypeSettings | nur indirekt |
-569 | Der Benutzer hat kein Ausführungsrecht für die Prozedur | nur indirekt |
-567 | Die Prozedur darf z. Zt. nicht ausgeführt werden | nur indirekt |
-566 | Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werden | nur indirekt |
-550 | Fehlender oder falscher Eintrag in Settings | nur indirekt |
-535 | Das Datum liegt nicht in der Vergangenheit | nur indirekt |
-530 | Der Wert ist nicht konvertierbar | nur indirekt |
-510 | Der Benutzer ist nicht registriert | nur indirekt |
-504 | Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochen | nur indirekt |
-502 | Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen) | nur indirekt |
-500 | Falsche Parameter | direkt und indirekt |
-286 | Der Benutzer hat nicht die Berechtigung(en), Eigenschaften zu diesem(n) Merkmal(en) zu lesen/ändern | nur indirekt |
-284 | Der Benutzer hat keine Berechtigung, Eigenschaften zu diesem(n) Merkmal(en) zu modifizieren | nur indirekt |
-283 | Der Benutzer hat keine Berechtigung, Eigenschaften zu diesem(n) Merkmal(en) zu ermitteln | nur indirekt |
-120 | Der Benutzer hat keine Berechtigung für das (die) Element(e) | nur indirekt |
Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.
7.0.7 | 2015-01-29 | Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf] |
7.0.2 | 2013-08-29 | Kleiner Fehler bzgl. „print“-Ausgabe |
7.0.1 | 2013-08-07 | Datentyp der Rückgabespalten „Value_…“ hat sich erweitert ⇒ Auch Anpassung der Doku |
6.5.3 | 2013-03-18 | Interne Anpassungen wg. UTF8-Unterstützung |
6.0.7 | 2012-05-08 | Input- und Output-Tabelle von „_im_SortTreeNodesByProps“ sowie evtl. die Output-Tabelle von „_im_SearchTNodes“ werden nun zusätzlich NACH Verwendung der Proezdur geleert [Ticket #2899] |
6.0.5 | 2011-12-13 | 1. Falsche Belegung für „NumberOfElementsInResult“ im Fall „OutputIntoOneID IN (5,6)“ sofern IDs übergeben wurden, die NICHT im eigentlichen Suchergebnis vorkamen 2. Beim leeren Ergebnis war „NodeDescription“ an einer anderen (entgegen der Doku) Stelle |
6.0.2 | 2011-06-08 | Neue Rückgabespalte „Active“ |
6.0.1 | 2010-07-20 | Holger Wies : Neues Feature „Ergebnis in OneID ergänzen [#1392]„ |
6.0.0 | 2010-03-26 | Fehler : Im Fall „FilterTreeNodesInOneID = 1“ wurde „LevelID“ nicht beachtet, man konnte also auch Elemente anderer Hierarchien im Ergebnis erhalten ! |
5.5.1 | 2008-07-29 | Erstmalig in dieser Version erstellt |
Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:
Unformatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/im_SearchTreeNodes_Ad?LevelID=<value>'
Mit xmllint 11) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/im_SearchTreeNodes_Ad?LevelID=<value>' | xmllint --format -
use dStore_php\WebService; $service = new WebService\Service( WebService\Scheme::HTTP,'<partner>-<project>.dstore.de', 80); $request = new WebService\Requests\Engine\Procedure\Request( new WebService\Requests\AccessData('default'), 'im_SearchTreeNodes_Ad', array( 'LevelID' => <value>, // 'DomainTreeNodeID' => 0, // 'StartAtRowNo' => 1, // 'RowCount' => 100, // 'IncludeInactiveNodes' => 0, // 'Country' => 'german', // 'BinaryCharacteristicValueID' => NULL, // 'SortByCharacteristicIDList' => NULL, // 'SortOptionList' => NULL, // 'InheritDepthOptionList' => NULL, // 'RecursiveEvaluationOptionList' => NULL, // 'GetValuesForSortByCharacs' => 0, // 'OutputIntoOneID' => 0, // 'FilterTreeNodesInOneID' => 0 ) ); $service->execute($request); $xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument(); $ResultSet = $xml_result->getRowsAsArray(); $OutputParams = $xml_result->getOutputParametersAsArray();
XML zur Ausführung mit der Methode engine/execute, z.B. per
curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>'
<?xml version="1.0" encoding="UTF-8"?> <ListOfBatches> <Batch No="0"> <Procedure Name="im_SearchTreeNodes_Ad"> <Parameters> <Parameter Name="LevelID"><!-- tinyint value --></Parameter> <!-- <Parameter Name="DomainTreeNodeID">0</Parameter> --> <!-- <Parameter Name="StartAtRowNo">1</Parameter> --> <!-- <Parameter Name="RowCount">100</Parameter> --> <!-- <Parameter Name="IncludeInactiveNodes">0</Parameter> --> <!-- <Parameter Name="Country">'german'</Parameter> --> <!-- <Parameter Name="BinaryCharacteristicValueID">NULL</Parameter> --> <!-- <Parameter Name="SortByCharacteristicIDList">NULL</Parameter> --> <!-- <Parameter Name="SortOptionList">NULL</Parameter> --> <!-- <Parameter Name="InheritDepthOptionList">NULL</Parameter> --> <!-- <Parameter Name="RecursiveEvaluationOptionList">NULL</Parameter> --> <!-- <Parameter Name="GetValuesForSortByCharacs">0</Parameter> --> <!-- <Parameter Name="OutputIntoOneID">0</Parameter> --> <!-- <Parameter Name="FilterTreeNodesInOneID">0</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>