Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:im_searchtreenodes_pu

im_SearchTreeNodes_Pu

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 :

  • „0“ : Es wird NUR eine Ergebnismenge bereitgestellt
  • „1“ : Es wird KEINE Ergebnismenge ausgegeben, stattdessen werden ALLE gefundenen „TreeNodeID“s in „tempdb.dbo.OneID“ eingefügt (d.h. „StartAtRowNo“ und „RowCount“ werden ignoriert)
  • „2“ : Es wird KEINE Ergebnismenge ausgegeben, stattdessen werden die gefundenen „TreeNodeID“s AB dem durch „StartAtRowNo“ gekennzeichneten Datensatz in „tempdb.dbo.OneID“ eingefügt, jedoch nur soviele, wie durch „RowCount“ angegeben
  • „3“ : Es wird eine Ergebnismenge bereitgestellt UND ALLE gefundenen „TreeNodeID“s werden in „tempdb.dbo.OneID“ gespeichert
  • „4“ : Es wird eine Ergebnismenge bereitgestellt UND die in dieser Ergebnismenge enthaltenen „TreeNodeID“s werden in „tempdb.dbo.OneID“ gespeichert
  • „5“ : Es wird KEINE Ergebnismenge bereitgestellt, stattdessen werden ALLE gefundenen TreeNodeIDs in tempdb.dbo.OneID ergänzt. Bereits zur ServerProcessID vorhandene IDs in „OneID“ werden NICHT gelöscht!
  • „6“ : Es wird eine Ergebnismenge bereitgestellt (die StartAtRowNo und RowCOunt beachtet, und ALLE gefundenen TreeNodeIDs in tempdb.dbo.OneID ergänzt. Bereits zur ServerProcessID vorhandene IDs in „OneID“ werden NICHT gelöscht

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 :

  • „1“ : ABsteigende Sortierung nach der zur Eigenschaft zugehörigen „SortNo“ aus „NodeCharacteristicValues“
  • „2“ : AUFsteigende Sortierung nach der zur Eigenschaft zugehörigen „SortNo“ aus „NodeCharacteristicValues“
  • „4“ : ABsteigende Sortierung nach den Werten selbst. Dabei wird bei „Text“-Eigenschaften die Groß- und Kleinschreibung grundsätzlich NICHT beachtet.
  • „8“ : AUFsteigende Sortierung nach den Werten selbst. Dabei wird bei „Text“-Eigenschaften die Groß- und Kleinschreibung grundsätzlich NICHT beachtet.
  • „16“ : „NULL“-Werte (d.h. es ist KEINE Eigenschaft vorhanden) werden nach UNTEN sortiert
  • „32“ : „NULL“-Werte (d.h. es ist KEINE Eigenschaft vorhanden) werden nach OBEN sortiert

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 :

  • -1 : alle direkten und geerbten Eigenschaften berücksichtigen
  • 0 : keine geerbten Eigenschaften beachten
  • 1 : zusätzlich einfach geerbte Eigenschaften berücksichtigen
  • 2 : zusätzlich einfach und zweifach geerbte Eigenschaften berücksichtigen

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-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategorieitem management
Engine-TypDaten-Ermittlung
Letzte Aktualisierung7.0.2 (2013-08-29)

Parameter

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.
tinyint5.5.0
DomainTreeNodeID0 ID eines Elementes im Artikelbaum. Die Suche bezieht sich nur auf Nachfolger (nicht nur direkte sondern auch Nachfolger der Nachfolger usw.) dieses Elementes.
integer5.5.0
StartAtRowNo1 Erste Zeile der Ausgabe innerhalb des gesamten Suchergebnisses. Zusammen mit „RowCount“ kann man sich so durch das gesamte Ergebnis „blättern“.
integer5.5.0
RowCount100 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“.
integer5.5.0
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.0
BinaryCharacteristicValueIDNULL 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.
integer5.5.0
SortByCharacteristicIDListNULL 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.0
SortOptionListNULL 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.0
InheritDepthOptionListNULL 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.0
RecursiveEvaluationOptionListNULL 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.0
GetValuesForSortByCharacs0 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“).
bit5.5.0
OutputIntoOneID0 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.
tinyint5.5.0
FilterTreeNodesInOneID0 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“
bit5.5.0

Rückgabe

wenn OutputIntoOneID IN (0,3,4,6)

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“
smallint5.5.0
PredecessorSortNo6)Wird nicht zurückgegeben, aber zur Sortierung der Rückgabemenge verwendet. Bestimmt die Reihenfolge des Elementes „PredecessorsTreeNodeID“ innerhalb aller Nachfolger von „PrePredecessorsTreeNodeID“
smallint5.5.0
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.
integer5.5.0
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.
integer5.5.0
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.
integer5.5.0
PrePredecessorsTreeNodeIDID des Vor-Vorgänger-Elementes im Artikelbaum des gefundenen Elementes
integer5.5.0
PrePredecessorsDescriptionBezeichnung des Vor-Vorgängers
varchar(100)5.5.0
PredecessorsTreeNodeIDID des Vorgänger-Elementes im Artikelbaum des gefundenen Elementes
integer5.5.0
PredecessorsDescriptionBezeichnung des Vorgängers
varchar(100)5.5.0
TreeNodeIDID des gefundenen Elementes im Artikelbaum
integer5.5.0
NodeIDID des gefundenen Artikel-Elementes (der Hierarchie „LevelID“)
integer5.5.0
NodeDescriptionBezeichnung des gefundenen Elementes
varchar(100)5.5.0
BinaryCodeIDID 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
integer5.5.0
Value_1Eigenschaft der „NodeID“ zum ersten in „SortByCharacteristicIDList“ angegeben Merkmal. Immer „NULL“, wenn „GetValuesForSortByCharacs = 0“ !
varchar(1000)5.5.0
Value_2Eigenschaft 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.0
Value_3Eigenschaft 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.0
Sortierungen der Rückgabe

wenn SortByCharacteristicIDList is NULL

  • PrePredecessorsTreeNodeID (aufsteigend)
  • PredecessorSortNo (absteigend)
  • SortNo (absteigend)

wenn SortByCharacteristicIDList is NOT NULL

  • ValueSortNo_1 (aufsteigend)
  • ValueSortNo_2 (aufsteigend)
  • ValueSortNo_3 (aufsteigend)
  • TreeNodeID (aufsteigend)

Output-Parameter

NumberOfElementsInResultAusgabeparameter, um zu erfahren, wieviele Elemente insgesamt gefunden wurden

Mögliche Return-Codes

Code Beschreibung Quelle 10)
-621Fehlender oder falscher Eintrag in PersonTypeSettingsnur indirekt
-550Fehlender oder falscher Eintrag in Settingsnur indirekt
-535Das Datum liegt nicht in der Vergangenheitnur indirekt
-530Der Wert ist nicht konvertierbarnur indirekt
-510Der Benutzer ist nicht registriertnur indirekt
-504Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochennur indirekt
-500Falsche Parameterdirekt und indirekt
-286Der Benutzer hat nicht die Berechtigung(en), Eigenschaften zu diesem(n) Merkmal(en) zu lesen/ändernnur indirekt
-284Der Benutzer hat keine Berechtigung, Eigenschaften zu diesem(n) Merkmal(en) zu modifizierennur indirekt
-283Der Benutzer hat keine Berechtigung, Eigenschaften zu diesem(n) Merkmal(en) zu ermittelnnur indirekt
-120Der Benutzer hat keine Berechtigung für das (die) Element(e)nur indirekt

XML-Schema

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.

Historie

7.0.2 2013-08-29Kleiner Fehler bzgl. „print“-Ausgabe
7.0.1 2013-08-07Datentyp der Rückgabespalten „Value_…“ hat sich erweitert ⇒ Auch Anpassung der Doku
6.0.7 2012-05-08Input- 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.1 2010-07-20Holger Wies : Neues Feature „Ergebnis in OneID ergänzen [#1392]„
6.0.0 2010-03-26Fehler : Im Fall „FilterTreeNodesInOneID = 1“ wurde „LevelID“ nicht beachtet, man konnte also auch Elemente anderer Hierarchien im Ergebnis erhalten !
5.5.0 2008-01-07Erstmalig in dieser Version erstellt

Code-Snippets

Engine Playground

Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_SearchTreeNodes_Pu?LevelID=<value>'

Mit xmllint 11) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_SearchTreeNodes_Pu?LevelID=<value>' | xmllint --format -
dStore_php
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_Pu',
		array(
			'LevelID' => <value>,
			// 'DomainTreeNodeID' => 0,
			// 'StartAtRowNo' => 1,
			// 'RowCount' => 100,
			// '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();
engine/execute

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_Pu">
			<Parameters>
				<Parameter Name="LevelID"><!-- tinyint value --></Parameter>
				<!-- <Parameter Name="DomainTreeNodeID">0</Parameter> -->
				<!-- <Parameter Name="StartAtRowNo">1</Parameter> -->
				<!-- <Parameter Name="RowCount">100</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>
1)
Pflichtparameter sind unterstrichen
5) , 6) , 7) , 8) , 9)
Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.
10)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
11)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/im_searchtreenodes_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)