HTML Basic Spots

HTML-Basic-Spots sind Webseiten, die lokal auf dem Player abgelegt werden. Sie können nur sehr geringfügig in der IXM Plattform (CMS) parametriert werden. Für eine breitere Integration in das Grassfish System verwenden Sie bitte HTML Wizard-Spots.

Dateiaufbau

Die Webseite muss eine Datei namens index.html enthalten. Diese Datei dient als Einstiegspunkt für die Webseite. Darüber hinaus darf die Webseite beliebige Unterverzeichnisse haben, diese müssen aber innerhalb der Seite immer relativ angesprochen werden. 

Die HTML-Seite muss vor dem Hochladen in die IXM Plattform gezippt werden; die Dateiendung muss .html.zip lauten. Wenn die ZIP-Datei korrekt in die IXM Plattform hochgeladen wurde, wird sie im System als Spot mit folgenden Thumbnails angelegt:

Player-Dateisystem und Aufruf des HTML-Basic-Spots

Sowohl auf Windows als auch auf Linux Playern ist das Basisverzeichnis des Webservers, der die Website hostet, das media-Verzeichnis. Der lokale Pfad zum HTML-Spot ist spotspezifisch: /ZipSpots/[FileName]/index.html 

Logdateien

Während der Spotentwicklung und insbesondere bei der Fehlersuche empfehlen wir, die Logdateien des Grassfish Player zu beachten. 

Windows

Auf dem Windows Player sind dabei folgende Verzeichnisse relevant: C:\GVClient\log\Player. Hier befinden sich die allgemeinen Player-Logdateien.

Hier befinden sich die Player-Logdateien für den ersten Screen: C:\GVClient\log\Player1. Insbesondere ist hier detailliert ersichtlich, wann welcher Spot abgespielt wurde.

Linux

Auf dem Linux Player befinden sich die Player-Logdateien einheitlich im folgenden Verzeichnis: /opt/grassfish/logs/gfPlayer

 Windows Player

Auf Windows Playern wird die Webseite mit IISExpress gehostet und auf Basis des am Player installierten Internet Explorer abgespielt.

Die Website wird wie im folgenden Beispiel vom Player aufgerufen:

http://localhost:XXXX/ZipSpots/[FileName]/index.html?width=1368&height=768&bgcolor=ff00ff&siID=54165&udcWsPath=http%3A%2F%2Flocalhost%3A8080%2FUdcWs&usePreload=true

Das media-Verzeichnis und somit das Web-Root befindet sich standardmäßig auf Windows Playern unter: C:\GVClient\data\media\

Linux Qt Player

Auf Linux Playern wird die Webseite mit lighttpd gehostet und auf Basis des Chromium Embedded Framework (CEF) im Grassfish Player abgespielt.

Die Webseite wird wie im folgenden Beispiel vom Player aufgerufen: http://localhost/ZipSpots/_123_v.1_sampleSpot.html.zip/index.html

Das media-Verzeichnis und somit das Web-Root befindet sich standardmäßig auf Linux-Playern unter: /opt/grassfish/media/

Tipps zur effizienteren Entwicklung:

Zum Entwickeln eines neuen HTML-Spots empfehlen wir, eine frühe Version des Spots über das Grassfish CMS auf einen Testplayer zu verteilen und die Daten dann über WinSCP auf den Linux Player direkt zu übertragen, um eine aktualisierte Voransicht des Spots anzuzeigen.

Im media-Verzeichnis, das auf Linux Playern unter /opt/grassfish/ zu finden ist, befinden sich alle Spot-Dateien, unter anderem auch die html.zip-Spots. Nach dem Herunterladen entpackt der Player die Dateien in einen Unterordner namens ZipSpots.

Zum Entwickeln können Sie die Dateien direkt in dem Verzeichnis austauschen und anschließend auf dem Player die Taste F5 drücken, um den Spot neu zu starten.

Android Player

Auf Android Playern wird die Website in einer WebView (android.webkit.WebView) dargestellt.

Ein Aufruf wird im folgenden Beispiel gezeigt: http://localhost:9090/zipSpots/[Filename]/index.html?usePreload=true 

Optional lassen sich über GET-Parameter eine oder mehrere Konfigurationen übergeben.

Das media-Verzeichnis (Web-Root) befindet sich auf AndroidPlayern standardmäßig unter:

• Bis Version 11.1: /storage/emulated/0/Download/grassfish/media/
• Ab Version 11.1: /storage/emulated/0/Download/GF/media/

Konfigurierbarkeit von HTML-Basic-Spots

HTML-Basic-Spots lassen sich analog zu Flash-Spots über die sogenannten DynamicItems konfigurieren. Die DynamicItems dienen dazu, dem Spot gewisse Konfigurationseinstellungen mitzugeben. Ein Beispiel wäre ein Filterkriterium, nach dem der Spot eine Datenquelle filtert oder eine Farbe, mit der sich der Spot unterschiedlich einfärbt. 

Die Eigenschaften können Sie in der IXM Plattform beim Spot mit Werten versehen, bevor Sie ihn in die Playliste ziehen. Diese Werte werden dann auf den Spot in der Playliste kopiert und können dort unabhängig vom zugrundeliegenden Spot nochmals für jede Playliste angepasst werden. Anschließend werden diese Eigenschaften dem Spot beim Aufruf auf dem Player als URL-Parameter übergeben. Alle Werte werden demnach auf dem Player URL-encodiert, darauf sollten Sie beim Spotentwickeln Rücksicht nehmen.

Beispiel

Die Konfigurationsfunktion

<Object>
       <ID>someBoolean</ID>
	<DataType>boolean</DataType>
	<Value>true</Value>
	<DisplayName>Some boolean</DisplayName>
</Object>

wird wie folgt über die URL auf den Player übertragen: …index.html?otherParams=otherValues&someBoolean=true

Der Spotwert true kann in der Grassfish IXM Plattform geändert werden. Für erweiterte Konfigurationsmöglichkeiten nutzen Sie bitte HTML Wizard-Spots.

settings.xml

<?xml version="1.0" encoding="utf-8"?>
<settings>
	<uploadSettings>
		<usePreload>true</usePreload>
		<thumbnails>
			<cms>thumbnailSmall.jpg</cms>
			<preview>thumbnailBig.jpg</preview>
		</thumbnails>
		<dynamicItems>
			<Array>
			<Object>
				<ID>someInt</ID>
				<DataType>int</DataType>
				<Value>1</Value>
				<DisplayName>Some int</DisplayName>
			</Object>
			<Object>
				<ID>someString</ID>
				<DataType>string</DataType>
				<Value>none</Value>
				<DisplayName>Some string</DisplayName>
			</Object>
			<Object>
				<ID>someList</ID>
				<DataType>list</DataType>
				<Sources>
					<Value>Entry 1</Value>
					<Value>Entry 2</Value>
					<Value>Entry 3</Value>
				</Sources>
				<Value>Entry 2</Value>
				<DisplayName>Some list entry</DisplayName>
			</Object>
			<Object>
				<ID>someBoolean</ID>
				<DataType>boolean</DataType>
				<Value>true</Value>
				<DisplayName>Some boolean</DisplayName>
			</Object>
			<Object>
				<ID>someColor</ID>
				<DataType>color</DataType>
				<Value>0xFF0000</Value>
				<DisplayName>Some color</DisplayName>
			</Object>
			</Array>
		</dynamicItems>
	</uploadSettings>
</settings>

• settings > uploadSettings > usePreload
  Dieses Setting wird beim Upload ausgelesen und entscheidet, ob diese HTML-Applikation vorgeladen wird oder nicht.
  Hinweis

  Unterstützt der Player kein Vorladen, müssen die Animationen sofort gestartet werden.
• settings > uploadSettings > thumbnails > cms
  Definiert das 80 x 60 Pixel große Thumbnail, das in der IXM Plattform beim Spot angezeigt wird. Wird hier nichts angegeben, dann wird in der IXM Plattform das HMTL5 Default Thumbnail angezeigt.
• settings > uploadSettings > thumbnails > preview
   Definiert das Bild, das in der IXM Plattform in der Vorschau angezeigt wird. Wird hier nichts angegeben, dann wird in der Vorschau in der IXM Plattform nichts angezeigt.
• settings > uploadSettings > dynamicItems
   Hier können optional DynamicItems definiert werden die der Server bei Upload des gezippten Spots ausliest. Diese Eigenschaften werden auf dem Player als URL-Parameter übergeben und sollten daher nicht im Übermaß eingesetzt werden.