Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:co_deleteinactivemembers_ad

co_DeleteInactiveMembers_Ad

Ermittelt oder löscht alle Mitglieder einer Community, deren letztes Login länger als eine bestimmte Anzahl von Monaten her ist.

Theoretisch kann es passieren, daß Daten aus „OnlineTimeStatistics“ (hier werden pro Mitglied pro Tag die Online-Minuten und die Anzahl Logins gespeichert) zu einem Mitglied gelöscht werden, so daß nicht mehr festgestellt werden kann, wann es sich das letzte Mal eingeloggt hat. Um (nur !) diese betroffenen Personen ausgeben bzw löschen zu lassen, setzt man „OnlyMembersWithoutLoginStats“ auf „1“.

Anmerkung zur Rückgabespalte „Nickname“ :

Eine evtl. konfigurierte Zugriffsbeschränkung für das „Nickname“-Merkmal (s. pm_GetPChAccRestrForUsers_Ad) wird bewußt NICHT beachtet (da das ja DIE öffentlich sichtbare Eigenschaft in einer Community schlechthin ist) !

HTTP-MethodPOST
HTTP-AuthOptional
Tags
Engine-Kategoriecommunities
Engine-TypDaten-Änderung
Letzte Aktualisierung7.0.7 (2015-01-29)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
CommunityID ID einer Community
smallint3.5.8
LastLoginXMonthAgo3 Angabe, wieviele Monate das letzte Login her sein muß, damit das Mitglied als „inaktiv“ gilt. (Muß „>= 0“ sein, sonst gibt es einen Fehler)
smallint3.5.8
DoNotDeleteButLogOnly1 Sollen die inaktiven Mitglieder tatsächlich gelöscht oder nur ermittelt und als Ergebnismenge zurückgegeben werden ?
bit3.5.8
OnlyMembersWithoutLoginStats0 NUR die Mitglieder berücksichtigen, zu denen es keine „OnlineTime“-Statistiken (mehr) gibt, d.h. Datensätze in „UsersOnlineTime“ und „OnlineTimeStatistics“
bit3.5.11
MaxNumberOfMembersToDelete100 Um zu verhindern, daß zu viele Mitglieder aufeinmal gelöscht werden, kann man diesen Parameter entsprechend setzen. „0“ bedeutet KEINE Einschränkung, ist der Wert „< 0“, gibt es einen Fehler !
smallint3.5.11
PrintErrors0 Beim Löschen kann es u.U. einen Fehler geben - etwa weil ein Auftrag existiert o.ä. Die Prozedur wird aber in jedem Fall weiter ausgeführt. Möchte man diese Fehler (bzw. den „ErrorCode“) sehen, übergibt man hier den Wert „1“.
bit3.5.11
AdditionalInformation0 Wird nur im Fall „DoNotDeleteButLogOnly = 1“ beachtet ! Übergibt man hier „1“, sind zusätzliche Informationen in der Rückgabemenge enthalten.
bit3.5.11

Rückgabe

wenn AdditionalInformation = 0 und DoNotDeleteButLogOnly = 1

Spaltenname Beschreibung SQL-Datentyp4) ab Version
lower(Nickname)5)Wird nicht zurückgegeben, sondern zur Sortierung benötigt; enthält den „Nickname“ komplett „lowercase“ (Kleinbuchstaben)
varchar(100)3.5.8
CommunityMemberIDID eines Mitglieds der Community „CommunityID“, das länger als „LastLoginXMonthAgo“ Monate nicht mehr eingeloggt war bzw. zu dem keine „OnlineTime“-Statistiken mehr vorhanden sind.
integer3.5.8
LastLoginWann war das Mitglied „CommunityMemberID“ zuletzt online
datetime3.5.8
NicknameEigenschaft zu dem Merkmal, anhand dessen die Communitymitglieder sich untereinander unterscheiden bzw. erkennen können. (Eintrag in „CommunitySettings“ zum Schlüssel „IdentifyingCharacteristicID“)
varchar(100)3.5.8
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • lower(Nickname) (aufsteigend)

wenn AdditionalInformation = 1 und DoNotDeleteButLogOnly = 1

Spaltenname Beschreibung SQL-Datentyp6) ab Version
lower(Nickname)7)Wird nicht zurückgegeben, sondern zur Sortierung benötigt; enthält den „Nickname“ komplett „lowercase“ (Kleinbuchstaben)
varchar(100)3.5.8
CommunityMemberIDID eines Mitglieds der Community „CommunityID“, das länger als „LastLoginXMonthAgo“ Monate nicht mehr eingeloggt war bzw. zu dem keine „OnlineTime“-Statistiken mehr vorhanden sind.
integer3.5.8
LastLoginWann war das Mitglied „CommunityMemberID“ zuletzt online
datetime3.5.8
NicknameEigenschaft zu dem Merkmal, anhand dessen die Communitymitglieder sich untereinander unterscheiden bzw. erkennen können. (Eintrag in „CommunitySettings“ zum Schlüssel „IdentifyingCharacteristicID“)
varchar(100)3.5.8
CreationDateAndTimeWann wurde die Person (das Mitglied) angelegt (nicht, wann wurde die Person Mitglied in der Community „CommuntiyID“ !)
datetime3.5.11
NumberOfPostingsAnzahl aller NICHT-GELÖSCHTEN Beiträge des Mitglieds
integer3.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 8)
-856Fehlerhafte Daten in „MainPostingSorting“nur indirekt
-855Fehlerhafte Konfiguration des Sortier-Kriteriumsnur indirekt
-850Sortier-Kriterium nicht definiert oder inaktiv oder nicht verwendbarnur indirekt
-840Posting kann nicht bearbeitet werden, weil es bereits von einem anderen Prozess bearbeitet wirdnur indirekt
-781Fehlender oder falscher Eintrag in CommunitySettingsnur indirekt
-677Die Person kann nicht gelöscht werden, da es mind. ein Posting gibt, das nicht gelöscht werden darfnur indirekt
-672Fehlende Berechtigung zum Löschen von Personen eines bestimmten Personentypsnur indirekt
-671Die Person kann nicht gelöscht werden, da mindestens ein Auftrag existiertnur indirekt
-621Fehlender oder falscher Eintrag in PersonTypeSettingsnur indirekt
-610Fehlende oder falsche Daten in PersonMetaInformationnur indirekt
-599Lizenz ist ungültig oder abgelaufennur indirekt
-572Die Prozedur darf nur innerhalb einer Transaktion ausgeführt werdennur indirekt
-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
-565Die „Objekt-ID“ der Prozedur konnte nicht ermittelt werdennur indirekt
-564Der Status in BatchJobs konnte nicht gesetzt werdennur indirekt
-562Die Prozedur ist nicht in BatchJobs registriertnur indirekt
-561Prozedur kann nicht ausgeführt werdennur indirekt
-560Prozedur konnte nicht gestartet werdennur indirekt
-550Fehlender oder falscher Eintrag in Settingsnur 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
-500Falsche Parameterdirekt und indirekt
-220Es konnte keine Merkmal-ID für die Produktbezeichnung ermittelt werdennur 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-29Hinweis in der Doku, daß bewusst NICHT eine evtl. konfigurierte Zugriffsbeschränkung für das „Nickname“-Merkmal
beachtet wird - da das ja DIE öffentlich sichtbare Eigenschaft in einer Community schlechthin ist
6.5.2 2013-02-261. Anpassungen zwecks UTF8-Unterstützung
2. Quellcode an den aktuellen Standard angepaßt
5.0.0 2004-12-21Interne Änderung bzgl. des cursors, der die zu löschenden Mitglieder durchläuft : wir verwenden ab jetzt eine temporäre Tabelle
4.0.10 2004-03-151. Aufruf der Prozeduren „_mi_StartProcedure“ und „_mi_FinishProcedure“
2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur
4.0.7 2004-01-161. „_mi_TryToStartBatchJob“ hat zahlreiche neue Parameter bekommen, um u.a. die Parameter-Werte automatisch in „BatchJobParameters“ eingefügen zu lassen
2. Verwendung der neuen Prozedur „_mi_TryToFinishBatchJob“ zum Setzen des Status am Schluß
4.0.3 2003-07-10„CreationDateAndTime“ steht jetzt in „PersonMetaInformation“ und nicht mehr in „Persons“
3.5.20 2002-07-22
3.5.11 2001-09-06
3.5.8 2001-05-19Erstmalig 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 POST  'http://<partner>-<project>.dstore.de/default/engine/co_DeleteInactiveMembers_Ad?CommunityID=<value>'

Mit xmllint 9) formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/co_DeleteInactiveMembers_Ad?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_DeleteInactiveMembers_Ad',
		array(
			'CommunityID' => <value>,
			// 'LastLoginXMonthAgo' => 3,
			// 'DoNotDeleteButLogOnly' => 1,
			// 'OnlyMembersWithoutLoginStats' => 0,
			// 'MaxNumberOfMembersToDelete' => 100,
			// 'PrintErrors' => 0,
			// 'AdditionalInformation' => 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_DeleteInactiveMembers_Ad">
			<Parameters>
				<Parameter Name="CommunityID"><!-- smallint value --></Parameter>
				<!-- <Parameter Name="LastLoginXMonthAgo">3</Parameter> -->
				<!-- <Parameter Name="DoNotDeleteButLogOnly">1</Parameter> -->
				<!-- <Parameter Name="OnlyMembersWithoutLoginStats">0</Parameter> -->
				<!-- <Parameter Name="MaxNumberOfMembersToDelete">100</Parameter> -->
				<!-- <Parameter Name="PrintErrors">0</Parameter> -->
				<!-- <Parameter Name="AdditionalInformation">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5) , 7)
Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.
8)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
9)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/co_deleteinactivemembers_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)