Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:mi_modifytritriggerreplfunc_ad

mi_ModifyTRITriggerReplFunc_Ad

Prozedur, um eine „custom“-Funktion für einen „TRI-Trigger“ zu erstellen/ändern/löschen.

„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 (s. mi_ModifyTRITriggerWorkflow_Ad), zu denen optional eine Bedingung hinterlegt sein kann (s. mi_ModifyTRITriggerConds_Ad) und zu denen immer eine bestimmte Reihe von Anweisungen (derzeit Prozedur-Aufrufen) konfiguriert ist (s. mi_ModifyTRITriggerToDos_Ad„). Außerdem kann für jeden einzelnen Arbeitsschritt und jede einzelne Anweisung ein „Iterator“ definiert werden.

Alle diese Iteratoren sowie die Bestandteile der (optionalen) Bedingungen und die Anweisungen selbst stellen sogenannte „TRI-Ausdrücke“ dar. Das sind zunächst einmal schlicht und einfach Zeichenketten. Das besondere ist, daß diese Zeichenketten sogenannte „Platzhalter-Funktionen“ enthalten dürfen, die zur Laufzeit ihrer Funktion gemäß ERSETZT werden. Daher rührt übrigens auch der Name “… replacement interpreter„.

Diese „Platzhalter-Funktionen“ unterteilen sich grob in zwei Klassen : Standard-Funktionen und „Custom“-Funktionen. Letztere zeichnen sich dadurch aus, daß der Name mit einem „_“ beginnt und außerdem die Funktionsweise immer gleich ist : Ihr Vorkommen wird immer und ohne Ausnahmen durch einen entsprechend hinterlegten „ReplaceString“ ERSETZT (dieser wiederum kann aber seinerseits Platzhalter-Funktionen enthalten).

Hinweise :
1. Sofern der Trigger schon zugewiesen ist (s. Rückgabespalte „TriggerStatus“ von mi_GetTrigger_Ad), kann NICHTS mehr geändert werden !
2. Falls eine bestehende Funktion geändert (genauer : „ReplaceString“ geändert - das Ändern von „Description“ ist kein Problem) oder gelöscht wird, gehen wir 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 !
3. Geprüft wird bzgl. „ReplaceString“ lediglich, ob der Parameter weder „NULL“ ist noch den „leeren string“ enthält ! Grund ist, daß der Kontext ja unbekannt ist, sprich, WO innerhalb des „Triggers“ die Funktion zum Einsatz kommt bzw. kommen wird ! Erst wenn ein konkreter TRI-Ausdruck in einem Iterator, einer Bedingung oder einem Prozedur-Aufruf eines Arbeitsschrittes des Triggers definiert wird (der die „Custom“-Funktion enthält), findet natürlich eine Prüfung statt.
Anmerkung : Rein theoretisch kann man also eine Funktion definieren, die in KEINEM Kontext gültig ist !

HTTP-MethodPOST
HTTP-AuthOptional
Aliasmi_ModifyTRITriggerReplacementFunctions_Ad
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 die in „FunctionDefinition“ angegebene „Custom“-Funktion erstellt/angelegt/gelöscht werden soll
integer7.0.3
FunctionDefinition Bezeichnet eindeutig die zu ändernde/erstellende/löschende Funktion. Muß die Form “#<Funktionsname>()#„ haben, wobei <Funktionsname> mit einem „_“ beginnen muß und danach nur KLEINBUCHSTABEN (a-z) und Zahlen (0-9) erlaubt sind.
varchar(150)7.0.3
ReplaceString Zeichenkette, durch die die in „FunctionDefinition“ angegebene Zeichenkette in einem „TRI-Ausdruck“ ersetzt werden soll. Es können beliebige Zeichen enthalten sein, u.a. eine Standard-(Platzhalter-)Funktion oder auch wiederum eine „Custom“-Funktion.
varchar(200)7.0.3
DescriptionNULL Optional kann hier eine Erläuterung zur Funktion (bzw. i.d.R. wohl eher zum „ReplaceString“) angegeben werden
varchar(1000)7.0.3
DeleteFunction0 Falls „FunctionDefinition“ schon für „TriggerID“ hinterlegt ist, entscheidet dieser Parameter darüber, ob sie geändert („0“) oder gelöscht („1“) wird
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
-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_ModifyTRITriggerReplFunc_Ad?TriggerID=<value>&FunctionDefinition=<value>&ReplaceString=<value>'

Mit xmllint 5) formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/mi_ModifyTRITriggerReplFunc_Ad?TriggerID=<value>&FunctionDefinition=<value>&ReplaceString=<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_ModifyTRITriggerReplFunc_Ad',
		array(
			'TriggerID' => <value>,
			'FunctionDefinition' => '<value>',
			'ReplaceString' => '<value>',
			// 'Description' => NULL,
			// 'DeleteFunction' => 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_ModifyTRITriggerReplFunc_Ad">
			<Parameters>
				<Parameter Name="TriggerID"><!-- integer value --></Parameter>
				<Parameter Name="FunctionDefinition"><!-- varchar value --></Parameter>
				<Parameter Name="ReplaceString"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="Description">NULL</Parameter> -->
				<!-- <Parameter Name="DeleteFunction">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_modifytritriggerreplfunc_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)