st_GetPersonPDStatistics_Ad [dstore]

Inhaltsverzeichnis

st_GetPersonPDStatistics_Ad

st_GetPersonPDStatistics_Ad

Gibt Statistiken aus der Tabelle „PersonCharacteristicNos_PD“ aus.

Anmerkung :
Wird nach bestimmten „HTreeNodeID“s eingeschränkt, bekommt man zu diesen „HTreeNodeID“s für jeden Tag einen Wert zurück, auch wenn an diesem Tag für das Element nichts erfaßt ist - dann ist der Wert eben „0“.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[st, Get, Person, 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
PersonIDs		Nur relevant, falls „GetTopX = NULL“ ist ! Liste (durch '¶' getrennt) von IDs von Personen, für die Statistiken ermittelt werden sollen. Wird „NULL“ angegeben, erwartet die Prozedur in „tempdb.dbo.TwoIDs“ „PersonID“s (in „ID2“, „ID1“ muß „1“ enthalten).	varchar(255)	3.5.5
FromDate		Start-Zeitpunkt des zu untersuchenden Zeitraums. Hinweis: Ein Wert kleiner als „01.01.1997“ führt zum Fehler „-500“ !	datetime	3.5.5
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.5
BasicCharacteristicNumbers	NULL	Falls „GetTopX“ angegeben ist, muß hier genau eine „BasicCharacteristicNumber“ stehen. Ansonsten kann eine Liste (durch '¶' getrennt) von „BasicCharacteristicNumber“s übergeben werden, damit die Prozedur nur Statistiken zu diesen Kennzahlen ausgibt.	varchar(255)	3.5.5
HTreeNodeIDs	NULL	Falls „GetTopX“ angegeben ist, muß hier genau eine „HTreeNodeID“ stehen. Ansonsten kann eine Liste (durch '¶' getrennt) von „HTreeNodeID“s, nach denen gefiltert werden soll, angegeben werden. Bei '' werden IDs in „tempdb.dbo.TwoIDs“ erwartet („ID1 = 2“).	varchar(255)	3.5.5
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 „Day“ in diesem Fall dann immer „NULL“ enthält !	bit	3.5.12
GetTopX	NULL	Ist eine „Hit-Liste“ von Personen gewünscht, setzt man diesen Parameter, und es werden dann entsprechend viele („0“ für alle) Datensätze zurückgegeben. In diesem Fall müssen „HTreeNodeIDs“ und „BasicCharacteristicNumbers“ genau einen Wert enthalten !	tinyint	3.5.12

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
Date⁵⁾	Heißt seit Version 3.5.12 „Day“	datetime	3.5.5
Day	Ein (Tages-)Datum im Zeitraum „FromDate“ bis „ToDate“. „NULL“, falls „SummarizeDays = 1“ angegeben wurde.	datetime	3.5.12
BasicCharacteristicNumber	Nummer einer Basis-Kennzahl	tinyint	3.5.5
PersonID	ID einer Person	integer	3.5.5
Value1	Eigenschaft von „PersonID“ zum 1. Merkmal, das in „PersonTypeSettings“ zur „PersonTypeID“ von „PersonID“ zum Schlüssel „PersonOutputCharacteristics“ konfiguriert ist (u. nicht für den Aufrufer kompl. lesend gesperrt ist, s. pm_GetPChAccRestrForUsers_Ad)	varchar(100)	3.5.12
Value1RestrictedByPattern	Was enthält „Value1“ (womöglich wegen Zugriffsbeschränkungen nur einen Teil) ? - NULL : den vollständigen Wert - „#left(<n>)#“ : nur die ERSTEN n Zeichen - „#right(<n>)#“ : nur die LETZTEN n Zeichen Anmerkung : „n = 0“ möglich, „Value1“ ist dann NULL	varchar(100)	6.5.4
Value2	Eigenschaft von „PersonID“ zum 2. Merkmal, das in „PersonTypeSettings“ zur „PersonTypeID“ von „PersonID“ zum Schlüssel „PersonOutputCharacteristics“ konfiguriert ist (u. nicht für den Aufrufer kompl. lesend gesperrt ist, s. pm_GetPChAccRestrForUsers_Ad)	varchar(100)	3.5.12
Value2RestrictedByPattern	Wie „Value1RestrictedByPattern“ - nur eben auf „Value2“ bezogen	varchar(100)	6.5.4
HTreeNodeID	ID eines Elementes aus „HistoryTreeView“ (in dieser ist die Historie des gesamten Artikelbaums abgebildet)	integer	3.5.5
DirectValue	Summe der DIREKTEN Einträge zur Person „PersonID“ für das Element „HTreeNodeID“ zur Basis-Kennzahl „BasicCharacteristicNumber“ des Tages „Day“ bzw. (falls „SummarizeDays = 1“) im gesamten Zeitraum „FromDay“ bis „ToDay“	decimal(12,2)	3.5.5
TotalValue	Summe der GESAMTEN Einträge, also inkl. indirekter Einträge, zur Person „PersonID“ für das Element „HTreeNodeID“ zur Basis-Kennzahl „BasicCharacteristicNumber“ des Tages „Day“ bzw. (falls „SummarizeDays = 1“) im gesamten Zeitraum „FromDay“ bis „ToDay“	decimal(12,2)	3.5.5

Sortierungen der Rückgabe

wenn GetTopX is NULL

Day (aufsteigend)
BasicCharacteristicNumber (aufsteigend)
PersonID (aufsteigend)
HTreeNodeID (aufsteigend)

wenn GetTopX is NOT NULL

Day (aufsteigend)
TotalValue (absteigend)
PersonID (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁶⁾
-621	Fehlender oder falscher Eintrag in PersonTypeSettings	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
-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	direkt und 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	1. Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung 2. Implementierung des neuen Merkmal-Zugriffsbeschränkungen-Features [⇒ auch Hinweis in der Doku] 3. Neue Rückgabespalten „Value…RestrictedByPattern“
5.1.6	2006-09-14	Ab jetzt führt ein Wert kleiner als „01.01.1997“ für „FromDate“ oder „ToDate“ zum Fehler „-500“
5.1.5	2006-08-29	Explizites „ORDER BY“ eingefügt, um die Sortierung der Rückgabemenge zu garantieren
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 der Prozedur 3. Konsequente Fehlerbehandlung
4.0.5	2003-10-04	Verlagerung diverser „Settings“-Einträge auf entsprechende „PersonTypeSettings“-Einträge
3.5.20	2002-07-22
3.5.19	2002-06-17
3.5.13	2001-12-06
3.5.12	2001-10-17
3.5.5	2001-03-30	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_GetPersonPDStatistics_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁷⁾ formatierte Ausgabe:

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

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.

⁶⁾

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