co_GetCurrentlyUsersOnline_Pu [dstore]

Inhaltsverzeichnis

co_GetCurrentlyUsersOnline_Pu

co_GetCurrentlyUsersOnline_Pu

Gibt alle Community-Mitglieder aus, die gerade online sind.

Anmerkung zu den „OutputCharacteristicID…“-Parametern :

IDs, die hier übergeben werden und nicht für den Benutzer, der diese Prozedur aufruft, „sichtbar“ sind (aufgrund von Zugriffsbeschränkungen, s. pm_GetPChAccRestrForUsers_Ad), werden grundsätzlich ignoriert ! D.h. es gibt zwar keinen Fehler, aber die entsprechende(n) Eigenschaft(en) werden natürlich nicht zurückgegeben !

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[co, Get, Currently, Users, Online, Pu]
Engine-Kategorie	communities
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	6.5.4 (2013-04-29)

Parameter

UniqueID		Eindeutige ID eines Besuchers, die dem zu identifizierenden Mitglied aktuell zugeordnet ist. Falls die Identifizierungsdaten zur Person in „SessionManagement“ (zu dieser „UniqueID“) gespeichert sind, darf „PersonIdentificationValues“ auch „NULL“ sein.	varchar(50)	3.5.0
PersonIdentificationValues		Liste von Werten, die das Mitglied identifizieren. Diese Werte müssen Eigenschaften zu den Merkmal-IDs sein, die in „PersonTypeSettings“ zur „PersonTypeID“ der „CommunityID“ zum Schlüssel „PersonIdentificationIDs“ hinterlegt sind.	varchar(255)	3.5.0
CommunityID		ID einer Community	smallint	3.5.0
OnlineTimeDuringLastXMinutes	NULL	Einen Wert größer „0“ angeben, um in der Rückgabemenge („OnlineTimeInSeconds“) einen Wert zu erhalten, der die Online-Zeit des identifizierten Mitglieds in den letzten „OnlineTimeDuringLastXMinutes“ Minuten angibt.	integer	3.5.4
OutputCharacteristicID1	NULL	ID eines Merkmals. Falls angegeben, enthält die Rückgabemenge in der Spalte „Value1“ die Eigenschaft des jeweiligen Mitglieds zu diesem Merkmal. Das Merkmal muß aber durch den „Settings“-Eintrag zum Schlüssel „PublicCharacteristicIDs“ freigegeben sein !	smallint	3.5.0
OutputCharacteristicID2	NULL	ID eines Merkmals. Falls angegeben, enthält die Rückgabemenge in der Spalte „Value3“ die Eigenschaft des jeweiligen Mitglieds zu diesem Merkmal. Das Merkmal muß aber durch den „Settings“-Eintrag zum Schlüssel „PublicCharacteristicIDs“ freigegeben sein !	smallint	3.5.0
OutputCharacteristicID3	NULL	ID eines Merkmals. Falls angegeben, enthält die Rückgabemenge in der Spalte „Value3“ die Eigenschaft des jeweiligen Mitglieds zu diesem Merkmal. Das Merkmal muß aber durch den „Settings“-Eintrag zum Schlüssel „PublicCharacteristicIDs“ freigegeben sein !	smallint	3.5.0
CommunityBinaryCategoryID	NULL	Falls angegeben, enthält die Spalte „BinaryID“ der Rückgabemenge die kleinste „BinaryID“, die dem jeweiligen Mitglied in dieser Kategorie zugeordnet ist	smallint	3.5.4
FilterByOnlineStatus	NULL	Falls angegeben, werden nur die „Online-Mitglieder“ ermittelt, die sich in diesem Status befinden	tinyint	5.0.0
OutputIntoOneID	0	Möchte man an Stelle einer Ergebnismenge die „CommunityMemberID“s in „tempdb.dbo.OneID“ speichern lassen, übergibt man hier „1“. „OnlineTimeDuringLastXMinutes“, „OutputCharacteristicID…“ und „CommunityBinaryCategoryID“ werden dann ignoriert !	bit	5.0.0
SeparatorInIdentVals	'¶'	Gibt an, durch welche Zeichenkette die Werte in „PersonIdentificationValues“ getrennt sind	varchar(4)	5.5.0

Rückgabe

wenn OutputIntoOneID = 0

Spaltenname	Beschreibung	SQL-Datentyp¹⁾	ab Version
LastRefresh²⁾	Wird seit Version 3.5.4 nicht mehr zurückgegeben ! (Gab an, wann das Mitglied zuletzt eine Rückmeldung gegeben hat. Dies dient dazu, um Mitglieder automatisch ausloggen zu können, wenn seit „LastRefresh“ nämlich eine bestimmte Zeit vergangen ist)	datetime	3.5.0
LoggedIn³⁾	Wird seit Version 3.5.4 nicht mehr zurückgegeben ! (Enthielt das Datum des letzten Login)	datetime	3.5.0
CommunityID⁴⁾	Wird seit Version 3.5.4 nicht mehr zurückgegeben, da diese ID ja über „CommunityID“ übergeben wurde !	smallint	3.5.0
lower(Nickname)⁵⁾	Wird nicht zurückgegeben, sondern zur Sortierung benötigt; enthält den „Nickname“ komplett „lowercase“ (Kleinbuchstaben)	varchar(100)	3.5.4
Status⁶⁾	Wurde zwischen Version 3.5.4 und 3.5.11 nicht mehr zurückgegeben. Seit der Version 3.5.11 heißt die Rückgabespalte „OnlineStatus“.	tinyint	3.5.0
CommunityMemberID	ID eines Mitglieds der Community „CommunityID“, das gerade online ist	integer	3.5.0
Nickname	Der sogenannte „Nickname“ ist eine Eigenschaft, anhand der die Mitglieder der Community eindeutig identifiziert werden. Die ID des zugehörigen Merkmals ist in„CommunitySettings“ zum Schlüssel „IdentifyingCharacteristicID“ hinterlegt.	varchar(100)	3.5.0
OnlineTimeInSeconds	Gibt die Online-Zeit des Mitglieds „CommunityMemberID“ in den letzten „OnlineTimeDuringLastXMinutes“ Minuten an	integer	3.5.4
Value1	Eigenschaft des Mitglieds „CommunityMemberID“ zum Merkmal „OutputCharacteristicID1“	varchar(100)	3.5.0
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 des Mitglieds „CommunityMemberID“ zum Merkmal „OutputCharacteristicID2“	varchar(100)	3.5.0
Value2RestrictedByPattern	Wie „Value1RestrictedByPattern“ - nur eben auf „Value2“ bezogen	varchar(100)	6.5.4
Value3	Eigenschaft des Mitglieds „CommunityMemberID“ zum Merkmal „OutputCharacteristicID3“	varchar(100)	3.5.0
Value3RestrictedByPattern	Was enthält „Value3“ (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, „Value3“ ist dann NULL	varchar(100)	6.5.4
BinaryID	Falls „CommunityBinaryCategoryID“ angegeben wurde, steht hier die kleinste „BinaryID“, die dem Mitglied „CommunityMemberID“ in der Kategorie „CommunityBinaryCategoryID“ zugeordnet ist	integer	3.5.4
OnlineStatus	Dieser Wert gibt an, wo ein Mitglied sich gerade in der Community aufhält. Es sind nur der Status „0“ [gerade angemeldet] und „255“ [Community verlassen] vom „dStore“ vorgegeben.	tinyint	3.5.11

Sortierung der Rückgabe

(parameterunabängige Sortierung)

lower(Nickname) (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁷⁾
-781	Fehlender oder falscher Eintrag in CommunitySettings	nur indirekt
-780	Fehlender oder falscher Eintrag in CommunityMemberSettings	nur indirekt
-774	Login vorübergehend gesperrt	nur indirekt
-773	Login gesperrt	nur indirekt
-772	User ist nicht angemeldet	nur indirekt
-771	Der Sweeper ist nicht gestartet	nur indirekt
-770	Login zur Zeit nicht möglich	nur indirekt
-750	Fehlende Berechtigung für die Anzeige der Daten	nur direkt
-660	Identifikation fehlgeschlagen	nur indirekt
-621	Fehlender oder falscher Eintrag in PersonTypeSettings	nur indirekt
-602	Zur defaultUniqueID („VisitorID = -2“) können keinerlei Daten gespeichert oder verändert werden	nur indirekt
-599	Lizenz ist ungültig oder abgelaufen	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
-550	Fehlender oder falscher Eintrag in Settings	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

6.5.4	2013-04-29	1. Implementierung des neuen Merkmal-Zugriffsbeschränkungen-Features [⇒ auch Hinweis in der Doku] 2. Länge des Parameter „SeparatorInIdentVals“ wurde erweitert [von „1“ auf „4“] 3. Neue Rückgabespalten „Value…RestrictedByPattern“
5.5.0	2008-01-07	1. Neuer Parameter „SeparatorInIdentVals“ 2. Bearbeitung des Quellcodes hinsichtlich neuer Konventionen
5.0.0	2004-12-21	1. Neue Parameter „FilterByOnlineStatus“ und „OutputIntoOneID“ 2. Konsequente Fehlerbehandlung 3. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur
3.5.11	2001-09-06
3.5.10	2001-07-14
3.5.4	2001-03-11
3.5.2	2001-01-28
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:

co_GetCurrentlyUsersOnline_Pu im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/co_GetCurrentlyUsersOnline_Pu?UniqueID=<value>&PersonIdentificationValues=<value>&CommunityID=<value>'

Mit xmllint ⁸⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/co_GetCurrentlyUsersOnline_Pu?UniqueID=<value>&PersonIdentificationValues=<value>&CommunityID=<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'),
	'co_GetCurrentlyUsersOnline_Pu',
		array(
			'UniqueID' => '<value>',
			'PersonIdentificationValues' => '<value>',
			'CommunityID' => <value>,
			// 'OnlineTimeDuringLastXMinutes' => NULL,
			// 'OutputCharacteristicID1' => NULL,
			// 'OutputCharacteristicID2' => NULL,
			// 'OutputCharacteristicID3' => NULL,
			// 'CommunityBinaryCategoryID' => NULL,
			// 'FilterByOnlineStatus' => NULL,
			// 'OutputIntoOneID' => 0,
			// 'SeparatorInIdentVals' => '¶'
		)
);
 
$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_GetCurrentlyUsersOnline_Pu">
			<Parameters>
				<Parameter Name="UniqueID"><!-- varchar value --></Parameter>
				<Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter>
				<Parameter Name="CommunityID"><!-- smallint value --></Parameter>
				<!-- <Parameter Name="OnlineTimeDuringLastXMinutes">NULL</Parameter> -->
				<!-- <Parameter Name="OutputCharacteristicID1">NULL</Parameter> -->
				<!-- <Parameter Name="OutputCharacteristicID2">NULL</Parameter> -->
				<!-- <Parameter Name="OutputCharacteristicID3">NULL</Parameter> -->
				<!-- <Parameter Name="CommunityBinaryCategoryID">NULL</Parameter> -->
				<!-- <Parameter Name="FilterByOnlineStatus">NULL</Parameter> -->
				<!-- <Parameter Name="OutputIntoOneID">0</Parameter> -->
				<!-- <Parameter Name="SeparatorInIdentVals">'¶'</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

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