Prozedur zur Verwaltung der Definitionen von Gültigkeitszeiträumen von Verkaufs-Aktionen (die sogenannten „Campaigns“).
Pro Verkaufs-Aktion können mehrere Zeitraum-Definitionen hinterlegt werden (um z.B. „Immer Montags und Donnerstags“ abbilden zu können), jedoch maximal 256 (wie man auch am Datentyp „tinyint“ von „PeriodDefinitionID“ sehen kann) !
Allgemeine Erläuterung zu Gültigkeitszeiträumen von Verkaufs-Aktionen und deren Definition(en) :
Für jede Aktion muß definiert sein, in welchen Zeiträumen sie gültig ist. Die Unterscheidung zwischen den Zeiträumen selbst und ihren Definitionen liegt darin begründet, daß man u.U. wiederkehrende Zeiträume definieren möchte wie z.B. „Jeden Montag zwischen 10 und 15 Uhr“.
Man möchte diese wiederkehrenden Zeiträume auf der einen Seite nicht händisch eintragen, auf der anderen Seite benötigen aber
die Prozeduren, die letztlich für die Anwendung der Aktionen sorgen, die genauen Zeiträume, um die absolut beste Performance zu erzielen.
Zur Verwaltung der Definitionen von Gültigkeitszeiträumen gibt es diese Prozedur hier. Wir sorgen u.a. dafür, daß aus den Definitionen die tatsächlichen Zeiträume generiert und gespeichert werden. Diese (tatsächlichen Zeiträume) können wiederum mit om_GetCampaignPeriods_Ad eingesehen werden.
Beispiel „Jeden Montag zwischen 10 und 15 Uhr im Zeitraum 29.03.2010 bis 12.04.2010“ :
Die Definition dazu kann so aussehen, daß der Zeitraum „29.03.2010 10:00“ bis „29.03.2010 15:00“ alle 7 Tage (also wöchentlich) bis zum „12.04.2010 15:00“ wiederholt wird, sprich die (relevanten) Werte in der Rückgabemenge wären :
StartDateAndTime : 29.03.2010 10:00
EndDateAndTime : 29.03.2010 15:00
RepeatEveryXTimeUnits : 7
TimeUnit : Tag
RepeatUntil : 12.04.2010 15:00
Anmerkungen zu den Parametern „StartDateAndTime“, „EndDateAndTime“, „RepeatEveryXTimeUnits“, „TimeUnitID“ und „RepeatUntil“ :
1.) Mindestens angegeben werden muß bei einer Definition ein Start- und End-Zeitpunkt (→ „StartDateAndTime“ und „EndDateAndTime“). Dieser Zeitraum stellt dann immer auch einen der tatsächlich generierten Gültigkeitszeiträume dar. Gibt man „0“ oder „NULL“ für den Parameter „RepeatEveryXTimeUnits“ an, bleibt es auch dabei („TimeUnitID“ und „RepeatUntil“ werden dann ignoriert).
2.) „EndDateAndTime“ muß immer ein Zeitpunkt in der Zukunft sein !
3.) Start- und End-Zeitpunkt sind immer auch selbst Bestandteil des Zeitraums.
4.) Der Zeitraum muß sich über mindestens 5 Minuten erstrecken. Diese Mindest-Dauer ist aber über den „Settings“-Eintrag zum Schlüssel „MinDurationForCampaignPeriodsInMinutes“ änderbar.
5.) Möchte man, daß sich die Zeitraum-Angabe „StartDateAndTime“ bis „EndDateAndTime“ in bestimmten Abständen wiederholt bzw. fortsetzt, müssen die drei Parameter „RepeatEveryXTimeUnits“, „TimeUnitID“ und „RepeatUntil“ entsprechend belegt werden.
Mit den ersten beiden dieser drei legt man fest, wie oft der Zeitraum und in welchem Abstand (derzeit „Tage“ oder „Monate“, s. om_GetTimeUnitsForCPeriods_Ad) wiederholt werden soll.
Diese Wiederholung oder Fortsetzung des ursprünglichen Zeitraums wird aber nur durchgeführt, solange das Ende des fortgesetzten Zeitraums noch VOR „RepeatUntil“ liegt.
ACHTUNG :
Dabei gibt es aber (aus Performance-Gründen) eine Beschränkung : Falls mehr als 1.000 Zeiträume zu generieren wären, brechen wir mit einem entsprechenden Fehler ab. Diese Beschränkung kann man über den „Settings“-Eintrag zum Schlüssel „MaxGenerateableCampaignPeriodsPerPeriodID“ herunter- oder herauf-setzen.
Hinweise :
1.) Beim Generieren der sich aus einer (neuen) Definition ergebenden Zeiträume wird geprüft, ob es zu einer Überschneidung mit bereits bestehenden (aktiven) Zeiträumen gibt - in einem solchen Fall schlägt der Aufruf (und damit das Erstellen der Definition) natürlich fehl !
2.) Insbesondere dürfen sich die wiederkehrenden Zeiträume einer Definition nicht überschneiden, d.h. der Abstand zwischen „StartDateAndTime“ und „EndDateAndTime“ muß kleiner sein als der Zeitraum, den man durch Multikplikation von „RepeatEveryXTimeUnits“ mit der durch „TimeUnitID“ angegebene Einheit erhält !
Beispielsweise gibt es daher einen Fehler, wenn sich der durch „StartDateAndTime“ und „EndDateAndTime“ angegebene Zeitraum über mehr als 24 Stunden erstreckt, und „RepeatEveryXTimeUnits = 1“ und „TimeUnitID = 1“ (für „Tag“) angegeben wurde !
HTTP-Method | POST |
HTTP-Auth | Optional |
Alias | om_ModifyCampaignPeriodDefinitions_Ad |
Tags | |
Engine-Kategorie | order management |
Engine-Typ | Daten-Änderung |
Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
---|---|---|---|---|
CampaignID | ID einer Verkaufs-Aktion, zu der eine neue Definition von Gültigkeitszeiträumen angelegt oder eine bestehende Definition geändert oder gelöscht werden soll | integer | 6.0.0 | |
PeriodDefinitionID | ID einer für die Verkaufs-Aktion „CampaignID“ geltenden Gültigkeitszeitraum-Definition. Falls diese noch nicht existiert, wird eine neue Definition angelegt, sonst entscheidet „DeletePeriodDefinition“ darüber, ob die bestehende geändert/gelöscht wird. | tinyint | 6.0.0 | |
PeriodDefinitionName | NULL | Bezeichnung der Gültigkeitszeitraum-Definition (wie z.B. „1. Weihnachtstag“ oder „Jeder 1. im Monat (in 2009)“ oder „Alle 14 Tage“ etc.) | varchar(100) | 6.0.0 |
StartDateAndTime | Startzeitpunkt des Gültigkeitszeitraums und damit gleichzeitig Startzeitpunkt des ersten aus dieser Definition (generierten) tatsächlichen Zeitraums (der u.U. eben mehrfach gemäß „RepeatEveryXTimeUnits“ bis zum Zeitpunkt „RepeatUntil“ wiederholt wird) | datetime | 6.0.0 | |
EndDateAndTime | Endzeitpunkt des Gültigkeitszeitraums und damit gleichzeitig Endzeitpunkt des ersten aus dieser Definition (generierten) tatsächlichen Zeitraums (der u.U. eben mehrfach gemäß „RepeatEveryXTimeUnits“ bis zum Zeitpunkt „RepeatUntil“ wiederholt wird) | datetime | 6.0.0 | |
RepeatEveryXTimeUnits | 0 | Wert „> 0“ bedeutet, daß der Zeitraum „StartDateAndTime“ bis „EndDateAndTime“ nach dieser Anzahl durch „TimeUnitID“ bestimmten Zeiteinheit (z.B. „Tag“) wiederholt wird und dieses „Wiederholungs-Prinzip“ bis zum Zeitpunkt „RepeatUntil“ fortgeführt wird | tinyint | 6.0.0 |
TimeUnitID | NULL | Wird nur beachtet, wenn „RepeatEveryXTimeUnits > 0“ ist ! ID einer Zeiteinheit, die für „RepeatEveryXTimeUnits“ gilt. Mögliche Werte : s. om_GetTimeUnitsForCPeriods_Ad. | tinyint | 6.0.0 |
RepeatUntil | NULL | Wird nur beachtet, wenn „RepeatEveryXTimeUnits > 0“ ist ! Zeitpunkt, bis zu dem der Zeitraum „StartDateAndTime“ bis „EndDateAndTime“ immer wieder nach „RepeatEveryXTimeUnits“ vielen „TimeUnitID“ entsprechenden Zeiteinheiten wiederholt wird. | datetime | 6.0.0 |
DeletePeriodDefinition | 0 | Wird nur beachtet, wenn es die „CampaignID“-„PeriodDefinitionID“-Kombination schon gibt. „0“ : Definition bearbeiten - nur der Name ist änderbar ! „1“ : Definition löschen - Aktion darf NICHT aktiv sein (s. om_GetCampaigns_Ad, Spalte „Active“) ! | bit | 6.0.0 |
Die Prozedur hat keine Rückgaben.
Die Prozedur hat keine Output-Parameter.
Code | Beschreibung | Quelle 4) |
---|---|---|
-1312 | Die maximale Anzahl zu generierender Zeiträume ist überschritten | nur direkt |
-1311 | Die Definition ist ungültig, da es zur Überschneidung von Zeiträumen kommen würde | nur direkt |
-1310 | Die Definition kann nicht gelöscht werden, da es einen aktiven Gültigkeitszeitraum gibt | nur direkt |
-621 | Fehlender oder falscher Eintrag in PersonTypeSettings | 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 | direkt und indirekt |
-502 | Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen) | nur indirekt |
-500 | Falsche Parameter | direkt und indirekt |
Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.
7.0.7 | 2015-01-29 | Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf] |
6.5.4 | 2013-04-29 | Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung |
6.5.0 | 2012-09-17 | Holger Wies : Bugfix - Im Falle von wiederholten „CampaignPeriods“, wurde das Startdatum der letzten „CampaignPeriod“ als Startdatum der „CampaignPeriodsDefinition“ gespeichert |
6.0.0 | 2010-03-26 | Erstmalig in dieser Version erstellt |
Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:
Unformatierte Ausgabe:
curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/om_ModifyCampaignPeriodDefs_Ad?CampaignID=<value>&PeriodDefinitionID=<value>&StartDateAndTime=<value>&EndDateAndTime=<value>'
Mit xmllint 5) formatierte Ausgabe:
curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/om_ModifyCampaignPeriodDefs_Ad?CampaignID=<value>&PeriodDefinitionID=<value>&StartDateAndTime=<value>&EndDateAndTime=<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_ModifyCampaignPeriodDefs_Ad', array( 'CampaignID' => <value>, 'PeriodDefinitionID' => <value>, 'StartDateAndTime' => <value>, 'EndDateAndTime' => <value>, // 'PeriodDefinitionName' => NULL, // 'RepeatEveryXTimeUnits' => 0, // 'TimeUnitID' => NULL, // 'RepeatUntil' => NULL, // 'DeletePeriodDefinition' => 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_ModifyCampaignPeriodDefs_Ad"> <Parameters> <Parameter Name="CampaignID"><!-- integer value --></Parameter> <Parameter Name="PeriodDefinitionID"><!-- tinyint value --></Parameter> <Parameter Name="StartDateAndTime"><!-- datetime value --></Parameter> <Parameter Name="EndDateAndTime"><!-- datetime value --></Parameter> <!-- <Parameter Name="PeriodDefinitionName">NULL</Parameter> --> <!-- <Parameter Name="RepeatEveryXTimeUnits">0</Parameter> --> <!-- <Parameter Name="TimeUnitID">NULL</Parameter> --> <!-- <Parameter Name="RepeatUntil">NULL</Parameter> --> <!-- <Parameter Name="DeletePeriodDefinition">0</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>