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-Method | POST |
HTTP-Auth | Optional |
Tags | |
Engine-Kategorie | configurations |
Engine-Typ | Daten-Änderung |
Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
---|---|---|---|---|
TemplateID | NULL | ID des Templates, das geändert oder gelöscht werden soll. „NULL“ angeben, um ein neues Template zu erstellen. | smallint | 3.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. | tinyint | 3.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 | |
CanBeSourceTemplate | 0 | 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. | bit | 3.5.0 |
IsRealTimeTemplate | 1 | 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 | bit | 3.5.0 |
DeleteTemplate | 0 | Wird nur beachtet, wenn eine „TemplateID“ übergeben wurde. „0“ : Das Template „TemplateID“ soll geändert werden „1“ : Das Template soll gelöscht werden | bit | 3.5.0 |
Die Prozedur hat keine Rückgaben.
Die Prozedur hat keine Output-Parameter.
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 |
-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] |
6.5.3 | 2013-03-18 | Anpassungen an den aktuellen Quellcode-Standard, u.a. wg. UTF8-Unterstützung |
4.0.14 | 2004-06-03 | 1. 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-23 | 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_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 -
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();
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>