Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:mi_gettritriggerreplfuncts_ad

mi_GetTRITriggerReplFuncts_Ad

Ermittelt alle Ersetzungs-Funktionen, die für einen gegebenen „TRI-Trigger“ verwendet werden können.

Hintergrund :

„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. 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 einen „TRI-Ausdruck“ 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“ (s. gleichnamige Rückgabespalte im Ergebnis) ERSETZT (dieser wiederum kann aber seinerseits Platzhalter-Funktionen enthalten).

Anmerkung zum Parameter „ReplacementFunction“ :

Über diesen Parameter kann man eine vollständige Funktions-Definition (also inkl. konkreter Argumente) angeben, um diese auf ihre Gültigkeit zu prüfen. Wird „TriggerID“ angegeben, wird zusätzlich geprüft, ob die angegebene Funktions-Definition auch für diesen konkreten Trigger gültig ist.

Hinweise zur Rückgabespalte „FunctionDefinition“ (und „Description“) :

1.) In „FunctionDefinition“ steht die VOLLSTÄNDIGE Definition der Funktion, d.h. inkl. umschließender „#“ (die alle Ersetzungs-Funktionen kennzeichnen), dem Namen der Funktion sowie einem „LIKE“-Ausdruck für die erlaubten Argumente. Bedeutet : in einem „TRI-Ausdruck“ darf eine Zeichenkette angegeben werden, die „LIKE FunctionDefinition“ ist (d.h. es können bei den Argumenten „pattern“ vorkommen - eine kleine Untermenge von regulären Ausdrücken).

2.) „Custom“-Funktionen enthalten NIE Argumente und ihr Name beginnt mit „_“.

3.) Es kann zwar zum selben Standard-Funktions-Namen mehrere „pattern“ für das/die Argument(e) der Funktion geben (s. 1.), aber die Beschreibung ist immer pro Funktions-Name eindeutig, also so formuliert, daß sie auf alle möglichen Argumente paßt.

HTTP-MethodGET
HTTP-AuthOptional
Aliasmi_GetTRITriggerReplacementFunctions_Ad
Tags
Engine-Kategoriesystem administration
Engine-TypDaten-Ermittlung
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 verfügbaren Ersetzungs-Funktionen ermittelt werden sollen. Wird „NULL“ angegeben, werden alle Funktionen ermittelt, bei „0“ alle Standard-Funktionen.
smallint7.0.3
FunctionDefinition_LIKENULL Ist man auf der Suche nach bestimmten Funktions-Definitionen (s. Rückgabespalte „FunctionDefinition“), kann hier ein enstprechender „Such-Wert“ angegeben werden (es wird der „LIKE“-Operator verwendet, d.h. die üblichen „wildcards“ sind erlaubt)
varchar(200)7.0.3
ReplacementFunctionNULL Wird nur beachtet wenn „FunctionDefinition_LIKE = NULL“ ist ! Hier kann eine vollständige Funktions-Definition (inkl. Argumente) angegeben werden, um prüfen zu können, ob diese gültig ist.
varchar(150)7.0.3

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
FunctionDefinitionVollständige Definition der Funktion : umschließende „#“ (kennzeichnet alle Funktionen), Funktionsname sowie ein (optionaler) „LIKE“-Ausdruck für erlaubte Argumente (d.h. es können „pattern“ - kleine Untermenge von regulären Ausdrücken- vorkommen)
varchar(150)7.0.3
ReplaceStringImmer „NULL“ bei Standard-Funktionen. Bei „Custom“-Funktionen hingegen steht hier NIE „NULL“, sondern die Zeichenkette, durch die ein Vorkommen von „FunctionDefinition“ im „TRI-Ausdruck“ ersetzt wird.
varchar(200)7.0.3
DescriptionBei Standard-Funktionen eine genaue Erläuterung, durch was „FunctionDefinition“ in einem „TRI-Ausdruck“ ersetzt wird. Bei „Custom“-Funktionen KANN hier ebenfalls eine Beschreibung hinterlegt sein, die dann i.d.R. Erläuterungen zum „ReplaceString“ enthält.
varchar(1000)7.0.3
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • FunctionDefinition (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 5)
-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 Parameternur 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.4 2014-03-19„TriggerID=NULL“ wird nun unterstützt.
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 GET  'http://<partner>-<project>.dstore.de/default/engine/mi_GetTRITriggerReplFuncts_Ad?TriggerID=<value>'

Mit xmllint 6) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_GetTRITriggerReplFuncts_Ad?TriggerID=<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_GetTRITriggerReplFuncts_Ad',
		array(
			'TriggerID' => <value>,
			// 'FunctionDefinition_LIKE' => NULL,
			// 'ReplacementFunction' => NULL
		)
);
 
$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_GetTRITriggerReplFuncts_Ad">
			<Parameters>
				<Parameter Name="TriggerID"><!-- smallint value --></Parameter>
				<!-- <Parameter Name="FunctionDefinition_LIKE">NULL</Parameter> -->
				<!-- <Parameter Name="ReplacementFunction">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
6)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/mi_gettritriggerreplfuncts_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)