Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:im_getsuccessors_ad

im_GetSuccessors_Ad

Ermittelt zu einem oder mehreren Element(en) des Artikelbaums alle Nachfolger. Falls gewünscht, kann die Ausgabe auf die Nachfolger-Elemente reduziert werden, die sich auf einer bestimmten Hierarchie befinden.

Anstelle einer Rückgabemenge kann das Ergebnis auch in der Tabelle „tempdb.dbo.OneID“ gespeichert werden. Diese Tabelle dient dann quasi als Array-Schnittstelle für andere Prozeduren (z.B. im_GetNodeProperties).

Anmerkung zum Parameter „MaxNumberOfNodes“ :
Nicht „NULL“ übergeben, da dies nicht in allen Fällen (z.B. wenn die Ergebnismenge sortiert werden soll → „SortByCharacteristicIDList“) erlaubt ist. Immer „0“ übergeben, wenn man ALLE Nachfolger haben möchte !

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.7 (2015-01-29)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
TreeNodeList Liste von IDs von Elementen des Artikelbaums, für die die Nachfolger gesucht werden sollen
varchar(255)6.0.3
LevelNo0 Nummer einer Hierarchie. Falls ein Wert „> 0“ angegeben ist, werden nur die Nachfolger dieser Hierarchie ermittelt.
tinyint6.0.3
IncludeDeactivatedNodes0 „0“ : Nur aktive (Nachfolge-)Elemente ermitteln
„1“ : Auch inaktive (Nachfolge-)Elemente ermitteln
bit6.0.3
OutputIntoOneID0 Falls hierfür der Wert „1“ übergeben wird, gibt es keine Rückgabemenge, sondern die „TreeNodeID“s der Nachfolger werden in „tempdb.dbo.OneID“ gespeichert. (z.B. um danach eine andere Prozedur aufzurufen, die eine Übergabe von IDs via „OneID“ erlaubt).
bit6.0.3
FilterByCharacteristicIDNULL Nur Nachfolger, die „FilterByCharacValue“ als Eigenschaft zum Merkmal „FilterByCharacteristicID“ haben. (Achtung: Hierbei wird keine Vererbung berücksichtigt)
smallint6.0.3
FilterByCharacValueNULL Nur Nachfolger, die „FilterByCharacValue“ als Eigenschaft zum Merkmal „FilterByCharacteristicID“ haben. (Achtung: Hierbei wird keine Vererbung berücksichtigt)
varchar(1000)6.0.3
BinaryCharacteristicValueIDNULL ID einer Eigenschaft, die „Binaries“ haben können (eine Dateigröße z.B.). Ermöglicht zu jedem Nachfolger-Element die Ausgabe einer „BinaryCodeID“ (siehe Rückgabemenge), das diese Eigenschaft besitzt.
integer6.0.3
NegateFilterByParams0 Wird nur berücksichtigt, falls die „FilterBy…“-Parameter angegeben sind ! Bei Angabe von „1“ für diesen Parameter sind nur Elemente in der Rückgabemenge, die die Eigenschaft „FilterByCharacValue“ zum Merkmal „FilterByCharacteristicID“ NICHT haben.
bit6.0.3
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)6.0.3
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)6.0.3
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)6.0.3
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)6.0.3
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“).
bit6.0.3
FromRowNumber1 Standardmäßig werden immer ALLE Nachfolger ermittelt und auch zurückgegeben. Gibt man hier jedoch einen Wert an, werden nur die Daten ab dem „FromRowNumber“ten Datensatz ausgegeben. ACHTUNG : Wird natürlich nur im Fall „OutputIntoOneID = 0“ beachtet !
integer6.0.3
MaxNumberOfNodes0 Standardmäßig werden immer ALLE Nachfolger ermittelt und auch zurückgegeben. Gibt man hier jedoch einen Wert an, werden nur maximal soviele Datensätze ausgegeben, wie angegeben. ACHTUNG : Wird natürlich nur im Fall „OutputIntoOneID = 0“ beachtet !
integer6.0.3

Rückgabe

wenn OutputIntoOneID = 0

Spaltenname Beschreibung SQL-Datentyp4) ab Version
SortNo5)Wird nicht zurückgegeben, sondern nur zur Sortierung der Rückgabemenge verwendet, falls „SortByCharacteristicIDList = NULL“ ist. Bestimmt die Reihenfolge von „TreeNodeID“ innerhalb aller Nachfolger von „Predecessor“.
smallint6.0.3
ValueSortNo_16)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.
integer6.0.3
ValueSortNo_27)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.
integer6.0.3
ValueSortNo_38)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.
integer6.0.3
PredecessorID des Vorgängers von „TreeNodeID“
integer6.0.3
TreeNodeIDID eines Elementes im Artikelbaum, das Nachfolger eines der in „TreeNodeList“ übergebenen Elementes ist
integer6.0.3
NodeIDID des zur „TreeNodeID“ zugehörigen Artikel-Elementes
integer6.0.3
NodeDescriptionBezeichnung der „NodeID“
varchar(100)6.0.3
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.
integer6.0.3
Value_1Eigenschaft der „NodeID“ zum ersten in „SortByCharacteristicIDList“ angegeben Merkmal. Immer „NULL“, wenn „GetValuesForSortByCharacs = 0“ !
varchar(1000)6.0.3
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)6.0.3
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)6.0.3
Sortierungen der Rückgabe

wenn SortByCharacteristicIDList is NULL

  • Predecessor (aufsteigend)
  • SortNo (absteigend)

wenn SortByCharacteristicIDList is NOT NULL

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

Output-Parameter

CountÜber diesen Ausgabeparameter kann man erfahren, wieviele Nachfolger es insgesamt gibt. Eigentlich nur interessant, wenn „MaxNumberOfNodes“ angegeben wurde (es aber mehr Nachfolger gibt) oder die Daten in „tempdb.dbo.OneID“ eingefügt wurden.

Mögliche Return-Codes

Code Beschreibung Quelle 9)
-569Der Benutzer hat kein Ausführungsrecht für die Prozedurnur indirekt
-567Die Prozedur darf z. Zt. nicht ausgeführt werdennur indirekt
-566Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werdennur 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
-502Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)nur 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 ermittelndirekt und indirekt

XML-Schema

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

Historie

7.0.7 2015-01-29Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
7.0.1 2013-08-071. Datentyp-Erweiterung des Parameters „FilterByCharacValue“ [von 100 auf 1000]
2. Datentyp der Rückgabespalten „Value_…“ haben sich erweitert ⇒ Auch Anpassung der Doku
6.5.3 2013-03-18Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
6.0.7 2012-05-081. Fehler : In „Predecessor“ wurde eine der IDs zurückgegeben, zu der Nachfolger ermittelt wurden, und nicht der direkte Vorgänger des jew. Elementes
2. Input-/Output-Tabelle von „_im_GetSuccessors_Current“ wird zus. NACH Verw. der Prozedur geleert
6.0.3 2011-09-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_GetSuccessors_Ad?TreeNodeList=<value>'

Mit xmllint 10) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_GetSuccessors_Ad?TreeNodeList=<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_GetSuccessors_Ad',
		array(
			'TreeNodeList' => '<value>',
			// 'LevelNo' => 0,
			// 'IncludeDeactivatedNodes' => 0,
			// 'OutputIntoOneID' => 0,
			// 'FilterByCharacteristicID' => NULL,
			// 'FilterByCharacValue' => NULL,
			// 'BinaryCharacteristicValueID' => NULL,
			// 'NegateFilterByParams' => 0,
			// 'SortByCharacteristicIDList' => NULL,
			// 'SortOptionList' => NULL,
			// 'InheritDepthOptionList' => NULL,
			// 'RecursiveEvaluationOptionList' => NULL,
			// 'GetValuesForSortByCharacs' => 0,
			// 'FromRowNumber' => 1,
			// 'MaxNumberOfNodes' => 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_GetSuccessors_Ad">
			<Parameters>
				<Parameter Name="TreeNodeList"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="LevelNo">0</Parameter> -->
				<!-- <Parameter Name="IncludeDeactivatedNodes">0</Parameter> -->
				<!-- <Parameter Name="OutputIntoOneID">0</Parameter> -->
				<!-- <Parameter Name="FilterByCharacteristicID">NULL</Parameter> -->
				<!-- <Parameter Name="FilterByCharacValue">NULL</Parameter> -->
				<!-- <Parameter Name="BinaryCharacteristicValueID">NULL</Parameter> -->
				<!-- <Parameter Name="NegateFilterByParams">0</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="FromRowNumber">1</Parameter> -->
				<!-- <Parameter Name="MaxNumberOfNodes">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5) , 6) , 7) , 8)
Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.
9)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
10)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/im_getsuccessors_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)