st_GetPeriodsToKeepStats_Ad [dstore]

Inhaltsverzeichnis

st_GetPeriodsToKeepStats_Ad

st_GetPeriodsToKeepStats_Ad

Hiermit kann man sich die Konfiguration ausgeben lassen, wie lange Daten in bestimmten Statistik-Tabellen gehalten werden sollen. Derzeit werden folgende Statistik-Tabellen unterstützt :

TreeNodeCharacteristicNos_PD
TreeNodeCharacteristicNos_PW
TreeNodeCharacteristicNos_PM
PersonCharacteristicNos_PD
PersonCharacteristicNos_PM

Anmerkungen :
1. Gemeinsam ist diesen Statistik-Tabellen, daß sie Daten enthalten, die immer einen Bezug zu einem Element des Artikelbaums mit Gültigkeitszeitraum (einer „HTreeNodeID“) haben. Daher bietet der „dStore“ die Möglichkeit, den Aufbewahrungszeitraum pro Hierarchie zu konfigurieren (→ Rückgabespalte „LevelNo“).
2. Außerdem gibt es pro Basis-Kennzahl (siehe st_GetBasicCharacteristics_Ad) die Möglichkeit zu bestimmen, wie lange die Daten gehalten werden sollen (→ Rückgabespalte „BasicCharacteristicNumber“).
3. Die Hierarchie hat Vorrang vor einer Basis-Kennzahl.
Beispiel :
Für „TreeNodeCharacteristicNos_PD“ sind zwei Datensätze konfiguriert, nämlich ein Datensatz zur „LevelNo = 5“ und für alle Basis-Kennzahlen (also „BasicCharacteristicNumber“ ist „NULL“), der zweite Datensatz für alle Hierarchien (also „LevelNo“ ist „NULL“) aber für die Basis-Kennzahl „1“.
Trifft nun auf einen Datensatz aus „TreeNodeCharacteristicNos_PD“ sowohl die Bedingung „LevelNo = 5“ als auch „BasicCharacteristicNumber = 1“ zu, wird die Konfiguration zum Datensatz mit „LevelNo = 5“ gewählt !

HTTP-Method	GET
HTTP-Auth	Optional
Alias	st_GetPeriodsToKeepStatistics_Ad
Tags	[st, Get, Periods, To, Keep, 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
TableName	NULL	Name einer Statistiktabelle. Falls angegeben, werden nur die Datensätze zu dieser Tabelle ausgegeben (mögliche Werte s. Beschreibung).	varchar(50)	3.5.18
LevelNo	NULL	Nummer einer Hierarchie. Falls angegeben, werden nur die Datensätze zu dieser Hierarchie berücksichtigt.	tinyint	3.5.18
BasicCharacteristicNumber	NULL	Optionale Einschränkung der Ergebnismenge anhand der „BasicCharacteristicNumber“	tinyint	3.5.18

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
TableName	Name einer Statistik-Tabelle. Mögliche Werte : siehe Beschreibung.	varchar(50)	3.5.18
LevelNo	Nummer einer Hierarchie. Falls hier „NULL“ steht, gilt der Aufbewahrungszeitraum „KeepStatistics“ für Daten zu Elementen mit einer beliebigen Hierarchie. Allerdings hat ein konfigurierter Wert für eine bestimmte Hierarchie Vorrang !	tinyint	3.5.18
LevelDescription	Bezeichnung der Hierarchie „LevelNo“	varchar(100)	3.5.18
BasicCharacteristicNumber	Nummer einer Basis-Kennzahl. Falls hier „NULL“ steht, gilt der Aufbewahrungszeitraum „KeepStatistics“ für Daten zu beliebigen Basis-Kennzahlen. Allerdings hat ein konfigurierter Wert für eine bestimmte Basis-Kennzahl Vorrang !	tinyint	3.5.18
BasicCharacteristic	Kurzbezeichnung der Basis-Kennzahl „BasicCharacteristicNumber“	varchar(25)	3.5.18
KeepStatistics	Anzahl Einheiten („TimeUnit“), die die Daten zur Basis-Kennzahl „BasicCharacteristicNumber“ für Elemente der Hierarchie „LevelNo“ aufbewahrt werden sollen (also z.B. 30 Tage)	smallint	3.5.18
TimeUnit	Einheit, in der „KeepStatistics“ angegeben ist. Mögliche Werte sind : „Days“, „Months“ und „Weeks“.	varchar(10)	3.5.18

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	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]
6.5.4	2013-04-29	Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
4.0.13	2004-05-18	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. Komplette Überarbeitung der Doku
3.5.18	2002-05-15	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_GetPeriodsToKeepStats_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/st_GetPeriodsToKeepStats_Ad'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/st_GetPeriodsToKeepStats_Ad' | 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_GetPeriodsToKeepStats_Ad',
		array(
			// 'TableName' => NULL,
			// 'LevelNo' => NULL,
			// 'BasicCharacteristicNumber' => 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_GetPeriodsToKeepStats_Ad">
			<Parameters>
				<!-- <Parameter Name="TableName">NULL</Parameter> -->
				<!-- <Parameter Name="LevelNo">NULL</Parameter> -->
				<!-- <Parameter Name="BasicCharacteristicNumber">NULL</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