Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:mi_modifytemplates_ad

mi_ModifyTemplates_Ad

Prozedur zur Verwaltung von „Templates“.

Allgemein wird im „dStore“ unter einem Template einfach eine Datei verstanden, die (in was für einer Programmier-Sprache auch immer) Anweisungen (für die Client-Applikation) enthält, was für Informationen (zu einem „Element“) dargestellt werden sollen und wie das Layout aussehen soll (wie z.B. eine Produktansicht).
Die Datei wird immer in einem Fenster („Frame“) und zu einem „Source-Template“ geladen. Mit Source-Template ist eine Art „Kontext“ gemeint, unter der ein „Element“ angezeigt wird. Z.B. soll die Produktansicht eines Artikel-Elementes in einem Suchergebnis anders sein als in der „Normalansicht“.
Derzeit kommen „Templates“ nur im „Item Management“, genauer für „TreeNodeID“s (Elemente des Artikelbaums), zum Einsatz, allerdings ist das Konzept der Templates nicht von vornherein darauf beschränkt, sondern kann evtl. in zukünftigen „dStore“-Versionen auch noch in anderen Modulen zum Einsatz kommen.

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

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
TemplateIDNULL ID des Templates, das geändert oder gelöscht werden soll. „NULL“ angeben, um ein neues Template zu erstellen.
smallint3.5.0
Description Bezeichnung des (neuen) Templates („TemplateID“)
varchar(100)3.5.0
LanguageID ID einer Sprache. Da ein Template u.U. Text-Informationen enthält, entsteht eine Sprachabhängigkeit. Falls keine sprachabhängigen Informationen im Template vorhanden sind, kann die Sprache des Templates auch „Sprachunabhängig“ (ID „0“) sein.
tinyint3.5.0
FrameName Eine Art Bereich oder „Fentster“, „Frame“ genannt, in dem das Template geladen werden sollen (z.B. in Web-Anwendungen relevant)
varchar(30)3.5.0
FileName Da ein Template nichts anderes als eine Programm- oder Layout-Datei ist, wird durch diesen Parameter der Name der Datei festgelegt
varchar(255)3.5.0
CanBeSourceTemplate0 Handelt es sich um ein „Source-Template“ ? Damit ist eine Art „Kontext“ gemeint, unter der ein „Element“ dargestellt wird (siehe auch „Beschreibung“). Ein „Source-Template“ ist dabei nicht bloß ein „dummy“, sondern kann selbst ein normales Template sein.
bit3.5.0
IsRealTimeTemplate1 Gibt an, ob die Daten, die in dem Template angezeigt werden, in der Client-Anwendung ge„cache“d werden dürfen oder ob die Daten immer „RealTime“ dargestellt werden müssen
bit3.5.0
DeleteTemplate0 Wird nur beachtet, wenn eine „TemplateID“ übergeben wurde.
„0“ : Das Template „TemplateID“ soll geändert werden
„1“ : Das Template soll gelöscht werden
bit3.5.0

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]
6.5.3 2013-03-18Anpassungen an den aktuellen Quellcode-Standard, u.a. wg. UTF8-Unterstützung
4.0.14 2004-06-031. Aufruf der Prozeduren „_mi_StartProcedure“, „_mi_FinishProcedure“ und „_mi_ChooseParamValueSeperator“
2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur
3. Konsequente Fehlerbehandlung
3.5.0 2000-11-23Erstmalig 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_ModifyTemplates_Ad?Description=<value>&LanguageID=<value>&FrameName=<value>&FileName=<value>'

Mit xmllint 5) formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/mi_ModifyTemplates_Ad?Description=<value>&LanguageID=<value>&FrameName=<value>&FileName=<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_ModifyTemplates_Ad',
		array(
			'Description' => '<value>',
			'LanguageID' => <value>,
			'FrameName' => '<value>',
			'FileName' => '<value>',
			// 'TemplateID' => NULL,
			// 'CanBeSourceTemplate' => 0,
			// 'IsRealTimeTemplate' => 1,
			// 'DeleteTemplate' => 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_ModifyTemplates_Ad">
			<Parameters>
				<Parameter Name="Description"><!-- varchar value --></Parameter>
				<Parameter Name="LanguageID"><!-- tinyint value --></Parameter>
				<Parameter Name="FrameName"><!-- varchar value --></Parameter>
				<Parameter Name="FileName"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="TemplateID">NULL</Parameter> -->
				<!-- <Parameter Name="CanBeSourceTemplate">0</Parameter> -->
				<!-- <Parameter Name="IsRealTimeTemplate">1</Parameter> -->
				<!-- <Parameter Name="DeleteTemplate">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_modifytemplates_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)