mi_GetTemplates_Ad [dstore]

Inhaltsverzeichnis

mi_GetTemplates_Ad

mi_GetTemplates_Ad

Gibt die im „dStore“ definierten „Templates“ aus.

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	GET
HTTP-Auth	Optional
Tags	[mi, Get, Templates, Ad]
Engine-Kategorie	miscellaneous
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
TemplateID	NULL	ID eines Templates. Falls angegeben, wird nur der Datensatz zu diesem Template ausgegeben.	smallint	3.5.0

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
TemplateID	ID eines Templates (Näheres zu „Templates“ : siehe Beschreibung)	smallint	3.5.0
Description	Bezeichnung des 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	Bezeichnung des „Frames“ (oder auch : des „Fensters“), in der das Template geladen wird (also eine Einstellung, die eher an Web-Applikationen gedacht ist)	varchar(30)	3.5.0
FileName	Dateiname des Templates (in dem quasi der Source-Code des Templates gespeichert ist)	varchar(255)	3.5.0
CanBeSourceTemplate	Handelt es sich um ein „SourceTemplate“ ? Damit ist eine Art „Kontext“ gemeint, unter der ein „Element“ dargestellt werden soll. Z.B. soll die Produktansicht eines Artikel-Elementes in einem Suchergebnis anders sein als in der „Normalansicht“.	bit	3.5.0
IsRealTimeTemplate	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

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-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
-500	Falsche Parameter	nur 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-29	Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
4.0.14	2004-06-03	1. Aufruf der Prozeduren „_mi_StartProcedure“ und „_mi_FinishProcedure“ 2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur 3. Fehlende Doku der Ergebnismenge 4. Fehlender Index in einem Fall
3.5.0	2000-11-23	Erstmalig 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:

mi_GetTemplates_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_GetTemplates_Ad'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_GetTemplates_Ad' | 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_GetTemplates_Ad',
		array(
			// 'TemplateID' => 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_GetTemplates_Ad">
			<Parameters>
				<!-- <Parameter Name="TemplateID">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“

⁶⁾

I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Inhaltsverzeichnis