Prozedur zur Verwaltung der Arbeitsschritte eines „TRI-Trigger“.
„TRI-Trigger“ sind Objekte, die innerhalb der Engine bei bestimmten Datenänderungen ausgelöst werden (z.B. dem Status-Wechsel von Auftragspositionen). Die Definition eines solchen Triggers besteht aus Arbeitsschritten, zu denen optional eine Bedingung hinterlegt sein kann und zu denen immer eine bestimmte Reihe von Anweisungen (derzeit Prozedur-Aufrufen) konfiguriert ist.
Ein Arbeitsschritt darf optional einen „Iterator“ enthalten (→ „IterationList“). Dabei handelt es sich um einen sogenannten „TRI-Ausdruck“, d.h. eine Zeichenkette, die „Platzhalter-
Funktionen“ enthalten darf - s. mi_GetTRITriggerReplFuncts_Ad. Nach Auswertung muß eine Liste von Werten entstehen, die durch „;;;“ getrennt sind - wohlgemerkt NACH der Auswertung, d.h. in der Iterator-Definition (→ „IterationList“) selbst muß nicht zwangsläufig „;;;“ vorkommen !
Beispiel für einen Iterator in einem „ChangeOrderStateTrigger“ (wenn also „TriggerTypeID = 2“ für „TriggerID“ gilt) :
'#affectedids(trigger)##columnvalue(OrderContent,OrderContentID,OrderID)##distinct()#'
Damit ergibt sich eine Iteration über alle VERSCHIEDENEN Aufträge („OrderIDs“), zu denen die vom Status-Wechsel betroffenen Auftragspositionen gehören. D.h. man kann die Positionen „Auftragsweise behandeln“, wenn man denn außerdem eine Bedingung zum Arbeitsschritt formuliert, die nur die Positionen beachtet, deren zugehörige „OrderID“ dem aktuellen Iterator-Wert entspricht (s. mi_ModifyTRITriggerConds_Ad).
Anmerkungen zum Parameter „CancelOnError“ :
Bei der Abarbeitung eines „TRI-Trigger“ wird natürlich nach jeder Anweisung geprüft, ob es einen Fehler gab. Mit „CancelOnError“ kann man nun konfigurieren, was passieren soll, wenn bei dem Arbeitsschritt (egal in welcher Anweisung) ein Fehler auftritt :
Hinweise :
1. Sofern der Trigger schon zugewiesen ist (s. Rückgabespalte „TriggerStatus“ von mi_GetTrigger_Ad), kann NICHTS mehr geändert werden !
2. Falls für den Trigger bereits eine Prozedur, die bei Auslösung ausgeführt werden soll, konfiguriert ist (s. Rückgabespalte „ExecuteProcedureName“ von mi_GetTRITrigger_Ad), können keine Arbeitsschritte definiert werden.
3. Egal, WAS durch diesen Aufruf geändert wird (neuer Arbeitsschritt oder bestehenden ändern/löschen), wir gehen sicherheitshalber davon aus, daß der Trigger dadurch erstmal unbrauchbar wird, weswegen er als fehlerhaft gekennzeichnet wird (s. Rückgabespalte „TriggerStatus“ von mi_GetTrigger_Ad). Um den Trigger (wieder) verwendbar zu machen, muß mi_ValidateTRITrigger_Ad aufgerufen werden !
HTTP-Method | POST |
HTTP-Auth | Optional |
Tags | |
Engine-Kategorie | system administration |
Engine-Typ | Daten-Änderung |
Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
---|---|---|---|---|
TriggerID | ID eines „TRI-Trigger“, zu dem ein Arbeitsschritt verwaltet werden soll | smallint | 7.0.3 | |
IterationList | NULL | Optionaler Iterator (ein „TRI-Ausdruck“) für den Arbeitsschritt, d.h. die definierten Anweisungen werden sooft ausgeführt wie iteriert wird - s.a. Beschreibung ! | varchar(1000) | 7.0.3 |
WorkStep | NULL | Optionale Kurz-Beschreibung/-Bezeichnung des Arbeitsschrittes - es sind aber nur Buchstaben A-Z (Groß- und Kleinschreibung ist egal), Zahlen sowie „Untersriche“ („_“) erlaubt | varchar(100) | 7.0.3 |
Description | NULL | Optionale Beschreibung/Dokumentation des Arbeitsschrittes | varchar(1000) | 7.0.3 |
CancelOnError | 1 | Gibt an, was im Falle eines Fehlers innerhalb des Arbeitsschrittes passieren soll (s. a. Beschreibung) : - „0“ : Fehler ignorieren und weitermachen - „1“ : Kompletter „rollback“ - „2“ : „rollback“ nur für den Arbeitsschritt | tinyint | 7.0.3 |
DeleteWorkStep | 0 | Wird nur beachtet, wenn „WorkStepNo“ angegeben ist ! Entscheidet, ob die bestehende Bedingung geändert („0“) oder gelöscht („1“) werden soll. | bit | 7.0.3 |
Die Prozedur hat keine Rückgaben.
WorkStepNo | X-ter Arbeitsschritt („1“ bis „255“) des Triggers „TriggerID“, der je nach „DeleteWorkStep“ geändert/gelöscht werden soll. „NULL“ übergeben, um einen neuen Arbeitsschritt anzulegen (Nummer wird dann automatisch vergeben). |
Code | Beschreibung | Quelle 4) |
---|---|---|
-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 |
-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 |
-508 | Ungültiger TRI-Ausdruck | nur indirekt |
-504 | Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochen | nur 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] |
7.0.4 | 2014-03-19 | „WorkStep“ darf ab jetzt nur bestimme Zeichen enthalten |
7.0.3 | 2013-12-13 | 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/mi_ModifyTRITriggerWorkflow_Ad?TriggerID=<value>'
Mit xmllint 5) formatierte Ausgabe:
curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/mi_ModifyTRITriggerWorkflow_Ad?TriggerID=<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'), 'mi_ModifyTRITriggerWorkflow_Ad', array( 'TriggerID' => <value>, // 'IterationList' => NULL, // 'WorkStep' => NULL, // 'Description' => NULL, // 'CancelOnError' => 1, // 'DeleteWorkStep' => 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="mi_ModifyTRITriggerWorkflow_Ad"> <Parameters> <Parameter Name="TriggerID"><!-- smallint value --></Parameter> <!-- <Parameter Name="IterationList">NULL</Parameter> --> <!-- <Parameter Name="WorkStep">NULL</Parameter> --> <!-- <Parameter Name="Description">NULL</Parameter> --> <!-- <Parameter Name="CancelOnError">1</Parameter> --> <!-- <Parameter Name="DeleteWorkStep">0</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>