HTML Templates erstellen

Informationen zum Anzeigen der Steckbriefe können hier eingesehen werden. Die Konfiguration von Abfragen ist hier genauer beschrieben.

Die Steckbrieffunktion ist eine Erweiterung, welche in der GOBENCH IQ Konfiguration explizit freigeschaltet werden muss. Bitte setzen Sie sich für genauere Informationen mit INDEC in Verbindung.

Hinweis: Diese Seite enthält lediglich Informationen bezüglcih der Erstellung von normalen Steckbrief Templates. Informationen bezüglich der Erstellung von Templates für Steckbriefe mit mehrfachausfüllung können hier eingesehen werden.

HTML Templates

Um Steckbriefabragen wie vorgesehen nutzen zu können, muss für sie ein HTML Template erstellt werden. Der Aufbau dieser Templates und die zu berücksichtigenden Voraussetzungen werden hier kurz erläutert.

Grundsätzlich sollte ein Template pro Abfrage bzw. Sprache nur aus nur einer HTML Datei bestehen, in ihr müssen bestimmte Vorgaben eingehalten werden auf die später noch eingegangen wird.

CSS und JavaScript sollten auch in der HTML Datei vorhanden sein, zwar können sie auch separiert in dem entsprechenden Verzeichnis abgelegt werden, jedoch kann dies nur INDEC tun, auch Bilder oder andere für das Template erforderliche Dokumente muss INDEC auf den Server legen.

Bilder und zusätzliche CSS Dateien sollten in einem Unterordner mit der Bezeichnung "css" abgelegt werden, sowie zusätzliche JavaScript Bibliotheken und Dateien in einem Unterordner mit der Bezeichnung "js" abgelegt werden sollten.

Der Ordner "js" ist standardmäßig vorhanden und enthält die Dateien jQuery.js in der Version 1.11.1 und jQuery.ui.js in der Version 1.11.0, welche zur Nutzung zur Verfügung stehen.

Template Variablen

Die Template Variablen setzen sich aus einigen Elementen zusammen und dienen als Platzhalter für die Werte aus dem GOBENCH IQ. In ihnen wird außerdem beschrieben, welche Datenfelder, wie verwendet werden sollen, um das gewünschte Ergebnis zu erreichen.

Die Struktur der Template Variablen sieht wie folgt aus:

1. Startzeichen: $

2. Typ in Eckigen Klammern:

[FL]	Field Label	Bezeichnung; Modulfeldname
[FLD]	Field Label Description	Beschreibung; Modulfeld
[FLG]	Field Label Group	Bezeichnung; Modulfeldname(Datentyp "Gruppe")
[FLGD]	Field Label Group Description	Beschreibung; Modulfeld (Datentyp "Gruppe")
[FD]	Field Data	Datenwert; Modulfeld
[FDC]	Field Data Comment	Datenwertkommentar(e); Modulfeld
[G]	Global	Globale Variable (ohne Bezug auf ein Modulfeld)
[GFL]	Global Field Label	Globale Variable (mit Bezug auf ein "Hauptfeld")
[GFD]	Global Field Data	Globale Variable (mit Bezug auf ein "Hauptfeld")

3. Zusatzoptionen in Eckigen Klammern (Optional): z.B. "[O]" für den Originalwert

Eine Beschreibung der Zusatzoptionen für die verschiedenen Datentypen folgt später.

4. Ausgabesprache in Eckigen Klammern (Optional): z.B. [1] für Deutsch (de_DE) oder [0] für Englisch (en_US)

5. Datenfeld ID:

Die ID des Datenfeldes aus der Abfrage im GOBENCH IQ.

Hinweis: Hierbei handelt es sich nicht um die globale Datenfeld ID, welche unter anderem in Modulen dargestellt wird.

6. Endzeichen: !

Ein Beispiel basierend auf dem Datenfeld Region könnte so aussehen:

$[FD]24!

In eine HTML Datei eingebettet würde dies zur Ausgabe des Wertes, des Datenfeldes "Region" einer spezifischen Systeminstanz führen.

Zusatzformatierungen

Es gibt eine Vielzahl an möglichen Zusatzoptionen für die verschiedenen Datentypen, je nach dem welches Ergebnis erzielt werden soll, können einzelne oder mehrere gewählt werden.

Hinweis: Für einige dieser Optionen ist es gegebenenfalls nötig spezifische Styles der Standardcontrols in die Vorlagendatei zu integrieren.

Datentyp	Zusatzoption
Gruppe
Zahl	S = Standardausgabetext N = Wert ohne Einheit inkl. Formatierung U = nur Einheit als Text P = Preisoption als Text O = Wert ohne Formatierung, wie in DB NR = Bereichsgrafik (Standardcontrol) NRC = Bereichsgrafik (Customcontrol)
Formel	S = Standardausgabetext N = Wert ohne Einheit inkl. Formatierung U = nur Einheit als Text T = Textwert I = Eingabetyp (Manuell (1), Berechnet (2)) O = Wert ohne Formatierung, wie in DB NR = Bereichsgrafik (Standardcontrol) NRC = Bereichsgrafik (Customcontrol)
Ankreuzfeld	S = Standardausgabetext O = Wert ohne Formatierung, wie in DB
Datum	S = Standardausgabetext O = Wert ohne Formatierung, wie in DB (?als Datumsangabe ohne Zeit)
Text	S = Standardausgabetext (HTML) O = Wert ohne Formatierung, wie in DB
Text (mehrsprachig)	wie Text Ausgabesprache kann zusätzlich über Sprach-ID festgelegt werden
Auswahlliste	S = Standardausgabetext (Name) N = Name D = Beschreibung V = Numerischer Wert BC = Hintergrundfarbe als Hex-Wert FC = Vordergrundfarbe als Hex-Wert IT = Url des Vorschaubildes (Icon) IP = Url des Originalbildes (Icon) PT = Url des Vorschaubildes (Bild) PP = Url des Originalbildes (Bild) NR = Bereichsgrafik (Standardcontrol) NRC = Bereichsgrafik (Customcontrol) Ausgabesprache kann zusätzlich über Sprach-ID festgelegt werden
Auswahlliste (mehrfach)	wie Auswahliste, mehrere Datenwerte sind semikolonsepariert

Datentyp	Zusatzoption
URL	U = nur Eigenschaft „URL“ (wie eingegeben) N = nur Eigenschaft „Name“
URL (mehrfach)	wie Url, mehrere Datenwerte sind semikolonsepariert.
Bild	T = Url des Vorschaubildes P = Url des Originalbildes F = Dateiname N = Name / Beschreibung (ggf. + Sprachwahl) IT = img-Tag des Vorschaubildes IP = img-Tag des Originalbildes
Bild (mehrfach)	Wie Bild, mehrere Datenwerte sind semikolonsepariert
Dokument	U = URL auf Datei, als relative Adresse F = Dateiname N = Name des Dokuments D = Beschreibung des Dokuments
Dokument (mehrfach)	Wie Bild, mehrere Datenwerte sind semikolonsepariert
Referenz Tabelle	S = Kurzname der Zeile V = JSON String aller Spaltenwerte
Ref. Tabelle (mehrfach)	S = Kurzname der Zeilen (JSON-String) V= JSON-String aller Spaltenwerte
Ref. Tabelle [Spalte]	Abhängig vom jeweiligen Datentyp
Modul Tabelle	S = Kurzname der Zeilen (JSON-String) V = JSON String aller Spaltenwerte
Modul Tabelle [Spalte]	Abhängig vom jeweiligen Datentyp
**********************	**********************
[Datenfeldbeschreibung]	S = Standardausgabetext PT = Url des Vorschaubilds (Bild) PP = Url des Originalbilds (Bild) Ausgabesprache kann zusätzlich über Sprach-ID festgelegt werden
[Kommentar]	S = Standardausgabetext (Kommentar) T = Kommentartext CT = Kommentartyp CTI = Index des Kommentartyps CC = Kommentarklassifizierung A = Alle Eigenschaften I1T = Url des Vorschaubildes (Bild1) I1P = Url des Originalbildes (Bild1) I1F = Dateiname (Bild1) I1N = Name / Beschreibung (Bild1) I2T = Url des Vorschaubildes (Bild1) I2P = Url des Originalbildes (Bild1) I2F = Dateiname (Bild1) I2N = Name / Beschreibung (Bild1) I3T = Url des Vorschaubildes (Bild1) I3P = Url des Originalbildes (Bild1) I3F = Dateiname (Bild1) I3N = Name / Beschreibung (Bild1) F1U = Url auf Datei (Dok1) F1F = Dateiname (Dok1) F1N = Name des Dokuments (Dok1) F1D = Beschreibung des Dokuments (Dok1) Ausgabe immer als JSON-String Ausgabesprache kann zusätzlich über Sprach-ID festgelegt werden.

Modul Template-Variablen

Bei der Verwendung einer Modul Template Variablen werden die gesamten Modulfelder / Moduldaten (Modulinstanz(en)) als spezielles JSON-Objekt aufbereitet und in der Variablen ersetzt.

Dieses JSON-Objekt kann dann mit Hilfe von Javascript weiter verarbeitet werden.

Es gibt folgende Standard Variablendeklaration für Module / Moduldaten:

$[GMD]234!	Moduldaten als JSON-Zeichefolge/Objekt
$[GMD][M]234!	Moduldaten als JSON-Zeichenfolge/Objekt mit Metadaten. Die Metadaten (Referenztabellen/ Auswahllisten) werden seperat übertragen; In den Daten werden dann nur die IDs zur Zuordnung übertragen; Dadurch können die übertragenen Datenmengen reduziert werden.
$[GMD][UI1]234!	Moduldaten als JSON-Zeichenfolge/Objekt mit Metadaten. Die Metadaten bilden den Änderungsbenutzer (Datum, Nach-/Vorname) pro Datensatz ab.
$[GMD][UI2]234!	Moduldaten als JSON-Zeichenfolge/Objekt mit Metadaten. Die Metadaten bilden den Änderungsbenutzer (Datum, Nach-/Vorname), Erstellungsbenutzer (Datum, Nach-/Vorname), Freigabe-/Aktiverungsbenutzer (Datum, Nach-/Vorname) pro Datensatz ab.

Mehrere Optionen werden durch "|" getrennt. Z.B.:"$[GMD][M|UI2]234!"

Hinweis: Modul Template-Variablen können nur in einer Systemabfrage verwendet werden.

Globale Template-Variablen

Für globale Template Variablen gibt es die folgenden Deklarationsmöglichkeiten.

$[G][QN]! oder $[G][QN][1]!	Name der Abfrage oder Name der Abfrage in einer spezifischen Sprache
$[G][QON]!	Name des Hauptsystems / -Moduls der Abfrage(Hauptobjekt)
$[G][QOIN]!	Kurzname der Hauptsysteminstanz / -Modulinstanz der Abfrage
$[G][QOICD]!	Erstellungsdatum der Hauptsysteminstanz / -Modulinstanz
$[G][QOIMD]!	Änderungsdatum der Hauptsysteminstanz / -Modulinstanz
$[G][QOIRD]!	Freigabedatum der Hauptsysteminstanz / -Modulinstanz
$[G][UN]!	Name des Erstellungsbenutzers der Steckbriefansicht (Druckansicht)

Des Weiteren gibt es auch globale Variablen mit einem direkten Bezug auf Basisdatenfelder des Hauptobjektes, diese sind.

$[GFL]ID des Hauptobjektes!	Bezeichnung (Datenfeldname)
$[GDF]ID des Hauptobjektes!	Wert (Datenwert des Feldes; datentypspezifische Standarddarstellung)

Umsetzung der Variablen in Templates

Für die Umsetzung der Templates müssen die gewünschten Datenfeld IDs, der Abfragen, lediglich in eine HTML Struktur verpackt, die Styles und Scripts definiert werden und das Dokument dann hochgeladen werden.

Beispielsweise könnte ein Teil der HTML Struktur etwa so aussehen:

</div>

Hier würde eine Box mit der Anzeige "Abfragenname - Titel der Ansicht", "Kurzname des Hauptobjektes der Abfrage", "Vorschaubild des Produktes" erscheinen.

Die Darstellung von technischen Daten mithilfe von Tabellen oder ähnlichem ist ebenso möglich, wie die Darstellung von Bereichsgrafiken.

Tabelle mit z.B. technischen Daten:	Einbinden einer Bereichsgrafik:
<table id="techData"> <tr> <td class="field">$[FL][S]19!</td> <td class="values">$[FD][S]19!</td> </tr> <tr> <td class="field">$[FL][S]20!</td> <td class="values">$[FD][S]20!</td> </tr> </table>	<div class="dataSurr"> <div class="name"> <div class="label"> $[FL]393! <!--field-name--> </div> </div> <div class="gradient"> $[FD][NR]393! <!--gradient control --> </div> </div>

Speicherfunktion

Es können serverseitig für einen Steckbrief Daten permanent abgespeichert und wieder abgerufen werden. Diese Daten können für einen einzelnen Benutzer oder global (für alle Benutzer) für den bestimmten Steckbrief abgespeichert werden. Für den Zugriff auf diese Web-API ist eine gültige Nutzersitzung (LoginKey) notwendig.

Beim Abrufen der Daten werden diese in der Datenbank mit dem Datum der letzten "Benutzung" markiert.

Beim Speichern der Daten wird server-seitig immer eine neue Version der Daten erstellt. Vorhandene Daten werden nicht überschrieben (Backupfunktion).

Für das Speichern/Abrufen der Daten ist für jeden Steckbrief eine eindeutige ID festzulegen, auf deren Basis der Aufruf erfolgt.

Da diese Speicherfunktion auch für Custom Startpages verwendet werden kann, muss beim Aufruf ebenfalls der Custom-Seitendatentyp angegeben werden:

1=Steckbrief
2=Custom Startpage

Folgende Befehle werden zum Speichern bzw. Abrufen der Daten benötigt:

Abrufen von globalen Daten:

GET {GOBENCHURL}/web/api/custompagedata/{pageType}/{pageId}/

Abrufen von Benutzerdaten:

GET {GOBENCHURL}/web/api/custompagedata/{pageType}/{pageId}/{userId}

Speichern von globalen Daten:

PUT {GOBENCHURL}/web/api/custompagedata/{pageType}/{pageId}/
Speichern von Benutzerdaten:

PUT {GOBENCHURL}/web/api/custompagedata/{pageType}/{pageId}/{userId}