Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:mi_modifytritriggertodos_ad

mi_ModifyTRITriggerToDos_Ad

Prozedur zur Verwaltung von Anweisungen für einen Arbeitsschritt 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 konfiguriert ist.

Eine Anweisung besteht im wesentlichen aus einem Prozedur-Aufruf (→ „ProcCall“). Da hierfür logischerweise eigentlich immer „dynamische Werte“ benötigt werden, wird die angegebene Zeichenkette als „TRI-Ausdruck“ behandelt, d.h. sie darf „Platzhalter-Funktionen“ enthalten - s. mi_GetTRITriggerReplFuncts_Ad - die zur Laufzeit ausgewertet werden.
Optional kann der Aufruf auch in einer Schleife aufgerufen werden (z.B. um alle IDs zu verarbeiten, die aber den/die Parameter-Werte eines einzigen Aufrufs „sprengen würden“), weswegen ein entsprechender Iterator (→ „IterationList“) übergeben werden kann. Auch dies ist ein „TRI-Ausdruck“, in dem Platzhalter-Funktionen zur Verfügung stehen.

Bzgl. der Anweisung („ProcCall“) sind nur bestimmte Prozeduren erlaubt, die zum einen in einer Transaktion ausführbar sein müssen (also z.B. keine temporären Tabellen erstellen dürfen) und möglichst keine Ergebnismenge liefern sollten (nicht verboten aber mit möglichen Seiteneffekten behaftet und die Ergebnismenge(n) kann/können nicht verwendet werden). Außerdem dürfen es nicht zu „komplexe Prozeduren“ sein, d.h. die Ausführung sollte möglichst kurz und effizient sein, weil sie ja innerhalb einer Transaktion stattfindet. Komplexere Dinge wie Dokument-Erzeugung oder E-Mail-Versand können zudem sowieso nicht innerhalb der Engine realisiert werden, weswegen das „Actions“-Konzept zur Verfügung steht. Aus diesen Gründen beschränken sich die Möglichkeiten z.Zt. daher genau auf die folgenden Prozeduren :

  • ac_InsertAction_Ad
  • om_ChangeOrderState_Ad
  • mi_InsertTempdb_AnyValues
  • mi_DeleteFromTempdbTable
  • mi_InsertTempdb_OneID

Klassisches Beispiel : Bei einem „ChangeOrderStateTrigger“ (Rückgabespalte „TriggerTypeID“ von mi_GetTRITrigger_Ad enthält den Wert „2“) sollen einfach alle betroffenen Positionen in einen anderen Status weitergesetzt werden (nach dem vielleicht auch andere Dinge erledigt bzw. geprüft wurden). Dazu verwendet man die Prozedur om_ChangeOrderState_Ad, die für die zu behandelnden (OrderContent)IDs im Parameter „OrderContentIDs“ aber nur ein „varchar(255)“ bietet. Ergo gibt man dann in „IterationList“ diesen Wert an :
'#affectedids(trigger)##split(255,''¶'')#'
Sollte der Status (in den weitergesetzt werden soll) die ID „42“ haben, definiert man „ProcCall“ dann so :
'om_ChangeOrderState_Ad OrderContentIDs = ''#iteratorvalue(todo)#'', IsOrderID = 0, OrderStateID = 42'
Alternativ kann man natürlich auch mi_InsertTempdb_OneID-Aufrufe machen (selbe „IterationList“) und in einer WEITEREN Anweisung dann den Aufruf om_ChangeOrderState_Ad OrderContentIDs = NULL, ... definieren (damit alle IDs in EINEM Aufruf verarbeitet werden).

Hinweis : Sofern der Trigger schon zugewiesen ist (s. Rückgabespalte „TriggerStatus“ von mi_GetTrigger_Ad), kann NICHTS mehr geändert werden !

HTTP-MethodPOST
HTTP-AuthOptional
Tags
Engine-Kategoriesystem administration
Engine-TypDaten-Änderung
Letzte Aktualisierung7.0.7 (2015-01-29)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
TriggerID ID eines „TRI-Trigger“, zu dem eine Anweisung (zum Arbeitsschritt „WorkStepNo“) verwaltet werden soll
smallint7.0.3
WorkStepNo Eindeutige Nummer eines Arbeitsschrittes für den Trigger „TriggerID“ (bestimmt die Reihenfolge des Arbeitsschritts innerhalb aller Arbeitsschritte des Triggers), zu dem eine Anweisung verwaltet werden soll
tinyint7.0.3
ToDoNoNULL X-te Anweisung („1“ bis „255“) zum Arbeitsschritt „WorkStepNo“ des Triggers „TriggerID“, die je nach „DeleteToDo“ geändert/gelöscht werden soll. „NULL“ übergeben, um eine neue Anweisung anzulegen (Nummer wird dann automatisch vergeben).
tinyint7.0.3
ProcCall „TRI-Ausdruck“, der einen Prozedur-Aufruf (und damit die Anweisung des Arbeitsschrittes) darstellt - s.a. Beschreibung !
varchar(2000)7.0.3
IterationListNULL Optionaler Iterator (wie „ProcCall“ ebenfalls ein „TRI-Ausdruck“) für die Anweisung, d.h. „ProcCall“ wird sooft ausgeführt, wie iteriert wird - s.a. Beschreibung !
varchar(1000)7.0.3
DeleteToDo0 Wird nur beachtet, wenn „ToDoNo“ angegeben ist ! Entscheidet, ob die bestehende Anweisung geändert („0“) oder gelöscht („1“) werden soll.
bit7.0.3

Rückgabe

Die Prozedur hat keine Rückgaben.

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 4)
-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
-535Das Datum liegt nicht in der Vergangenheitnur indirekt
-530Der Wert ist nicht konvertierbarnur indirekt
-510Der Benutzer ist nicht registriertnur indirekt
-508Ungültiger TRI-Ausdrucknur indirekt
-504Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochennur indirekt
-502Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)nur indirekt
-500Falsche Parameterdirekt und 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]
7.0.3 2013-12-13Erstmalig 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/mi_ModifyTRITriggerToDos_Ad?TriggerID=<value>&WorkStepNo=<value>&ProcCall=<value>'

Mit xmllint 5) formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/mi_ModifyTRITriggerToDos_Ad?TriggerID=<value>&WorkStepNo=<value>&ProcCall=<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'),
	'mi_ModifyTRITriggerToDos_Ad',
		array(
			'TriggerID' => <value>,
			'WorkStepNo' => <value>,
			'ProcCall' => '<value>',
			// 'ToDoNo' => NULL,
			// 'IterationList' => NULL,
			// 'DeleteToDo' => 0
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();
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="mi_ModifyTRITriggerToDos_Ad">
			<Parameters>
				<Parameter Name="TriggerID"><!-- smallint value --></Parameter>
				<Parameter Name="WorkStepNo"><!-- tinyint value --></Parameter>
				<Parameter Name="ProcCall"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="ToDoNo">NULL</Parameter> -->
				<!-- <Parameter Name="IterationList">NULL</Parameter> -->
				<!-- <Parameter Name="DeleteToDo">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
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
engine/procedures/mi_modifytritriggertodos_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)