Appboard/old/kiosk mode - Revision history

imported>Jason.nicholls: moved Kiosk Mode to appboard/old/kiosk mode

2014-07-17T18:09:21Z

moved Kiosk Mode to appboard/old/kiosk mode

← Older revision	Revision as of 18:09, 17 July 2014
(No difference)

imported>Jason.nicholls at 18:09, 17 July 2014

2014-07-17T18:09:06Z

← Older revision		Revision as of 18:09, 17 July 2014
Line 1:		Line 1:
			{{DISPLAYTITLE:Kiosk Mode}}
			[[Category:AppBoard old]]
	Kiosk Mode (also called Stack Auto-Rotation) is a customization supported by AppBoard for displaying multiple Stacks without any interaction from the end user. Some customers use AppBoard in an operations center, or in a kiosk display, to display information without the ability for the user to interact with the screen. In this case, it may be desirable to have AppBoard automatically cycle through multiple Stacks.		Kiosk Mode (also called Stack Auto-Rotation) is a customization supported by AppBoard for displaying multiple Stacks without any interaction from the end user. Some customers use AppBoard in an operations center, or in a kiosk display, to display information without the ability for the user to interact with the screen. In this case, it may be desirable to have AppBoard automatically cycle through multiple Stacks.

imported>David.moore at 14:04, 2 April 2014

2014-04-02T14:04:46Z

← Older revision		Revision as of 14:04, 2 April 2014
Line 21:		Line 21:
	#* List of Stacks to Rotate		#* List of Stacks to Rotate
	## Perform the following steps to identify the Stack IDs of the Stacks to include in the rotation:		## Perform the following steps to identify the Stack IDs of the Stacks to include in the rotation:
	### ~~Create a [[appboard/2.4/admin/backup_and_recovery\|Backup]]~~ to ~~update~~ the stacks~~.xml_<<i>date</i>>.completed~~ file.		### Stop and re-start AppBoard to ensure that all changes are saved to the stacks XML file
	### Open the most recently updated ~~version~~ of the ~~file(s)~~ in a text editor:		### Open the most recently updated of the following files in a text editor:
	###* [Install_Home]/server/webapps/enportal/WEB-INF/xmlroot/appboard/config/stacks.xml_<<i>date</i>>.completed		###* [Install_Home]/server/webapps/enportal/WEB-INF/xmlroot/appboard/config/stacks.xml_<<i>date</i>>.completed
	###* ~~(if it exists)~~ [Install_Home]/server/webapps/enportal/WEB-INF/xmlroot/appboard/config/stacks.xml		###* [Install_Home]/server/webapps/enportal/WEB-INF/xmlroot/appboard/config/stacks.xml
	### Search the file for the name of each Stack to include in the rotation. The line above the Stack Name will contain the Stack ID. The section with the Stack ID will look similar to the following:		### Search the file for the name of each Stack to include in the rotation. The line above the Stack Name will contain the Stack ID. The section with the Stack ID will look similar to the following:
	###* <obj className="appboard.config.Stack" id="<b>CFFA24B3-C9EF-07E1-0636-DF6972E931A7</b>">		###* <obj className="appboard.config.Stack" id="<b>CFFA24B3-C9EF-07E1-0636-DF6972E931A7</b>">

imported>David.moore: Undo revision 5567 by David.moore (Talk)

2014-04-02T13:51:46Z

Undo revision 5567 by David.moore (Talk)

← Older revision		Revision as of 13:51, 2 April 2014
Line 80:		Line 80:
	Perform the following steps to implement the kiosk.js file into the AppBoard system:		Perform the following steps to implement the kiosk.js file into the AppBoard system:

	# Locate the file [Install_Home]/server/webapps/enportal/ab/~~index~~.~~jsp~~		# Locate the file [Install_Home]/server/webapps/enportal/visualizer/Appboard_Viewer.html
	# ~~Copy~~ this file to ~~the directory [Install_Home]/server/webapps/enportal/visualizer/~~.		# Save a copy of this file and rename it to kiosk.html
	# Edit ~~the new copy of index~~.~~jsp~~, adding the following line just before the closing </head> tag:		# Edit kiosk.html, adding the following line just before the closing </head> tag:

	<script type="text/javascript" src="kiosk.js"></script>		<script type="text/javascript" src="kiosk.js"></script>


	== Invoking Kiosk Mode ==		== Invoking Kiosk Mode ==

imported>David.moore: Undo revision 5568 by David.moore (Talk)

2014-04-02T13:50:21Z

Undo revision 5568 by David.moore (Talk)

← Older revision		Revision as of 13:50, 2 April 2014
Line 90:		Line 90:
	Instruct your AppBoard users to replace their AppBoard URL with the following URL to run in Kiosk Mode:		Instruct your AppBoard users to replace their AppBoard URL with the following URL to run in Kiosk Mode:

	<nowiki>http://</nowiki><<i>hostname</i>>:<<i>port</i>>/enportal/visualizer/~~index~~.~~jsp~~		<nowiki>http://</nowiki><<i>hostname</i>>:<<i>port</i>>/enportal/visualizer/kiosk.html


	{{Tip\|The AppBoard login credentials can be passed in as part of the URL. You can create a shortcut that will launch AppBoard directly into Kiosk Mode by using a URL similar to the following: <nowiki>http://</nowiki><<i>hostname</i>>:<<i>port</i>><nowiki>/enportal/servlet/pd?login&userid=</nowiki><<i>username</i>><nowiki>&password=</nowiki><<i>password</i>><nowiki>&domainSelect=</nowiki><<i>domain</i>><nowiki>&redirect=%2Fenportal%2Fvisualizer%2F</nowiki>~~index~~.~~jsp~~}}		{{Tip\|The AppBoard login credentials can be passed in as part of the URL. You can create a shortcut that will launch AppBoard directly into Kiosk Mode by using a URL similar to the following: <nowiki>http://</nowiki><<i>hostname</i>>:<<i>port</i>><nowiki>/enportal/servlet/pd?login&userid=</nowiki><<i>username</i>><nowiki>&password=</nowiki><<i>password</i>><nowiki>&domainSelect=</nowiki><<i>domain</i>><nowiki>&redirect=%2Fenportal%2Fvisualizer%2F</nowiki>kiosk.html}}

imported>David.moore: /* Creating and Customizing the Javascript File */

2014-03-07T18:59:42Z

Creating and Customizing the Javascript File

← Older revision		Revision as of 18:59, 7 March 2014
Line 25:		Line 25:
	###* [Install_Home]/server/webapps/enportal/WEB-INF/xmlroot/appboard/config/stacks.xml_<<i>date</i>>.completed		###* [Install_Home]/server/webapps/enportal/WEB-INF/xmlroot/appboard/config/stacks.xml_<<i>date</i>>.completed
	###* (if it exists) [Install_Home]/server/webapps/enportal/WEB-INF/xmlroot/appboard/config/stacks.xml		###* (if it exists) [Install_Home]/server/webapps/enportal/WEB-INF/xmlroot/appboard/config/stacks.xml
	### Search the file for the name of each Stack to include in the rotation. The line above the Stack Name will contain the ~~StackID~~. The section with the Stack ID will look similar to the following:		### Search the file for the name of each Stack to include in the rotation. The line above the Stack Name will contain the Stack ID. The section with the Stack ID will look similar to the following:
	###* <obj className="appboard.config.Stack" id="<b>CFFA24B3-C9EF-07E1-0636-DF6972E931A7</b>">		###* <obj className="appboard.config.Stack" id="<b>CFFA24B3-C9EF-07E1-0636-DF6972E931A7</b>">
	###* <attribute name="title" value="<<i>StackName</i>>">		###* <attribute name="title" value="<<i>StackName</i>>">
	## Locate the <b>var stacks = [</b> section		## Locate the <b>var stacks = [</b> section
	## Replace the sample ~~StackIDs~~ by copying and pasting the ~~StackIDs~~ you located above for each Stack that you want to include in the rotation		## Replace the sample Stack IDs by copying and pasting the Stack IDs you located above for each Stack that you want to include in the rotation

	{{Note\|In use only stacks assigned to the specific role of the logged in user will be shown. Stacks not provisioned will be skipped over.}}		{{Note\|In use only stacks assigned to the specific role of the logged in user will be shown. Stacks not provisioned will be skipped over.}}

imported>David.moore: /* Summary of Solution */

2014-03-07T18:55:05Z

Summary of Solution

← Older revision		Revision as of 18:55, 7 March 2014
Line 7:		Line 7:
	== Summary of Solution ==		== Summary of Solution ==

	The solution detailed on this page places a Javascript file on the AppBoard server that augments the stock AppBoard Viewer code by including reference to a Javascript file. This Javascript file tells AppBoard to auto-rotate between a defined list of Stacks at a defined timing interval. The end user can then reference either the standard URL to use AppBoard normally, or s a special URL to use AppBoard in Kiosk Mode.		The solution detailed on this page places a Javascript file on the AppBoard server that augments the stock AppBoard Viewer code by including a reference to a Javascript file. This Javascript file tells AppBoard to auto-rotate between a defined list of Stacks at a defined timing interval. The end user can then reference either the standard URL to use AppBoard normally, or a special URL to use AppBoard in Kiosk Mode.


	== Creating and Customizing the Javascript File ==		== Creating and Customizing the Javascript File ==

imported>David.moore: /* Creating and Customizing the Javascript File */

2014-03-07T18:30:08Z

Creating and Customizing the Javascript File

← Older revision		Revision as of 18:30, 7 March 2014
Line 23:		Line 23:
	## Perform the following steps to identify the Stack IDs of the Stacks to include in the rotation:		## Perform the following steps to identify the Stack IDs of the Stacks to include in the rotation:
	### Create a [[appboard/2.4/admin/backup_and_recovery\|Backup]] to update the stacks.xml_<<i>date</i>>.completed file.		### Create a [[appboard/2.4/admin/backup_and_recovery\|Backup]] to update the stacks.xml_<<i>date</i>>.completed file.
	### Open the most recently updated version of the file in a text editor:		### Open the most recently updated version of the file(s) in a text editor:
	###* [Install_Home]/server/webapps/enportal/WEB-INF/xmlroot/appboard/config/stacks.xml_<<i>date</i>>.completed		###* [Install_Home]/server/webapps/enportal/WEB-INF/xmlroot/appboard/config/stacks.xml_<<i>date</i>>.completed
			###* (if it exists) [Install_Home]/server/webapps/enportal/WEB-INF/xmlroot/appboard/config/stacks.xml
	### Search the file for the name of each Stack to include in the rotation. The line above the Stack Name will contain the StackID. The section with the Stack ID will look similar to the following:		### Search the file for the name of each Stack to include in the rotation. The line above the Stack Name will contain the StackID. The section with the Stack ID will look similar to the following:
	###* <obj className="appboard.config.Stack" id="<b>CFFA24B3-C9EF-07E1-0636-DF6972E931A7</b>">		###* <obj className="appboard.config.Stack" id="<b>CFFA24B3-C9EF-07E1-0636-DF6972E931A7</b>">

imported>David.moore: /* Javascript Code */

2014-03-07T17:50:25Z

Javascript Code

← Older revision		Revision as of 17:50, 7 March 2014
Line 39:		Line 39:

	var stacks_control = "Button"; // Button or Tab		var stacks_control = "Button"; // Button or Tab
	var rotate_delay = 30000; // in ~~millisecons~~		var rotate_delay = 30000; // in milliseconds

	// update the list below with Stack IDs relevant to your installation		// update the list below with Stack IDs relevant to your installation

imported>David.moore: /* Invoking Kiosk Mode */

2014-03-07T17:49:26Z

Invoking Kiosk Mode

← Older revision		Revision as of 17:49, 7 March 2014
Line 90:		Line 90:
	Instruct your AppBoard users to replace their AppBoard URL with the following URL to run in Kiosk Mode:		Instruct your AppBoard users to replace their AppBoard URL with the following URL to run in Kiosk Mode:

	<nowiki>http://</nowiki><<i>hostname</i>>:<<i>port</i>>/enportal/visualizer/~~kiosk~~.~~html~~		<nowiki>http://</nowiki><<i>hostname</i>>:<<i>port</i>>/enportal/visualizer/index.jsp


	{{Tip\|The AppBoard login credentials can be passed in as part of the URL. You can create a shortcut that will launch AppBoard directly into Kiosk Mode by using a URL similar to the following: <nowiki>http://</nowiki><<i>hostname</i>>:<<i>port</i>><nowiki>/enportal/servlet/pd?login&userid=</nowiki><<i>username</i>><nowiki>&password=</nowiki><<i>password</i>><nowiki>&domainSelect=</nowiki><<i>domain</i>><nowiki>&redirect=%2Fenportal%2Fvisualizer%2F</nowiki>~~kiosk~~.~~html~~}}		{{Tip\|The AppBoard login credentials can be passed in as part of the URL. You can create a shortcut that will launch AppBoard directly into Kiosk Mode by using a URL similar to the following: <nowiki>http://</nowiki><<i>hostname</i>>:<<i>port</i>><nowiki>/enportal/servlet/pd?login&userid=</nowiki><<i>username</i>><nowiki>&password=</nowiki><<i>password</i>><nowiki>&domainSelect=</nowiki><<i>domain</i>><nowiki>&redirect=%2Fenportal%2Fvisualizer%2F</nowiki>index.jsp}}