Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- engine:procedures:im_gethtreenodeids_ad [11.01.2016 ]
+++ engine:procedures:im_gethtreenodeids_ad [11.01.2016 ] (aktuell)
@@ Zeile 1: / Zeile 1: @@
+===== im_GetHTreeNodeIDs_Ad =====
+Gibt die Historie für ein Artikel-Element bzw. ein Element des Artikelbaums zurück, d.h. die zugehörigen sogenannten "HTreeNodeID"s.\\
+Anmerkung zum Begriff "HTreeNodeID" und zum Parameter "GetHierarchyIndependentNodes" :\\
+Eine "HTreeNodeID" ist ein Element im "Artikelbaum" mit Gültigkeitszeitraum. Jedes Element im "Artikelbaum" besitzt einen/mehrere Gültigkeitszeitraum/-zeiträume. Für gelöschte Elemente ist dieser Zeitraum abgeschlossen, für momentan gültige (unabhängig davon ob aktiviert oder nicht !!!) Elemente ist dieser Zeitraum OFFEN. Bekommt ein Element eine andere Position im Artikelbaum (d.h. wird es "verschoben"), so existieren mindestens ZWEI Gültigkeitszeiträume : die alte(n) Position(en) im Baum haben natürlich abgeschlossene Zeiträume, die neue (nach dem Verschieben) hat entsprechend einen offenen Zeitraum.\\
+Besonderheit : DERZEIT hat jedes Artikel-Element ("NodeID") eine EINDEUTIGE Position im Artikelbaum ("TreeNodeID"). Es ist jedoch vorgesehen, ein Element MEHRFACH im Baum einordnen zu können. Dies hat zur Folge, daß man bei einer Produktsuche die gefundenen Elemente nicht unbedingt EINDEUTIG in der Hierarchie einordnen kann. DESWEGEN gibt es zu jeder "NodeID" GENAU EINE\\ "HTreeNodeID" mit einem offenen Gültigkeitszeitraum, wobei die "TreeNodeID" unbekannt ist (Weil dieses Element aber in jedem Fall unterhalb des "Wurzel-Elementes" liegt, ist als "TreeNodeID" die "0" angegeben !) Sollen diese speziellen Elemente ebenfalls in der Ergebnismenge sein, setzt man "GetHierarchyIndependentNodes" auf "1", ansonsten auf "0".\\
+Anmerkung zur Rückgabespalte "PrePredecessorTreeNodeID" :\\ Der Vorgänger des Vorgängers eines Elementes im Artikelbaum ist in einem Zeitraum NICHT unbedingt eindeutig - das ist er nur zu einem ZeitPUNKT. Daher muß ein Zeitpunkt für den Vorgänger "PrePredecessorTreeNodeID" gewählt werden; die Prozedur nimmt daher den Beginn des Gültigkeitszeitraumes von "TreeNodeID", also "FromDate".\\
+|HTTP-Method|GET |
+|HTTP-Auth|Optional |
+|Tags|{{tag>[im Get Tree Node Ds Ad]}}|
+|Engine-Kategorie|item management |
+|Engine-Typ|Daten-Ermittlung |
+|Letzte Aktualisierung|7.0.7 (2015-01-29)|
+==== Parameter ====
+^Name ((Pflichtparameter sind unterstrichen)) ^Standard-Wert ^Beschreibung ((siehe [[webservice:engine_parameterconventions|Parameter-Konventionen engine/<Prozedur-Name>]])) ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^
+|__NodeID__| |ID des Artikel-Elementes bzw. Elementes im Artikelbaum (je nach "IsTreeNodeID"), zu dem die Historie ermittelt werden soll. Falls "NULL" angegeben wird, erwartet die Prozedur IDs in "tempdb.dbo.OneID".\\ |integer|4.0.0|
+|IsTreeNodeID|1 |"0" : Bei "NodeID" bzw. den IDs in "tempdb.dbo.OneID" handelt es sich um (ein) Artikel-Element(e) ("NodeID"s aus der Tabelle "dStore")\\ "1" : Die "NodeID" bzw. die IDs in "tempdb.dbo.OneID" sind Elemente des Artikelbaums ("TreeNodeID"s aus "TreeView")\\ |bit|4.0.0|
+|GetHierarchyIndependentNodes|0 |siehe Beschreibung (Anmerkung zum Begriff "HTreeNodeID" und zum Parameter "GetHierarchyIndependentNodes")\\ |bit|4.0.0|
+==== Rückgabe ====
+=== (parameterunabhängig) ===
+^Spaltenname  ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^
+|HTreeNodeID|ID eines zur "TreeNodeID" zugehörigen Elementes aus "HistoryTreeView", in der die Historie des gesamten Artikelbaums abgebildet wird\\ |integer|4.0.0 |
+|TreeNodeID|Falls "IsTreeNodeID = 1" ist, entspricht der Wert der "NodeID" bzw. einer in "tempdb.dbo.OneID" übergebenen ID, ansonsten handelt es sich um ein Element im Artikelbaum, das "NodeID" als Artikel-Element zugewiesen hat\\ |integer|4.0.0 |
+|NodeID|Falls "IsTreeNodeID = 0" ist, entspricht der Wert der "NodeID" bzw. einer in "tempdb.dbo.OneID" übergebenen ID, ansonsten ist es die ID des zur "TreeNodeID" zugehörigen Artikel-Elementes\\ |integer|4.0.0 |
+|NodeDescription|Bezeichnung der "NodeID"\\ |varchar(100)|4.0.0 |
+|FromDate|Beginn des Gültigkeitszeitraums der "HTreeNodeID"\\ |datetime|4.0.0 |
+|FromDate_char|"FromDate" als "String" im Format "05.08.2000 18:45:22"\\ |varchar(19)|4.0.0 |
+|ToDate|Ende des Gültigkeitszeitraums der "HTreeNodeID" - falls "NULL", ist "HTreeNodeID" aktuell noch gültig\\ |datetime|4.0.0 |
+|ToDate_char|"ToDate" als "String" im Format "05.08.2000 18:45:22"\\ |varchar(19)|4.0.0 |
+|PredecessorTreeNodeID|ID des Vorgängers von "TreeNodeID" (im Zeitraum "FromDate" bis "ToDate")\\ |integer|4.0.0 |
+|PredecessorDescription|Bezeichnung des Vorgängers "PredecessorTreeNodeID"\\ |varchar(100)|4.0.0 |
+|PrePredecessorTreeNodeID|ID des zum Zeitpunkt "FromDate" gültigen Vorgängers von "PredecessorTreeNodeID" (siehe auch Beschreibung)\\ |integer|4.0.0 |
+|PrePredecessorDescription|Bezeichnung des Vor-Vorgängers "PrePredecessorTreeNodeID"\\ |varchar(100)|4.0.0 |
+== Sortierung der Rückgabe ==
+(parameterunabängige Sortierung)
+  * NodeID (aufsteigend)
+  * FromDate (aufsteigend)
+==== Output-Parameter ====
+Die Prozedur hat keine Output-Parameter.==== Mögliche Return-Codes ====
+^Code ^Beschreibung ^Quelle ((direkt meint "von der Prozedur selber" und indirekt meint "von intern aufgerufenen Unterprozeduren")) ^
+|-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|
+|-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|
+|-500|Falsche Parameter|nur indirekt|
+==== XML-Schema ====
+Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema [[http://resources.dstore.de/xsd/webservice_SmartGate/Response/EngineProcedure_v1_0.xsd|Response/EngineProcedure_v1_0.xsd]] validiert.
+==== Historie ====
+|7.0.7 |2015-01-29|Interne Änderung : Datentyp-Erweiterung des "ReferenceKey" [für "_mi_StartProcedure"-Aufruf]\\  |
+|5.1.9 |2007-01-26|1. Fehler : Es wurde bisher nicht beachtet, daß der Vor-Vorgänger zum gewählten Zeitpunkt nicht zwangsläufig noch in "HistoryTreeView" vorhanden sein muß, sondern gelöscht worden sein kann.\\ 2. Fehler in der Doku bzgl. "...Predecessor..."-Spalten\\  |
+|5.1.1 |2006-04-05|Intern Änderung, damit die Prozedur auch für ASE 15.x funktioniert\\  |
+|4.0.11 |2004-03-31|1. Aufruf der Prozeduren "_mi_StartProcedure" und "_mi_FinishProcedure"\\ 2. Ausführen von "set transaction isolation level 1" und "set rowcount 0" zu Beginn der Prozedur\\  |
+|4.0.1 |2003-05-16|Interne Dokumentations-Fehler\\  |
+|4.0.0 |2003-04-03|Erstmalig 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:
+  * [[http://playground.dstore.de/index.php?proc=im_GetHTreeNodeIDs_Ad|im_GetHTreeNodeIDs_Ad im Engine Playground öffnen]]
+== cURL ==
+Unformatierte Ausgabe:
+<code bash>
+curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_GetHTreeNodeIDs_Ad?NodeID=<value>'</code>Mit xmllint ((I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org)) formatierte Ausgabe:
+<code bash>
+curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_GetHTreeNodeIDs_Ad?NodeID=<value>' | xmllint --format -</code>== dStore_php ==
+<code 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_GetHTreeNodeIDs_Ad',
+		array(
+			'NodeID' => <value>,
+			// 'IsTreeNodeID' => 1,
+			// 'GetHierarchyIndependentNodes' => 0
+		)
+);
+$service->execute($request);
+			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
+			$ResultSet = $xml_result->getRowsAsArray();
+</code>
+== engine/execute ==
+XML zur Ausführung mit der Methode [[:webservice:engine:execute|engine/execute]], z.B. per
+  curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>'
+<code xml>
+<?xml version="1.0" encoding="UTF-8"?>
+<ListOfBatches>
+	<Batch No="0">
+		<Procedure Name="im_GetHTreeNodeIDs_Ad">
+			<Parameters>
+				<Parameter Name="NodeID"><!-- integer value --></Parameter>
+				<!-- <Parameter Name="IsTreeNodeID">1</Parameter> -->
+				<!-- <Parameter Name="GetHierarchyIndependentNodes">0</Parameter> -->
+			</Parameters>
+		</Procedure>
+	</Batch>
+</ListOfBatches></code>

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Unterschiede

Seiten-Werkzeuge