engine:procedures:st_gethtreenodestatistics_ad
Inhaltsverzeichnis
st_GetHTreeNodeStatistics_Ad
Gibt Statistiken zu einem Element im Artikelbaum mit Gültigkeitszeitraum, einer sogenannte „HTreeNodeID“ (Erläuterungen siehe im_GetHTreeNodeID_Pu), aus.
Anmerkung zum Parameter „ToDate“ :
Wird „NULL“ angegeben, wird nur der Tag / die Woche / der Monat betrachtet, auf den/die „FromDate“ fällt.
Anmerkungen zum Parameter „NodeCharacteristicID“ :
1. Die Rückgabespalten „…SimilarNodes“ enthalten den Anteil des jeweiligen Wertes zur „HTreeNodeID“ an dem entsprechenden Wert aller Elemente mit gleicher „NodeID“ wie „HTreeNodeID“ bzw. mit gleicher Eigenschaft (zum Zeitpunkt „FromDate“) zu diesem Merkmal.
2. Hintergrund für diesen Parameter ist die Tatsache, daß der „dStore“ im Gegensatz zu herkömmlichen Warenwirtschaftssystemen Artikel nicht aufgrund einer Artikelnummer eindeutig referenziert, sondern eine eigene (willkürliche) ID verwendet, und die Artikelnummer nichts weiteres ist, als eine Eigenschaft des Artikel-Elementes. Der Vorteil ist, daß man Artikel somit natürlich mehrfach im Artikelbaum anlegen kann. Was Statistiken anbelangt, ist es aber auf der anderen Seite wünschenswert, verschiedene Artikel, die die gleiche Artikelnummer besitzen, im Vergleich zu sehen. Daher ist der Standard-Wert für den Parameter auch die ID „6“ (für das vom „dStore“ vorgegebene Merkmal „Artikelnummer“)…
3. Hat das zur „HTreeNodeID“ zugehörige Artikel-Element zum Zeitpunkt „FromDate“ keine Eigenschaft zu diesem Merkmal, enthalten die Rückgabespalten „…SimilarNodes“ immer die gleiche Werte wie die entsprechenden „…HTreeNodeID“-Spalten.
4. Wird „NULL“ übergeben, bilden alle Elemente die Grundlage (für die Werte in den „…SimilarNodes“-Spalten), die die gleiche „NodeID“ wie „HTreeNodeID“ besitzen.
5. Im Fall „HTreeNodeID = 0“ wird dieser Parameter NICHT beachtet !
| HTTP-Method | GET |
| HTTP-Auth | Optional |
| Tags | |
| Engine-Kategorie | statistics |
| Engine-Typ | Daten-Ermittlung |
| Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Parameter
| Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
|---|---|---|---|---|
| HTreeNodeID | ID eines Elementes im Artikelbaum mit Gültigkeitszeitraum, zu dem Statistikdaten ermittelt werden sollen | integer | 3.5.0 | |
| FromDate | Start-Zeitpunkt des zu untersuchenden Zeitraums. Je nachdem, ob Tages-, Wochen- oder Monatsstatistiken (→ „SourceTable“) ermittelt werden sollen, werden die Minuten ignoriert bzw. es wird die Woche / der Monat gewählt, auf die das Datum fällt. | datetime | 3.5.0 | |
| ToDate | NULL | End-Zeitpunkt des zu untersuchenden Zeitraums. Je nachdem, ob Tages-, Wochen- oder Monatsstatistiken (→ „SourceTable“) ermittelt werden sollen, werden die Minuten ignoriert bzw. es wird die Woche / der Monat gewählt, auf die das Datum fällt. | datetime | 3.5.0 |
| SourceTable | 1 | Hierdurch wird angegeben, aus welchen Tabellen die statistischen Informationen gesammelt werden sollen… „1“ : „TreeNodeCharacteristicNos_PD“ (Tage) „2“ : „TreeNodeCharacteristicNos_PW“ (Wochen) „3“ : „TreeNodeCharacteristicNos_PM“ (Monate) | tinyint | 3.5.0 |
| BasicCharacteristicNumbers | NULL | Liste, die IDs von Basis-Kennzahlen (durch '¶' getrennt) enthält, zu denen Statistiken ermittelt werden sollen (mögliche Werte : s. st_GetBasicCharacteristics_Ad). Falls „NULL“ übergeben wird, gibt die Prozedur Statistiken zu allen Basis-Kennzahlen aus. | varchar(255) | 3.5.0 |
| NodeCharacteristicID | 6 | ID eines Merkmals. Die Rückgabespalten „…SimilarNodes“ enthalten den Anteil des jeweiligen Wertes zur „HTreeNodeID“ an dem entsprechenden Wert aller Elemente mit gleicher „NodeID“ wie „HTreeNodeID“ bzw. mit gleicher Eigenschaft zu diesem Merkmal. | smallint | 3.5.0 |
Rückgabe
(parameterunabhängig)
| Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
|---|---|---|---|
| DirectRelativeToTotal5) | Seit Version 4.0.0 entfallen, da der Wert lediglich („DirectValue_HTreeNodeID“ / „ TotalValue_HTreeNodeID“) * 100 entspricht, was genauso gut in der Client-Anwendung berechnet werden kann… | decimal(8,5) | 3.5.0 |
| TotalValueRelativeToNode6) | Seit Version 4.0.0 entfallen, da der Wert lediglich („TotalValue_HTreeNodeID“ / „ TotalValue_SimilarNodes“) * 100 entspricht, was genauso gut in der Client-Anwendung berechnet werden kann… | decimal(8,5) | 3.5.0 |
| TotalValue7) | Heißt seit Version 4.0.0 „TotalValue_HTreeNodeID“ | decimal(12,2) | 3.5.0 |
| DirectValue8) | Heißt seit Version 4.0.0 „DirectValue_HTreeNodeID“ | decimal(12,2) | 3.5.0 |
| ProductTotalValue9) | Heißt seit Version 4.0.0 „TotalValue_SimilarNodes“ | decimal(12,2) | 3.5.0 |
| ProductDirectValue10) | Heißt seit Version 4.0.0 „DirectValue_SimilarNodes“ | decimal(12,2) | 3.5.0 |
| TotalValueRelativeToRoot11) | Heißt seit Version 4.0.0 „PercentageOfItemTree“ | decimal(8,5) | 3.5.0 |
| TotalValueRelativeToShop12) | Heißt seit Version 4.0.0 „PercentageOfAllItems“ | decimal(8,5) | 3.5.0 |
| TotalValueRelativeToPred13) | Heißt seit Version 4.0.0 „PercentageOfPredecessor“ | decimal(8,5) | 3.5.0 |
| BasicCharacteristicNumber | Nummer einer Basis-Kennzahl | tinyint | 3.5.0 |
| BasicCharacteristic | Kurzbezeichnung der Basis-Kennzahl „BasicCharacteristicNumber“ | varchar(25) | 3.5.0 |
| Description | Beschreibung der Basis-Kennzahl „BasicCharacteristicNumber“ | varchar(100) | 3.5.0 |
| DirectValue_HTreeNodeID | Summe der DIREKTEN Einträge für „HTreeNodeID“ zur „BasicCharacteristicNumber“ | decimal(12,2) | 4.0.0 |
| TotalValue_HTreeNodeID | Summe der GESAMTEN Einträge, also inkl. indirekter Einträge, für „HTreeNodeID“ zur „BasicCharacteristicNumber“ | decimal(12,2) | 4.0.0 |
| DirectValue_SimilarNodes | Summe der DIREKTEN Einträge (zur „BasicCharacteristicNumber“) für alle Elemente, die die gleiche „NodeID“ wie „HTreeNodeID“ besitzen bzw. die gleiche Eigenschaft zum Merkmal „NodeCharacteristicID“ haben | decimal(12,2) | 4.0.0 |
| TotalValue_SimilarNodes | Summe der GESAMTEN Einträge, also inkl. indirekter Einträge, (zur „BasicCharacteristicNumber“) für alle Elemente, die die gleiche „NodeID“ wie „HTreeNodeID“ besitzen bzw. die gleiche Eigenschaft zum Merkmal „NodeCharacteristicID“ haben | decimal(12,2) | 4.0.0 |
| PercentageOfPredecessor | Prozentanteil von „TotalValue_HTreeNodeID“ am Wert des Vorgängers von „HTreeNodeID“ (zur Basis-Kennzahl „BasicCharacteristicNumber“) | decimal(8,5) | 4.0.0 |
| PercentageOfItemTree | Prozentanteil von „TotalValue_HTreeNodeID“ an der Summe der Werte zur Basis-Kennzahl „BasicCharacteristicNumber“ aller Elemente des Artikelbaums | decimal(8,5) | 4.0.0 |
| PercentageOfAllItems | Prozentanteil von „TotalValue_HTreeNodeID“ an der Summe der Werte zur Basis-Kennzahl „BasicCharacteristicNumber“ aller Elemente (also auch inkl. der „HTreeNodeID“s mit „TreeNodeID = 0“) | decimal(8,5) | 4.0.0 |
Output-Parameter
Die Prozedur hat keine Output-Parameter.
Mögliche Return-Codes
| Code | Beschreibung | Quelle 14) |
|---|---|---|
| -621 | Fehlender oder falscher Eintrag in PersonTypeSettings | nur indirekt |
| -599 | Lizenz ist ungültig oder abgelaufen | nur indirekt |
| -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 |
| -550 | Fehlender oder falscher Eintrag in Settings | 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 |
| -502 | Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen) | nur indirekt |
| -500 | Falsche Parameter | direkt und indirekt |
| -410 | Für den Zeitraum der Auswertung sind nicht mehr alle Daten vorhanden | nur direkt |
| -286 | Der Benutzer hat nicht die Berechtigung(en), Eigenschaften zu diesem(n) Merkmal(en) zu lesen/ändern | nur indirekt |
| -284 | Der Benutzer hat keine Berechtigung, Eigenschaften zu diesem(n) Merkmal(en) zu modifizieren | nur indirekt |
| -283 | Der Benutzer hat keine Berechtigung, Eigenschaften zu diesem(n) Merkmal(en) zu ermitteln | nur indirekt |
| -220 | Es konnte keine Merkmal-ID für die Produktbezeichnung ermittelt werden | nur 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-29 | Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf] |
| 7.0.1 | 2013-08-07 | Interne Anpassungen aufgrund der Datentyp-Erweiterung der „Value“-Spalte der Tabelle „NodeCharacteristicValues |
| 6.5.4 | 2013-04-29 | Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung |
| 5.1.5 | 2006-08-29 | Fehler : „LockedNodeCharacteristics“ wurde bisher GAR NICHT beachtet ! |
| 4.0.10 | 2004-03-15 | 1. Fehler bei gegebener „NodeCharacteristicID“ 2. Fehler in der Doku 3. „_mi_StartProcedure“, „_mi_FinishProcedure“ und „_mi_ChooseParamValueSeperator“ 4. „set transaction isolation level 1“, „set rowcount 0“ 5. Konsequente Fehlerbehandlung |
| 4.0.8 | 2004-02-20 | Interner Fehler beim Abschneiden der Uhrzeit-Angabe im Parameter „FromDate“ bzw. „ToDate“ |
| 4.0.0 | 2003-04-03 | 1. Falsche Indexangaben in einigen Fällen 2. Änderung fast aller Rückgabespalten-Namen 3. Jetzt wird überprüft, ob die Werte in „BasicCharacteristicNumbers“ auch existieren 4. Komplette Überarbeitung des Quellcodes und der internen Doku |
| 3.5.18 | 2002-05-15 | |
| 3.5.6 | 2001-04-17 | |
| 3.5.5 | 2001-03-30 | |
| 3.5.4 | 2001-03-11 | |
| 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:
cURL
Unformatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/st_GetHTreeNodeStatistics_Ad?HTreeNodeID=<value>&FromDate=<value>'
Mit xmllint 15) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/st_GetHTreeNodeStatistics_Ad?HTreeNodeID=<value>&FromDate=<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'), 'st_GetHTreeNodeStatistics_Ad', array( 'HTreeNodeID' => <value>, 'FromDate' => <value>, // 'ToDate' => NULL, // 'SourceTable' => 1, // 'BasicCharacteristicNumbers' => NULL, // 'NodeCharacteristicID' => 6 ) ); $service->execute($request); $xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument(); $ResultSet = $xml_result->getRowsAsArray();
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="st_GetHTreeNodeStatistics_Ad"> <Parameters> <Parameter Name="HTreeNodeID"><!-- integer value --></Parameter> <Parameter Name="FromDate"><!-- datetime value --></Parameter> <!-- <Parameter Name="ToDate">NULL</Parameter> --> <!-- <Parameter Name="SourceTable">1</Parameter> --> <!-- <Parameter Name="BasicCharacteristicNumbers">NULL</Parameter> --> <!-- <Parameter Name="NodeCharacteristicID">6</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5)
, 6)
, 7)
, 8)
, 9)
, 10)
, 11)
, 12)
, 13)
Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.
14)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
15)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/st_gethtreenodestatistics_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)