Inhaltsverzeichnis

pm_DeleteAllPersonsOfPType_Ad

Löscht alle Personen eines des Typs.

Hinweis :

Es ist NICHT möglich, das Löschen aller Personen eines Typs in einer Transaktion durchzuführen, d.h. es kann passieren, daß bei Auftreten eines Fehlers bereits ein Teil der Personen gelöscht wurde, aber eben nicht alle ! Führt ein solcher Fehler nicht zu einem Abbruch der Ausführung, fahren wir in jedem Fall fort, machen aber durch eine „print“-Ausgabe darauf aufmerksam.

Bestimmte Fehler haben mit der Tatsache zu tun, daß wir intern pm_DeletePerson_Ad verwenden (wir gehen in einer Schleife alle Personen des angegeben Typs durch und führen dann pro „PersonID“ die besagte Prozedur aus), die das Löschen einer Person unter bestimmten Umständen verhindert.
⇒ Insbesondere sollte daher die Dokumentation von pm_DeletePerson_Ad beachtet werden !

HTTP-MethodPOST
HTTP-AuthOptional
Aliaspm_DeleteAllPersonsOfPersonType_Ad
Tags
, , , , , , ,
Engine-Kategorieperson management
Engine-TypDaten-Änderung
Letzte Aktualisierung7.0.7 (2015-01-29)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
PersonTypeID ID eines Personen-Typs, zu dem alle existierenden Personen gelöscht werden sollen. Nicht erlaubt sind jedoch die spezielle „PersonTypeID = 0“ und die ID, die in „Settings“ zum Schlüssel „PersonTypeID_dStoreUser“ konfiguriert ist !
tinyint6.0.0
ForceDelete0 SUMME dieser Werte : Eine Person des Typs „PersonTypeID“ soll gelöscht werden, auch wenn sie…
* „1“ : Auftraggeber eines Auftrags ist
* „2“ : Lieferanschrift eines Auftrags ist
* „4“ : Autor eines Forum-Beitrags ist, der nicht gelöscht werden darf
tinyint6.0.0
DelayAfterXPersons50 Nachdem die hier angegebenen Anzahl („> 0“ !) an Personen verarbeitet wurde (egal ob gelöscht werden konnte oder nicht), warten wir die durch „DelayTimeInSeconds“ angegebene Anzahl Sekunden, da das Löschen von Personen-Daten i.d.R. „I/O“-intensiv ist
smallint6.0.0
DelayTimeInSeconds10 Anzahl Sekunden, die wir bis zur Fortführung des Löschvorgangs warten (da das Löschen von Personen-Daten i.d.R. „I/O“-intensiv ist), nachdem die durch „DelayAfterXPersons“ angegebene Anzahl an Personen verarbeitet wurde
tinyint6.0.0

Rückgabe

Die Prozedur hat keine Rückgaben.

Output-Parameter

NumberOfDeletedPersonsAusgabeparameter, dem entnommen werden kann, wieviele Personen tatsächlich gelöscht wurden
NumberOfNotDeletedPersonsAusgabeparameter, dem entnommen werden kann, wieviele Personen NICHT gelöscht werden konnten. Anmerkung : via „print“ wurden entsprechende Meldungen, die über die Gründe Aufschluß geben, erzeugt.

Mögliche Return-Codes

Code Beschreibung Quelle 4)
-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
-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
-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
-561Prozedur kann nicht ausgeführt 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.0.0 2010-03-26Erstmalig 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/pm_DeleteAllPersonsOfPType_Ad?PersonTypeID=<value>'

Mit xmllint 5) formatierte Ausgabe: 

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/pm_DeleteAllPersonsOfPType_Ad?PersonTypeID=<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'),
	'pm_DeleteAllPersonsOfPType_Ad',
		array(
			'PersonTypeID' => <value>,
			// 'ForceDelete' => 0,
			// 'DelayAfterXPersons' => 50,
			// 'DelayTimeInSeconds' => 10
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();
 
$OutputParams = $xml_result->getOutputParametersAsArray();
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="pm_DeleteAllPersonsOfPType_Ad">
			<Parameters>
				<Parameter Name="PersonTypeID"><!-- tinyint value --></Parameter>
				<!-- <Parameter Name="ForceDelete">0</Parameter> -->
				<!-- <Parameter Name="DelayAfterXPersons">50</Parameter> -->
				<!-- <Parameter Name="DelayTimeInSeconds">10</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
2)
siehe Parameter-Konventionen engine/<Prozedur-Name>
3)
siehe Datentypen im Bereich "engine"
4)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
5)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org