Prozedur, um die Zuordnung von Artikel-Sets zu Verkaufs-Aktions-Benefits des Typs „Bonus-Artikel“ zu verwalten.

Hintergrund :
Der Benefit-Typ „Bonus-Artikel“ für Verkaufs-Aktionen bietet die Möglichkeit, sogenannte Sets von Artikeln definieren zu können, aus denen der Kunde sich ein oder mehrere Artikel aussuchen darf, die er kostenlos erhält - sofern die zur Verkaufs-Aktion definierten Bedingungen erfüllt sind.

Hinweise :

1.) Sofern ein Benefit bereits in einer AKTIVEN Verkaufs-Aktion verwendet wird (s. om_GetCampaignBenefits_Ad), kann die Zuordnung zu Artikel-Sets NICHT mehr geändert werden (ggf. gibt es dann also einen Fehler) !

2.) Bei einer neuen Zuordnung prüfen wir, ob das Set auf einer Artikel-Bedingung („ItemConditionID“) basiert, auf der ein anderes bereits dem Benefit zugewiesenes Set beruht. Wenn dem so ist, gibt es einen Fehler, denn zwei identsiche Sets für ein und dasselbe Bonus-Artikel-Benefit machen keinen Sinn.

3.) Ebenfalls einen Fehler gibt es bei einer Neu-Zuordnung, falls das Set bereits einem anderen Benefit zugeordnet ist. Grund für diese Einschränkung ist die Vereinfachung der Überprüfungslogik für einen Warenkorb.
Hintergrund : Es kann ja der Fall auftreten, daß mehrere Bonus-Artikel im Warenkorb enthalten sind, die jeweils zu mehreren Sets eines einzigen (Bonus-Item-)Benefits gehören können, aber nur eine bestimmte Konstellation tatsächlich erlaubt ist (aufgrund der „MaxQuantity“-Einstellung des Benefits, s. gleichnamiger Rückgabespalte von om_GetCampaignBonusItems_Ad). Um nun ein u.U. sehr zeitaufwendiges Durchprobieren von Kombinationen zu vermeiden, müssen wir also für jeden Bonus-Artikel im Warenkorb wissen, zu welchem Set welches Benefits er gehört. Zwecks Reduzierung der damit eigentlich notwendigen ZWEI Informationen (Set UND Benefit) auf nur noch eine wird die Einschränkung der eindeutigen Zuordnung eines Sets zu einem Benefit gefordert.

Anmerkungen zum Parameter „SortNo“ :

1.) Mit der „SortNo“ steuert man die Reihenfolge der einem Bonus-Artikel-Benefit zugeordneten Sets. Die Werte beginnen bei „1“ und sind lückenlos aufsteigend (je niedriger der Wert desto höher die Priorität). Und weil der Datentyp „tinyint“ ist, können „BenefitID“ somit maximal 255 Sets zugeordnet werden

2.) Bei Neu-Anlage einer Zuordnung beachten wir „SortNo“ NICHT sondern vergeben automatisch den nächst größeren Wert.

3.) Bei einer Änderung (existiert die Zuordnung und ist „DeleteCombination = 0“) MUSS „SortNo“ auf jeden Fall angegeben werden und muß zwischen „1“ und der maximalen „SortNo“ eines zugeordneten Sets liegen. In diesem Fall sorgen wir übrigens automatisch dafür, daß nach der Änderung die „SortNo“s aller Sets garantiert wieder lückenlos aufsteigend (bei „1“ beginnend) sind.

4.) Im Löschen-Fall erniedrigen wir die „SortNo“ anderer Sets mit einem Wert „> SortNo“ um „1“.

Die Prozedur hat keine Rückgaben.

Die Prozedur hat keine Output-Parameter.

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.

Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:

• om_ModifySetsForBonItBenefs_Ad im Engine Playground öffnen

Unformatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ModifySetsForBonItBenefs_Ad?BenefitID=<value>&ItemSetID=<value>'

Mit xmllint ⁵⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ModifySetsForBonItBenefs_Ad?BenefitID=<value>&ItemSetID=<value>' | xmllint --format -

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'),
	'om_ModifySetsForBonItBenefs_Ad',
		array(
			'BenefitID' => <value>,
			'ItemSetID' => <value>,
			// 'SortNo' => NULL,
			// 'DeleteCombination' => 0
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();

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="om_ModifySetsForBonItBenefs_Ad">
			<Parameters>
				<Parameter Name="BenefitID"><!-- integer value --></Parameter>
				<Parameter Name="ItemSetID"><!-- integer value --></Parameter>
				<!-- <Parameter Name="SortNo">NULL</Parameter> -->
				<!-- <Parameter Name="DeleteCombination">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>