engine:procedures:im_getrootnodes_ad
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
|
engine:procedures:im_getrootnodes_ad [11.01.2016 ] |
engine:procedures:im_getrootnodes_ad [11.01.2016 ] (aktuell) |
||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| + | ===== im_GetRootNodes_Ad ===== | ||
| + | |||
| + | Ermittelt alle "Wurzel"-Elemente aus der Tabelle "TreeView", das sind Elemente, die keinen Vorgänger besitzen.\\ | ||
| + | |||
| + | Im Artikelbaum, der durch diese Tabelle abgebildet wird, gibt es nur ein Wurzel-Element (welches die ID "0" besitzt).\\ Darüber hinaus gibt es aber noch sogenannte "PageTreeNodes". Diese besitzen alle eine "TreeNodeID" kleiner "0". Gemeint sind Elemente, die nicht zur Artikelstruktur gehören, aber trotzdem in den Statistiken zur Basis-Kennzahl "1" ("Views") auftauchen sollen. Da die Anwendungsfälle hierfür im Regelfall Web-SEITEN (außerhalb der Produkt-Navigation) sind, deren Aufruf man zählen möchte, wurde der Name "Page"-TreeNodes gewählt. Diese "TreeNodes" sollten nur verwendet werden, wenn man am sogenannten "Click-Stream" eines Besuchers interessiert ist (siehe [[dstoreproc>st_GetClickStream_Ad]]), denn ansonsten gibt es die Tabelle "Pages", "PagesInCategories", "PageCategories" und "PageVisits", die dem Zählen von Seiten-Aufrufen dienen (siehe u.a. [[dstoreproc>st_GetPages_Ad]], [[dstoreproc>st_GetPageVisits_Ad]] etc.).\\ | ||
| + | |HTTP-Method|GET | | ||
| + | |HTTP-Auth|Optional | | ||
| + | |Tags|{{tag>[im Get Root Nodes 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 ^ | ||
| + | |OnlyActive|1 |"0" : Aktive und inaktive Elemente des Artikelbaums werden ausgegeben\\ "1" : Nur die aktiven Elemente des Artikelbaums werden ausgegeben\\ |bit|5.0.4| | ||
| + | |OnlyNotDeleted|1 |"0" : Alle Elemente des Artikelbaums werden prinzipiell berücksichtigt\\ "1" : Gelöscht Elemente des Artikelbaums werden nicht mitberücksichtigt (solche, für die in "TreeView" "Deleted = 1" ist)\\ |bit|5.0.4| | ||
| + | ==== Rückgabe ==== | ||
| + | |||
| + | === (parameterunabhängig) === | ||
| + | |||
| + | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |NodeID|ID des zur "TreeNodeID" zugehörigen Elementes aus der Tabelle "dStore"\\ |integer|3.5.0 | | ||
| + | |TreeNodeID|ID eines "Wurzel"-Elementes. Für den Artikelbaum gibt es nur ein Wurzel-Element, das die ID "0" hat. Alle anderen (sogenannten "PageTreeNodes") haben eine ID kleiner "0".\\ |integer|3.5.0 | | ||
| + | |InheritsFrom|ID eines Elementes, von dem Eigenschaften geerbt werden - diese Rückgabespalte hat eigentlich für Wurzel-Elemente keine Bedeutung, da im Regelfall immer vom Vorgänger (die genau diese Elemente ja nicht haben) geerbt wird...\\ |integer|3.5.0 | | ||
| + | |NodeDescription|Bezeichnung der "NodeID"\\ |varchar(100)|3.5.0 | | ||
| + | |Active|Ist "TreeNodeID" z.Zt. aktiviert ? ("0" : Nein, "1" : Ja)\\ |bit|3.5.0 | | ||
| + | |CountSuccessors|Wieviele direkte Nachfolger-Elemente besitzt "TreeNodeID" ? ACHTUNG : Bei der Ermittlung dieser Zahl wird ebenfalls "OnlyActive" und "OnlyNotDeleted" entsprechend gefiltert !\\ |integer|3.5.0 | | ||
| + | |SymbolID|ID eines Symbols, das der "NodeID" zugeordnet ist\\ |smallint|3.5.0 | | ||
| + | |LevelNo|Nummer der Hierarchie der "NodeID" (sollte immer "1" sein)\\ |tinyint|3.5.0 | | ||
| + | |SortNo|Bestimmt die Reihenfolge innerhalb aller Wurzel-Elemente\\ |smallint|3.5.0 | | ||
| + | |||
| + | == Sortierung der Rückgabe == | ||
| + | |||
| + | (parameterunabängige Sortierung) | ||
| + | * SortNo (absteigend) | ||
| + | * NodeDescription (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.0.4 |2005-09-26|1. Neue Parameter "OnlyActive" und "OnlyNotDeleted"\\ 2. Fehler : In "CountSuccessors" wurden bisher immer alle Nachfolge-Elemente gezählt, egal ob gelöscht bzw. aktiv oder nicht\\ 3. Fehler : "LockedTreeNodeIDs" wurde nicht berücksichtigt !\\ | | ||
| + | |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\\ 3. Änderung der Sortierung\\ | | ||
| + | |3.5.0 |2000-11-23|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_GetRootNodes_Ad|im_GetRootNodes_Ad im Engine Playground öffnen]] | ||
| + | == cURL == | ||
| + | Unformatierte Ausgabe: | ||
| + | <code bash> | ||
| + | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/im_GetRootNodes_Ad'</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_GetRootNodes_Ad' | 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_GetRootNodes_Ad', | ||
| + | array( | ||
| + | // 'OnlyActive' => 1, | ||
| + | // 'OnlyNotDeleted' => 1 | ||
| + | ) | ||
| + | ); | ||
| + | |||
| + | $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_GetRootNodes_Ad"> | ||
| + | <Parameters> | ||
| + | <!-- <Parameter Name="OnlyActive">1</Parameter> --> | ||
| + | <!-- <Parameter Name="OnlyNotDeleted">1</Parameter> --> | ||
| + | </Parameters> | ||
| + | </Procedure> | ||
| + | </Batch> | ||
| + | </ListOfBatches></code> | ||
engine/procedures/im_getrootnodes_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)