Prozedur zum Anlegen, Ändern und Löschen von Verkaufs-Aktionen (den sogenannten „Campaigns“).

Es gelten beim Löschen von Aktionen folgende Einschränkungen (können aber durch „ForceDelete“ umgangen werden) :

1. Die zu löschende Aktion darf NICHT aktiv sein, insbesondere darf sie NICHT JETZT GERADE (aufgrund der Gültigkeitszeiträume) aktiv sein.
2. Eine Aktion, die gelöscht werden soll, darf NICHT Ursache eines „Surcharges“ für einen Warenkorb (egal ob für den gesamten Warenkorb oder für eine Position) sein, d.h. „CampaignID“ darf z.B. nicht in der Rückabespalte „SurchargeGeneratedByCampIDs“ eines om_GetTrolley_Pu-Aufrufs vorkommen.
3. Eine Aktion kann nur gelöscht werden, wenn sie NICHT Ursache eines „Surcharges“ für einen Auftrag (egal ob für den gesamten Auftrag oder für eine Position) ist, d.h. „CampaignID“ darf z.B. nicht in der Rückgabespalte „Information“ zur „InformationTypeID = -5“ („SurchargeGeneratedByCampaignIDs“) eines om_GetOrderSurchargeInfo_Ad-Aufrufs vorkommen.

Anmerkungen zum Parameter „Active“ :

Besonderheit ist der „Active“-Status einer Aktion. Der Wert „1“ kann erst gesetzt werden, wenn bestimmte Voraussetzungen erfüllt sind, die hier auch geprüft werden :

• Es muß ein aktuell oder in der Zukunft liegender Gültigkeitszeitraum existieren.
• Es muß mindestens ein „Benefit“ hinterlegt worden sein.
• Es muß mindestens eine Bedingung („CampaignCondition“) konfiguriert sein, es sei denn als Benefit ist ausschließlich ein „Bundle-Preis“ hinterlegt.
• Es darf nicht gleichzeitig eine Warenkorbwert-Bedingung und ein Positions-Rabatt als Benefit („SurchargeBenefit“ mit „ApplyToOption <> 3“) definiert sein, weil der Rabatt nicht greifen würde. Grundhierfür ist die Tatsache, daß bei der Preis-Ermittlung aus Performance-Gründen der Gesamt-Wert der zu berechnenden Artikel nicht zur Verfügung steht (es müßte sonst ja quasi zweimal die Preis-Berechnung durchlaufen werden) und somit Aktionen mit einer „trolley value condition“ nicht beachtet werden.

Daher wird insbesondere bei Neu-Anlage einer Aktion der Parameter „Active“ NIE beachtet, sondern immer so behandelt, als ob der („default“-)Wert „0“ angegeben worden wäre.
Zu Testzwecken gibt es auch den „Active“-Status von „2“, der besagt, daß die Verkaufs-Aktion zwar aktiv ist, aber nur von einem bestimmten Nutzer-Kreis verwendet werden kann - dies ist aber aktuell auch noch nicht implementiert.

Anmerkungen zum Parameter „ForceDelete“ :

1. Um einen Fehler beim Versuch des Löschens einer Verkaufs-Aktion zu vermeiden (also wenn „CampaignID“ NICHT „NULL“ und „DeleteCampaign = 1“ ist) , kann „ForceDelete“ entsprechend belegt werden. Hierbei handelt es sich um die SUMME folgender Werte, die jeweils sozusagen eine der Beschränkungen (hinsichtlich Löschen) aufheben bzw. ignorieren :

• „1“ : Löschen der Aktion erlauben auch wenn sie aktiv ist
• „2“ : Löschen der Aktion erlauben auch wenn sie AKTUELL (aufgrund eines Gültigkeitszeitraums) verwendbar ist
• „4“ : Löschen der Aktion erlauben auch auch wenn sie Ursache eines „Warenkorb-Surcharges“ ist
• „8“ : Löschen der Aktion erlauben auch auch wenn sie Ursache eines „Auftrag-Surcharges“ war

2. Option „2“ macht nur Sinn, wenn auch Option „1“ gewählt ist, sprich „ForceDelete & 2 = 2“ aber „ForceDelete & 1 = 0“ führt zu einem Fehler („-500“). Die Unterscheidung dieser Optionen wird angeboten, damit man NUR Option „1“ („ForceDelete = 1“) wählen kann (um eine Aktion nur zu löschen, wenn sie inaktiv ist oder aber - falls aktiv - wenigstens NICHT AKTUELL gültig).

3. Beispiele :
a) „ForceDelete = 8“
Dann können nur inaktive Verkaufs-Aktionen, die nicht Ursache eines „Warenkorb-Surcharges“ sind, gelöscht werden (selbst wenn sie Ursache eines „Auftrag-Surcharges“ waren).
b) „ForceDelete = 7“
Eine Aktion kann gelöscht werden unabhängig davon, ob sie (aktuell) aktiv ist oder nicht und vielleicht für einen „Warenkorb-Surcharge“ verantwortlich ist. Sobald sie aber Ursache eines „Auftrag-Surcharges“ war, schlägt das Löschen fehl.
c) „ForceDelete = 15“
Jede Aktion kann so gelöscht werden, egal ob aktiv und/oder verwendet.

Die Prozedur hat keine Rückgaben.

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_ModifyCampaigns_Ad im Engine Playground öffnen

Unformatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ModifyCampaigns_Ad?CampaignName=<value>&CampaignDescription=<value>&CampaignTypeID=<value>'

Mit xmllint ²⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ModifyCampaigns_Ad?CampaignName=<value>&CampaignDescription=<value>&CampaignTypeID=<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_ModifyCampaigns_Ad',
		array(
			'CampaignName' => '<value>',
			'CampaignDescription' => '<value>',
			'CampaignTypeID' => <value>,
			// 'Active' => 0,
			// 'DeleteCampaign' => 0,
			// 'ForceDelete' => 0
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();
 
$OutputParams = $xml_result->getOutputParametersAsArray();

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_ModifyCampaigns_Ad">
			<Parameters>
				<Parameter Name="CampaignName"><!-- varchar value --></Parameter>
				<Parameter Name="CampaignDescription"><!-- varchar value --></Parameter>
				<Parameter Name="CampaignTypeID"><!-- tinyint value --></Parameter>
				<!-- <Parameter Name="Active">0</Parameter> -->
				<!-- <Parameter Name="DeleteCampaign">0</Parameter> -->
				<!-- <Parameter Name="ForceDelete">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>