Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:st_gettreenodepmstatistics_ad

st_GetTreeNodePMStatistics_Ad

Diese Prozedur gibt Monats-Statistiken aus der Tabelle „TreeNodeCharacteristicNos_PM“ aus.

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

HTTP-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategoriestatistics
Engine-TypDaten-Ermittlung
Letzte Aktualisierung7.0.7 (2015-01-29)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
FromMonth Ab welchem Monat (des Jahres „FromYear“) sollen die Statistiken berücksichtigt werden
tinyint3.5.0
FromYear In welchem Jahr liegt „FromMonth“. Hinweis: Ein Wert kleiner als „1997“ führt zum Fehler „-500“ !
smallint3.5.0
ToMonthNULL Bis zu welchem Monat (des Jahres „ToYear“) sollen die Statistiken berücksichtigt werden.
tinyint3.5.0
ToYearNULL In welchem Jahr liegt „ToMonth“. Wird „NULL“ angegeben, dann werden alle vorhandenen Statistiken ab dem Monat „FromMonth“/„FromYear“ berücksichtigt. Hinweis: Ein Wert kleiner als „1997“ führt zum Fehler „-500“ !
smallint3.5.0
BasicCharacteristicNumbersNULL 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
HTreeNodeIDsNULL 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
SummarizeMonths0 Möchte man für den Zeitraum „FromMonth“/„FromYear“ bis „ToMonth“/„ToYear“ nur die kummulierte Werte (also nicht pro Monat), gibt man „1“ an, wobei die Rückgabespalten „Month“ und „Year“ dann immer „NULL“ enthalten.
bit5.1.6

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
MonthEin Monat im Jahr „Year“, der im gewünschten Zeitraum liegt. Immer „NULL“, falls „SummarizeMonths = 1“ angegeben wurde.
tinyint3.5.0
YearEin Jahr zu dem der Monat „Month“ gehört (und das im gewünschten Zeitraum liegt). Immer „NULL“, falls „SummarizeMonths = 1“ angegeben wurde.
smallint3.5.0
HTreeNodeIDID eines Elementes aus „HistoryTreeView“ (in dieser ist die Historie des gesamten Artikelbaums abgebildet)
integer3.5.0
BasicCharacteristicNumberNummer einer Basis-Kennzahl
tinyint3.5.0
DirectValueSumme der DIREKTEN Einträge für das Element „HTreeNodeID“ zur Basis-Kennzahl „BasicCharacteristicNumber“ des Tages „Date“
decimal(12,2)3.5.0
TotalValueSumme 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)

  • Year (aufsteigend)
  • Month (aufsteigend)
  • HTreeNodeID (aufsteigend)
  • BasicCharacteristicNumber (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 5)
-569Der Benutzer hat kein Ausführungsrecht für die Prozedurnur indirekt
-567Die Prozedur darf z. Zt. nicht ausgeführt werdennur indirekt
-566Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werdennur indirekt
-535Das Datum liegt nicht in der Vergangenheitnur indirekt
-530Der Wert ist nicht konvertierbarnur indirekt
-510Der Benutzer ist nicht registriertnur indirekt
-504Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochennur indirekt
-502Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)nur indirekt
-500Falsche Parameterdirekt 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-29Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
6.5.4 2013-04-29Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
5.1.6 2006-09-141. Performance-Optimierung
2. Ab jetzt führt ein Wert kleiner als „1997“ für „FromYear“ oder „ToYear“ zum Fehler „-500“
3. Neuer Parameter „SummarizeMonths“
4.0.15 2004-07-301. 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-23Erstmalig 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_GetTreeNodePMStatistics_Ad?FromMonth=<value>&FromYear=<value>'

Mit xmllint 6) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/st_GetTreeNodePMStatistics_Ad?FromMonth=<value>&FromYear=<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_GetTreeNodePMStatistics_Ad',
		array(
			'FromMonth' => <value>,
			'FromYear' => <value>,
			// 'ToMonth' => NULL,
			// 'ToYear' => NULL,
			// 'BasicCharacteristicNumbers' => NULL,
			// 'HTreeNodeIDs' => NULL,
			// 'SummarizeMonths' => 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_GetTreeNodePMStatistics_Ad">
			<Parameters>
				<Parameter Name="FromMonth"><!-- tinyint value --></Parameter>
				<Parameter Name="FromYear"><!-- smallint value --></Parameter>
				<!-- <Parameter Name="ToMonth">NULL</Parameter> -->
				<!-- <Parameter Name="ToYear">NULL</Parameter> -->
				<!-- <Parameter Name="BasicCharacteristicNumbers">NULL</Parameter> -->
				<!-- <Parameter Name="HTreeNodeIDs">NULL</Parameter> -->
				<!-- <Parameter Name="SummarizeMonths">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
6)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/st_gettreenodepmstatistics_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)