Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:co_getcommunitystatistics_ad

co_GetCommunityStatistics_Ad

Gibt statistische Informationen zu allen Communities (oder nur zu einer bestimmten Community) innerhalb eines Zeitraums aus.

ACHTUNG: Im Falle „CalculateSum = 1“ wird kein Wert zur Information „Mitglieder gesamt“ („StatisticInformationID = 5“) geliefert (da dieser Wert immer pro Tag gilt und ein kummulierter Wert keinen Sinn ergibt) !

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

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
CommunityIDNULL ID einer Community
smallint3.5.15
StatisticInformationIDListNULL Es gibt bestimmte statistische Informationen (z.B. die Anzahl Logins) die der „dStore“ pro Community zur Verfügung stellt. Möchte man nur bestimmte Informationen anzeigen lassen, gibt man hier eine Liste der entsprechenden IDs (durch '¶' getrennt) an.
varchar(255)3.5.15
FromDateNULL Startzeitpunkt des Zeitraums, zu dem man sich Statistiken ausgeben lassen möchte
datetime3.5.15
ToDateNULL Endzeitpunkt des Zeitraums, zu dem man sich Statistiken ausgeben lassen möchte
datetime3.5.15
CalculateSum0 Je nach Einstellung gibt es verschiedene Rückgabemengen…
„0“ : Die statistischen Werte sind PRO TAG angegeben
„1“ : Es wird für jede „StatisticInformationID“ EIN Datensatz (nämlich die Summe über den gesamten Zeitraum) ausgegeben
bit3.5.15

Rückgabe

wenn CalculateSum = 0

Spaltenname Beschreibung SQL-Datentyp4) ab Version
CommunityIDID einer Community auf die sich die Statistiken beziehen
smallint3.5.15
CommunityNameName der Community „CommunityID“
varchar(100)3.5.15
StatisticInformationIDID einer statistischen Information
tinyint3.5.15
StatisticInformationBezeichnung der statistischen Information „StatisticInformationID“ (z.B. „Online-Minuten“, „Logins“ etc.)
varchar(100)3.5.15
DescriptionGenauere Beschreibung, was unter der Information „StatisticInformationID“ zu verstehen ist
varchar(255)3.5.15
IsPublicHandelt es sich um eine statistische Information, die dem öffentlichen Benutzer ausgegeben werden darf ? Wird derzeit nicht beachtet !
bit3.5.15
DayTagesdatum, auf das sich der Wert „Value“ bezieht. Es ist für jeden Tag im Zeitraum „FromDate“ bis „ToDate“ ein Datensatz vorhanden !
datetime3.5.15
ValueDer statistische Wert zur „StatisticInformationID“ in der Community „CommunityID“ am Tag „Day“
decimal(12,2)3.5.15

wenn CalculateSum = 1

Spaltenname Beschreibung SQL-Datentyp5) ab Version
CommunityIDID einer Community auf die sich die Statistiken beziehen
smallint3.5.15
CommunityNameName der Community „CommunityID“
varchar(100)3.5.15
StatisticInformationIDID einer statistischen Information
tinyint3.5.15
StatisticInformationBezeichnung der statistischen Information „StatisticInformationID“ (z.B. „Online-Minuten“, „Logins“ etc.)
varchar(100)3.5.15
DescriptionGenauere Beschreibung, was unter der Information „StatisticInformationID“ zu verstehen ist
varchar(255)3.5.15
IsPublicHandelt es sich um eine statistische Information, die dem öffentlichen Benutzer ausgegeben werden darf ? Wird derzeit nicht beachtet !
bit3.5.15
ValueDer statistische Wert zur „StatisticInformationID“ in der Community „CommunityID“ im Zeitraum „FromDate“ bis „ToDate“
decimal(12,2)3.5.15

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 6)
-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
4.0.10 2004-03-151. „_mi_StartProcedure“, „_mi_FinishProcedure“ und „_mi_ChooseParamValueSeperator“
2. „set transaction isolation level 1“, „set rowcount 0“
3. Konsequente Fehlerbehandlung
4. Überarbeitung der Doku
5. Interner Fehler
6. Kl. Performance-Verbesserung
3.5.16 2002-04-25
3.5.15 2002-03-12Erstmalig 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/co_GetCommunityStatistics_Ad'

Mit xmllint 7) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/co_GetCommunityStatistics_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'),
	'co_GetCommunityStatistics_Ad',
		array(
			// 'CommunityID' => NULL,
			// 'StatisticInformationIDList' => NULL,
			// 'FromDate' => NULL,
			// 'ToDate' => NULL,
			// 'CalculateSum' => 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="co_GetCommunityStatistics_Ad">
			<Parameters>
				<!-- <Parameter Name="CommunityID">NULL</Parameter> -->
				<!-- <Parameter Name="StatisticInformationIDList">NULL</Parameter> -->
				<!-- <Parameter Name="FromDate">NULL</Parameter> -->
				<!-- <Parameter Name="ToDate">NULL</Parameter> -->
				<!-- <Parameter Name="CalculateSum">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
6)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
7)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/co_getcommunitystatistics_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)