Create HTML Basic spots

HTML Basic spots are locally stored websites that can be integrated into the IXM Platform with limited configuration options. This article covers the structure, invocation, and configuration of HTML Basic spots in the Grassfish system, as well as tips for efficient development and troubleshooting.

File structure

When creating an HTML Basic spot, apply the following file structure:

• Main entry point: The HTML Basic spot must contain a file named index.html, which acts as the entry point for the website. Additionally, the website can contain subdirectories, which must be referenced relatively.

• File packaging: Before uploading to the IXM Platform, the HTML website should be zipped. The ZIP file must have the .html.zip extension. Once uploaded, the system will create a spot, which will be displayed with a thumbnail in the IXM Platform.

• ZIP file content: The ZIP file should include:

  • index.html

  • Optionally, subdirectories and other assets necessary for the site.

Upload to the IXM Platform

When your HTML Basic spot is ready, perform the following steps:

1. Compress the entire website including the index.html and any subdirectories into a ZIP file.

2. Ensure the file extension is .html.zip.

3. Upload the .html.zip file to the IXM Platform. Upon successful upload, the system creates a spot for the website with a default thumbnail.

Player file system and invocation

HTML Basic spots are invoked differently depending on the player (Windows, Linux, Android).

HTML Basic spot configuration

The array DynamicItems allows you to specify configuration settings for the spot. These settings help fine-tune the spot's behavior, appearance, and functionality, both during the upload process and when called on the player.

In the IXM Platform, you can specify these spot properties before adding the spot to the playlist. Once added to the playlist, these values are copied to the spot and can be adjusted for each playlist independently of the original spot.

Invocation on the player

When invoked on the player, the settings are passed to the spot as URL parameters, with all values being URL-encoded. It's important to keep this in mind when developing the spot.

The configuration feature is transferred as follows via the URL on the player:

…index.html?otherParams=otherValues&someBoolean=true

Sample configuration

With this sample code, the spot value true can be edited in the IXM Platform.

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

Example configuration of DynamicItems

Here’s a sample configuration of DynamicItems in the settings.xml file:

<?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>

Here is a breakdown of the key settings and their functionality:

Troubleshooting with log files

To troubleshoot or monitor the HTML Basic spot development process, log files provide useful information.

Windows Player log files

The Windows Player stores two types of log files:

• General log located at C:\GVClient\log\Player

• First screen log located at C:\GVClient\log\Player1

Linux Player log files

On the Linux Player, all spot files, including .html.zip, are located in the media directory on Linux players. After downloading, the files are unzipped into a subdirectory with the spot's name. Development files can be swapped directly in this directory, and pressing F5 on the player will restart the spot for preview.

General log located at /opt/grassfish/logs/gfPlayer

Tips

The following tips can help you develop Basic HTML spots efiiciently.

1. Distribute earlier versions of the spot to a test player via the IXM Platform.

2. Transfer the data via WinSCP to the Linux Player for real-time previewing of the spot.