st_GetTreeNodePDStatistics_Ad [dstore]

Inhaltsverzeichnis

st_GetTreeNodePDStatistics_Ad

st_GetTreeNodePDStatistics_Ad

Diese Prozedur gibt Tages-Statistiken aus der Tabelle „TreeNodeCharacteristicNos_PD“ aus.

Anmerkung zum Parameter „HTreeNodeIDs“ :
Werden hier „HTreeNodeID“s angegeben, enthält die Rückgabemenge garantiert zu jedem dieser Elemente und zu jedem Tag im angegebenen Zeitraum einen Datensatz.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[st, Get, Tree, Node, Statistics, Ad]
Engine-Kategorie	statistics
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
FromDate		Start-Zeitpunkt des zu untersuchenden Zeitraums. Hinweis: Ein Wert kleiner als „01.01.1997“ führt zum Fehler „-500“ !	datetime	3.5.0
ToDate	NULL	End-Zeitpunkt des zu untersuchenden Zeitraums. Wird „NULL“ angegeben, dann werden alle vorhandenen Statistiken ab „FromDate“ berücksichtigt. Hinweis: Ein Wert kleiner als „01.01.1997“ führt zum Fehler „-500“ !	datetime	3.5.0
BasicCharacteristicNumbers	NULL	Eine Liste (durch '¶' getrennt) von „BasicCharacteristicNumber“s (mögliche Werte : siehe st_GetBasicCharacteristics_Ad). Wird „NULL“ übergeben, ermittelt die Prozedur die Statistiken zu allen Basis-Kennzahlen, sonst nur zu den gewünschten.	varchar(255)	3.5.0
HTreeNodeIDs	NULL	Eine Liste (durch '¶' getrennt) von „HTreeNodeID“s (Elemente des Artikelbaums mit Gültigkeitszeitraum), nach denen gefiltert werden soll - sonst gibt die Prozedur Statistiken zu allen Elementen aus (zu den Statistiken vorhanden sind).	varchar(255)	3.5.0
SummarizeDays	0	Möchte man für den Zeitraum „FromDate“ bis „ToDate“ nur die kummulierte Werte (also nicht pro Tag), gibt man „1“ an, wobei die Rückgabespalte „Date“ in diesem Fall dann immer „NULL“ enthält !	bit	5.1.6

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
Date	Ein (Tages-)Datum im Zeitraum „FromDate“ bis „ToDate“. Hinweis: Immer „NULL“, falls „SummarizeDays = 1“ ist !	datetime	3.5.0
HTreeNodeID	ID eines Elementes aus „HistoryTreeView“ (in dieser ist die Historie des gesamten Artikelbaums abgebildet)	integer	3.5.0
BasicCharacteristicNumber	Nummer einer Basis-Kennzahl	tinyint	3.5.0
DirectValue	Summe der DIREKTEN Einträge für das Element „HTreeNodeID“ zur Basis-Kennzahl „BasicCharacteristicNumber“ des Tages „Date“	decimal(12,2)	3.5.0
TotalValue	Summe der GESAMTEN Einträge, also inkl. indirekter Einträge, für das Element „HTreeNodeID“ zur Basis-Kennzahl „BasicCharacteristicNumber“ des Tages „Date“	decimal(12,2)	3.5.0

Sortierung der Rückgabe

(parameterunabängige Sortierung)

Date (aufsteigend)
HTreeNodeID (aufsteigend)
BasicCharacteristicNumber (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-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
-502	Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)	nur indirekt
-500	Falsche Parameter	direkt 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-29	Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
6.5.4	2013-04-29	Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
5.1.6	2006-09-14	1. Ab jetzt führt ein Wert kleiner als „01.01.1997“ für „FromDate“ oder „ToDate“ zum Fehler „-500“ 2. Neuer Parameter „SummarizeDays“
4.0.15	2004-07-30	1. Aufruf der Prozeduren „_mi_StartProcedure“, „_mi_FinishProcedure“ und „_mi_ChooseParamValueSeperator“ 2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn 3. Konsequente Fehlerbehandlung 4. Fehler in der Doku
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:

st_GetTreeNodePDStatistics_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/st_GetTreeNodePDStatistics_Ad?FromDate=<value>'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/st_GetTreeNodePDStatistics_Ad?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_GetTreeNodePDStatistics_Ad',
		array(
			'FromDate' => <value>,
			// 'ToDate' => NULL,
			// 'BasicCharacteristicNumbers' => NULL,
			// 'HTreeNodeIDs' => NULL,
			// 'SummarizeDays' => 0
		)
);
 
$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_GetTreeNodePDStatistics_Ad">
			<Parameters>
				<Parameter Name="FromDate"><!-- datetime value --></Parameter>
				<!-- <Parameter Name="ToDate">NULL</Parameter> -->
				<!-- <Parameter Name="BasicCharacteristicNumbers">NULL</Parameter> -->
				<!-- <Parameter Name="HTreeNodeIDs">NULL</Parameter> -->
				<!-- <Parameter Name="SummarizeDays">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“

⁶⁾

I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Inhaltsverzeichnis