Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
— |
engine:procedures:im_getnumberofnodes_ad [11.01.2016 ] (aktuell) |
||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
+ | ===== im_GetNumberOfNodes_Ad ===== | ||
+ | |||
+ | Ermittelt die Anzahl der Elemente des Artikelbaums. Dabei können deaktivierte bzw. gelöschte Elemente mit einbezogen werden oder nicht.\\ | ||
+ | |||
+ | Außerdem ist es möglich, sich die Anzahl ALLER Datensätze in der Tabelle "TreeView" ausgeben zu lassen (siehe "OnlyItemNodes"), d.h. neben den Elementen des Artikelbaums werden auch die sogenannten "PageTreeNodes" berücksichtigt, die alle eine "TreeNodeID" kleiner "0" haben. Das 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 sogenannte "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 Number Of 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 ^ | ||
+ | |IncludeDeleted|0 |"0" : Nur nicht gelöschte Elemente anzeigen\\ "1" : Auch die als gelöscht markierten Elemente einbeziehen\\ |bit|3.5.0| | ||
+ | |IncludeDeActivated|1 |"0" : Nur aktive Elemente zählen\\ "1" : Auch deaktive Elemente mitzählen\\ |bit|3.5.0| | ||
+ | |OnlyItemNodes|1 |"0" : Alle Elemente der Tabelle "TreeView" berücksichtigen\\ "1" : Nur die Datensätze mit einer "TreeNodeID >= 0" zählen, d.h. nur die Elemente berücksichtigen, die auch zur Artikelstruktur gehören (sogenannte "PageTreeNodes" werden also nicht beachtet).\\ |bit|3.5.0| | ||
+ | ==== Rückgabe ==== | ||
+ | |||
+ | === (parameterunabhängig) === | ||
+ | |||
+ | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
+ | |NumberOfNodes|Anzahl der gezählten Elemente\\ |integer|3.5.0 | | ||
+ | ==== 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]\\ | | ||
+ | |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. Kleine Code-Vereinfachung\\ 4. Fehlende Doku der Rückgabemenge\\ | | ||
+ | |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_GetNumberOfNodes_Ad|im_GetNumberOfNodes_Ad im Engine Playground öffnen]] | ||
+ | == cURL == | ||
+ | Unformatierte Ausgabe: | ||
+ | <code bash> | ||
+ | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/im_GetNumberOfNodes_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_GetNumberOfNodes_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_GetNumberOfNodes_Ad', | ||
+ | array( | ||
+ | // 'IncludeDeleted' => 0, | ||
+ | // 'IncludeDeActivated' => 1, | ||
+ | // 'OnlyItemNodes' => 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_GetNumberOfNodes_Ad"> | ||
+ | <Parameters> | ||
+ | <!-- <Parameter Name="IncludeDeleted">0</Parameter> --> | ||
+ | <!-- <Parameter Name="IncludeDeActivated">1</Parameter> --> | ||
+ | <!-- <Parameter Name="OnlyItemNodes">1</Parameter> --> | ||
+ | </Parameters> | ||
+ | </Procedure> | ||
+ | </Batch> | ||
+ | </ListOfBatches></code> | ||