Object model Scripts for kiosks - PROVISIO

Company Christmas Holidays

North American Headquarters in Miami, USA: Dec 25, 2015, Jan 1st 2016
European Headquarters in Muenster, Germany: Dec 21, 2015 until Jan 03rd 2016
Limited support is available during this period.
We at PROVISIO wish you Merry Christmas and a Happy New Year!

Partners Logged in as: My Account

|

+1 (305) 974-1952

+49 251 8469240

|

English (US)

Reboot Windows after Logout

Reboot Windows after Logout

It is possible to reboot Windows after logging out of SiteKiosk:
Create a subfolder called Logout in the directory ..\SiteKiosk\HTML and download the prepared HTML file in that folder (if the folder already exists overwrite the original file). In the SiteKiosk Configuration tool, select the checkbox 'Activate Logout Navigation' in the Logout section.
This will set up the terminal so that when the user clicks the Logout button of SiteKiosk, SiteKiosk shuts down and Windows will reboot.

System requirements :

SiteKiosk 5.00

Logfile Upload by E-Mail for SiteKiosk 6

Logfile Upload by E-Mail for SiteKiosk 6

This script allows you to upload log files in SiteKiosk 6 to an e-mail address. Please read the included “readme” for further details.

System requirements :

SiteKiosk 6.0

Windows Logout

Windows Logout

This script quits SiteKiosk and logs off the current user. After that, the logon screen of windows is displayed.

 <a href='#' onClick= 'doLogout()'>Log Out of Windows</a>

 function doLogout() { SiteKiosk.LogoffWindows(); }

System requirements :

SiteKiosk 5.00

Reboot/Shutdown at Different Times

Reboot/Shutdown at Different Times

Since version 6.2 this feature is available in the configuration tool by default.
The SiteKiosk Object Model enables you to reboot or shutdown your terminal at different times. You could have a different time for each day of the week.
Do the following for that:
Click the download link and save the file. Open the configuration wizard and go to Browser Design > Advanced > Execute Scriptfile and add the downloaded scriptfile.
To adjust the times open the downloaded scriptfile shutdownscheduler.js with an editor. Add the desired time for each day of the week, e.g. for 7pm monday:

 sWeekDays[1] = "19:00"; bWeekReboot[1] = false;

Save the changes. SiteKiosk will follow the rules of the script.

System requirements :

SiteKiosk 5.00

Show HTML dialogs

Show HTML dialogs

This script shows how to create HTML dialogs. The appearance can be altered by the web developer.

In this extract a dialog is displayed:

function showdialog() 
{ 
mydialog = SiteKiosk.SiteKioskUI.CreateHTMLDialog(); 
mydialog.Border = true; 
mydialog.ScrollBars = true; 
mydialog.Sysmenu = true; 
mydialog.Title = true; 
mydialog.URL = "http://www.lycos.com/"; 
mydialog.Width = 400; 
mydialog.Height = 300; 
mydialog.ShowDialog(); 
}

System requirements :

SiteKiosk 5.00

Windows Logout after SiteKiosk Logout

Windows Logout after SiteKiosk Logout

It is possible to call the Windows logon dialog after a SiteKiosk logout.
Just download the prepared html file and create a subfolder called Logout in ..\SiteKiosk\HTML and copy the file there. If the folder already exists overwrite the original file. Now go to the SiteKiosk configuration and activate the checkbox 'Activate Logout Navigation' in the Logout section.
If now someone clicks the Logout button of SiteKiosk SiteKiosk shuts down and the logon dialog of Windows will be called.

System requirements :

SiteKiosk 5.00

Create Receipt

Create Receipt

This downloadable script is an example of how to print a receipt for the Payment Module and/or send it by e-mail. The script can be altered to your own specific needs.

System requirements :

SiteKiosk 5.00

Content Filter plug-in

Content Filter plug-in

In this example, the filter of the Content Filter plug-in can be activated and deactivated. For testing purpose, a link to a forbidden URL can be clicked.

 
function switchCoachFilter() 
{ 
SiteKiosk.Plugins("SiteCoach").FilterState = !SiteKiosk.Plugins("SiteCoach").FilterState; 
}

System requirements :

SiteKiosk 5.00

Show plug-ins

Show plug-ins

This example shows how to determine the activity status of the plug-ins.

for (var i = 1; i <= SiteKiosk.Plugins.Count; ++i)
 { 
if (SiteKiosk.Plugins.Item(i).Enabled) 
pactstatus = "Activated"; 
else 
pactstatus = "Deactivated"; 
if (i != 1) 
document.writeln(""); 
document.write(SiteKiosk.Plugins.Item(i).Name + ": " + pactstatus); 
}

System requirements :

SiteKiosk 5.00

Browser buttons

Browser buttons

This script displays small buttons with the same functionality as the browser buttons.

For example, this extract causes a navigation to the start page:

 function navHome() { SiteKioskWebBrowser.GoHome(); }

System requirements :

SiteKiosk 5.00

Show available languages

Show available languages

This example shows all languages provided by the current skin. Click a link to change the language.

This extract shows how a list of available languages can be created:

 
function getSkinLanguages() 
{ 
var myarray = new Array(); 
lang = SiteKioskWebBrowser.SiteKioskWindow.SkinLanguages;   
for (var i = 1; i <= lang.Count; ++i) 
{ 
myarray.push(lang.Item(i).Name); 
} 
alert(myarray); 
}

System requirements :

SiteKiosk 5.00

Webcam plug-in

Webcam plug-in

This example shows how to record videos or take pictures using a webcam, the Webcam ActiveX Control and the Webcam plug-in.

The following extract integrates the ActiveX Control:

 <object id='webcam' classid= 'clsid:54632F4A-055A-44C1-B1E6-EDB62AC2AC3E' border='0' width='320' height='240' style='margin:5px;'> </object>

For example, this part starts recording:

 function startCapture() { webcam.Capture(); }

System requirements :

SiteKiosk 5.00

Determine the SiteKiosk version

Determine the SiteKiosk version

This example shows how to determine the version of SiteKiosk.

 
function getVersion() 
{ 
var build = SiteKiosk.Version.BuildNumber; 
var major = SiteKiosk.Version.MajorVersion;
var minor = SiteKiosk.Version.MinorVersion;
var date = SiteKiosk.Version.BuildDateTime;
}

System requirements :

SiteKiosk 5.00

Multilanguage start page

Multilanguage start page

This is a small script which calls different start pages depending on the chosen language in SiteKiosk.
The configuration is simple, just define the languages and their start page like this

 StartPage[7] = "indexde.html";

which would call 'indexde.html' if language '7' (German) has been chosen.
To add a new language just define the language id and the start page:

 StartPage[12] = "http://www.google.fr/"; // French

System requirements :

SiteKiosk 5.00

Shutdown the computer

Shutdown the computer

This downloadable HTML file contains a link that will shut down the computer.
Just open this file with the SiteKiosk browser. Do not forget to allow this page explicitly in the SiteKiosk configuration under 'Access->URLs with script permission'.

System requirements :

SiteKiosk 5.00

Automatically start a program

Automatically start a program

To automatically start a program when starting SiteKiosk change the file ..\SiteKiosk\skins\default\MainWnd.htm with an editor (e.g. Notepad):

 <body onload="OnSkinLoaded();runProgs();">

instead of

 <body onload="OnSkinLoaded()">

Then add this to a Javascript part:

 function runProgs() { SiteKiosk.ExternalApps .Run("c:/your_program.exe", false); }

System requirements :

SiteKiosk 5.00

Print selected frame

Print selected frame

SiteKiosk prints the greatest frame by default. This example shows how to print a selected frame.
Please note that the ActiveX settings in the security options of Internet Explorer should be set to low in order for this example to work properly. This, however, creates a potential security risk to the system.
You also have to edit the UnsafeActiveXCtrls.xml file located in the XML subfolder of the SiteKiosk directory, and removing the clsid from the WebBrowser control.

System requirements :

SiteKiosk 5.00

Recall startpage

Recall startpage

Please unzip the file and store the file "recall_startpage.js" to the folder..\Program Files\SiteKiosk\Html\..

After that, you have to open the SiteKiosk configuration and go to
-->Browser-->Browser Design-->Advanced

Activate the option "SiteKiosk will execute the following script file on startup" and insert the file recall_startpage.js including the path.

The script recalls the SiteKiosk start page once after ten seconds.
You can adjust time span by editing the corresponding value “(10000, RecallStartpage)”.

Delay scheduled shutdown if credit is available

Delay scheduled shutdown if credit is available

Save the .js file from the zip archive for example to ..\SiteKiosk\html. Then add it as an external script to SiteKiosk (Configuration -> Browser Design -> Advanced -> Run Script File). At a defineable point in time the script checks the available credit in SiteKiosk, therefore validating if a user is currently logged in. If there is credit available the script will check again after an equally defineable period of time. If there is no credit available the computer will shutdown.

To change the starting time or to change the interval open the file with an editor and

var gi_hour = 0; //values from 0 to 23 
var gi_min = 0; //values from 0 to 59 
var gi_sec = 0; //values from 0 to 59

alter these lines for the starting time, and

 
var gi_interval = 120000; //values in milliseconds, default 120000 = 2 minutes

this line to change the length of the interval.

System requirements :

SiteKiosk 6.2

Require Minimum Inpayment

Require Minimum Inpayment

By using this script you can require a user to make a specified minimum inpayment before he or she can use the terminal.

System requirements :

SiteKiosk 6.0

SiteKiosk SmartCard Script

SiteKiosk SmartCard Script

This zip archive contains script examples to read/write a number of different data sets using the SiteKiosk SmartCard solution. It showcases the potential of the smartcards as they are not limited to storing credit balance only but can carry a great number of information. Please see the readme included in the archive for further information.

System requirements :

SiteKiosk 6.0

Script used to time control the deactivation of all payment devices

Script used to time control the deactivation of all payment devices

Since it is fairly simple, the configuration can be modified directly in the file using an editor, which also contains all necessary information.

After configuring it, copy the file DisablePaymentDevices.js to a folder on each terminal that does not provide write access to the SiteKiosk user (e.g. "../SiteKiosk/Html/").

You will then be able to implement the script for the corresponding terminal using the SiteKiosk configuration file:

SiteKiosk configuration --> Browser --> Browser design --> Advanced --> Execute script file when SiteKiosk is launched

You can then simply enter the path to the script (DisablePaymentDevices.js).
By doing so, you are implementing the script into the browser design.

System requirements :

SiteKiosk 6.2

Form used to create SiteCafe user accounts

Form used to create SiteCafe user accounts

You can host the following website on your web server to prevent the files from being accessed by other users. However, this will not always be necessary, as we also implemented SiteCafe administrator or service staff authentication. What this means is that only service staff will be able to open the form from within SiteKiosk.
We recommend saving the attached functions.js and index.html files locally on each terminal on which you want to make it possible to create new users. All you have to keep in mind is not to grant the users any write access to the files.
Note that when using this form you should not use the SiteCafe Manager user interface at the same time.

Installation

On the client end:
Copy the index.html and functions.js files to the "..\SiteKiosk\Html\" directory because this folder already has scripting permissions.

Or:
Copy the index.html and functions.js files to a directory of your choice and grant scripting permissions in the SiteKiosk configuration file under "Access".

On the server end (SiteCafe):
Copy the codestationserver.js file to the "..\SiteCafe\Html" directory.
You will now have to stop the SiteCafeService Windows Service. To do so, you will have to close the SiteCafe management application if it is still running.
Now, click on Start -> Run -> enter services.msc (Win2000/XP only) and press the Enter key.
Open Windows Services and find and right-click SiteCafeService. Select Stop from the context menu.
Proceed by opening the file "..\SiteCafe\config\SiteCafeServer.config" in an editor (e.g. the Windows accessory Notepad). Look for the line:

 <scripts/>

Change the entry as follows:

 <scripts>   <script>html\codestationserver.js</script> </scripts>

Save the file and relaunch the SiteCafeService Windows Service by right-clicking the corresponding entry in the Windows Service management application.

System requirements :

SiteKiosk 6.2

Call functions automatically at different times

Call functions automatically at different times

Using this script you can define functions that will be called automatically at a specified day and time.

There are two modes:
1) Define functions that will be called at a specified time every day
2) Define different functions for every day of the year

Click the download link and save the script. Open the configuration wizard and register the file under "Display -> Browserdesign -> Advanced -> Execute scriptfile".
Open the file and specify the days, times and functions. You will find more help in the file.

For example, if you want your terminal to navigate to an address every day at 3:00pm and 6:30pm:

 
everydaymode = true; 
sEveryDay[15][00] = "navigate('http://www.adresse.de')"; 
sEveryDay[18][30] = "navigate('http://www.adresse.de')";

Or, if you want your terminal to navigate to an address only on June 23th at 3:00pm and 6:30pm:

 
everydaymode = false;
 sWeekDays[23][06][15][00] = "navigate('http://www.adresse.de/')"; 
sWeekDays[23][06][18][30] = "navigate('http://www.adresse.de/')";

Save the changes and start SiteKiosk.

System requirements :

SiteKiosk 5.00

Combined examples

Combined examples

This is a combination of some examples:

- Show / hide the touch screen keyboard
- Determine the SiteKiosk version
- Webcam plug-in
- Show available languages
- Browser buttons
- Show plug-ins
- Content Filter plug-in
- Show HTML dialogs
- Logile
- Send e-mails
- Scheduled tasks
- Slide effect
- External applications
- Reset and logout
- Quit SiteKiosk

Release date :	8/25/2004 12:00:00 AM

System requirements :	SiteKiosk 5.5

Show / hide the touch screen keyboard

Show / hide the touch screen keyboard

In this example, the touch screen keyboard can be pulled in, pulled out, shown or hidden.

This extract switches the visibility:

function showHide() 
{ 
if (SiteKiosk.Keyboard.Initialized) 
SiteKiosk.Keyboard.Visible = !SiteKiosk.Keyboard.Visible; 
}

Release date :	7/18/2003 12:00:00 AM

System requirements :	SiteKiosk 5.00

Quit SiteKiosk

Quit SiteKiosk

There are different functions to quit SiteKiosk, shutdown or restart the computer or to logout the windows user. They are used in this example.

 
function quitSiteKiosk() 
{ 
SiteKiosk.Quit(); 
} 
function shutdownWindows() 
{ 
SiteKiosk.ShutdownWindows(); 
} 
function rebootWindows() 
{ 
SiteKiosk.RebootWindows(); 
} 
function logoutWindowsUser() 
{ 
SiteKiosk.LogoffWindows(); 
}

Release date :	7/17/2003 12:00:00 AM

System requirements :	SiteKiosk 5.00

Reset and logout

Reset and logout

This script shows how to reset SiteKiosk and discard changes made by the user.

 
function resetSiteKiosk() 
{ 
SiteKiosk.Reset(); 
} 
function logoutSiteKiosk() 
{ 
SiteKiosk.Logout(); 
}

Release date :	7/17/2003 12:00:00 AM

System requirements :	SiteKiosk 5.00

External applications

External applications

This example lists all programs that have been configured in the SiteKiosk configuration. A click starts the program.

In this extract, a list of all external applications is created:

 function listExtApps() 
{ 
var myarray = new Array(); 
for (var i = 1; i <= SiteKiosk.ExternalApps.Count; ++i) 
{ 
if (SiteKiosk.ExternalApps .Item(i).DisplayText == "") 
eaappname = "No description available"; 
else eaappname = SiteKiosk.ExternalApps.Item(i).DisplayText; 
myarray.push(eaappname); 
} 
alert(myarray); 
}

System requirements :

SiteKiosk 5.00

Slide effect

Slide effect

This example uses the slide effect to move the SiteKiosk logo from one place to another.

A slide effect object can be created as follows:

 
function createSlide() 
{ 
myslide = SiteKiosk.Effects.CreateSmoothSlide(); 
myslide.StartPos = 0; 
myslide.EndPos = 480; 
myslide.Rate = 100; 
myslide.Duration = 2000; 
myslide.OnUpdatePosition = OnUpdatePosition; 
myslide.OnStart = OnStart; 
myslide.OnStop = OnStop; 
}

System requirements :

SiteKiosk 5.00

Scheduled tasks

Scheduled tasks

This example shows how to use the scheduler. When the defined period of time elapsed, the defined function will be called.

 function quitSiteKiosk() 
{ 
SiteKiosk.Quit(); 
}
myid=SiteKiosk.Scheduler.AddDelayedEvent(5000,quitSiteKiosk); // 5 seconds

System requirements :

SiteKiosk 5.00

Send E-Mails

Send E-Mails

Using this example, you can send E-Mails through your own mail account.

 function sendMail() 
{ 
mymail = SiteKiosk.Email.CreateJob(0); 
mymail.POPServer = "pop.myserver.com"; 
mymail.POPPort = 110;
mymail.Username = "myusername"; 
mymail.Password = "mypassword"; 
mymail.SMTPServer = "mail.myserver.com"; 
mymail.SMTPPort = 25; 
mymail.Authentication = 2; // pop before smtp 
mymail.SetSender ("sender@server.com", "Sender name"); 
mymail.AddRecipient("recipient@server.com"); 
mymail.Subject = "subject"; 
mymail.PlainBody = "This is the content."; 
mymail.Send(0, false, true); 
}

System requirements :

SiteKiosk 5.00

Logfile

Logfile

This example lists all logfile entries that are created at runtime. Your own entries can also be created.

This function creates a logfile entry with a specified message:

 function createLogEntry(msg) { SiteKiosk.Logfile.Notification(msg); }

System requirements :

SiteKiosk 5.5

Automatic printout of a webpage

Automatic printout of a webpage

If you add the following script example to the code of your webpage it will be printed automatically by accessing it.

It works without any user interaction if you configure SiteKiosk with “Print webpage as laid out on screen (without user interaction)” or “Automatically Print Largest Frame (without user interaction)” at -->Management-->Print.

If you use the printer monitoring of SiteKiosk you also have to deactivate “User must confirm print jobs“ in the advanced settings of the printer monitoring.

window.external.InitScriptInterface();
function PrintExtWindow()
{
	if (gk_Window.SiteKioskWebBrowser.WebBrowser.ReadyState == 4)
	{
		gk_Window.SiteKioskWebBrowser.Print();
		gk_Window.Close();
		window.clearInterval(gi_Interval);
	}
}
var gk_Window = SiteKiosk.SiteKioskUI.CreateBrowserWindow();
gk_Window.SiteKioskWebBrowser.Navigate("your_webpage");
gk_Window.Move(0, 0, 0, 0);
window.setTimeout("gk_Window.Hide();", 1);
var gi_Interval = window.setInterval("PrintExtWindow();", 100);

Please consider that you have to give script permission to the URL resp. path of the html page you are using this script.

Logfile Upload by FTP for SiteKiosk 6

Logfile Upload by FTP for SiteKiosk 6

This script allows you to upload log files in SiteKiosk 6 to an ftp server.
Please read the included “readme” for further details.

System requirements :

SiteKiosk 6.0

Parse credit card data to a webpage

Parse credit card data to a webpage

This script example shows how credit card data can be parsed to a webpage after a card has been swiped through a reader running under SiteKiosk. For further information please open the Javascript file from the zip archive with an editor and read the readme section.

System requirements :

SiteKiosk 5.00

Edit the DOM of a webpage

Edit the DOM of a webpage

This examples illustrates how to change the Document Object Model of a webpage displayed in the SiteKiosk browser. This enables you to edit webpages for use on a SiteKiosk terminal without editing the source code of that page. For further information please open the Javascript file from the zip archive with an editor and read the readme section.

System requirements :

SiteKiosk 5.00

Print selected webpages

Print selected webpages

This script examples shows you how to restrict printing to certain pages. For further information please open the Javascript file from the zip archive with an editor and read the readme section.

System requirements :

SiteKiosk 5.00

Dynamically change the content of a second monitor

Dynamically change the content of a second monitor

This script examples shows you how to dynamically change the content of a second monitor by events taking place on the main monitor.

System requirements :

SiteKiosk 7.0

Edit the SiteKiosk configuration

Edit the SiteKiosk configuration

Example to directly edit the SiteKiosk configuration, e.g. by using SiteRemote script jobs.

System requirements :

SiteKiosk 7.0

Control Electrical Power

Control Electrical Power

This script examples shows you how to control the power output of a Power Distribution Unit from within SiteKiosk. Use this script to power on electrical devices after a payment for usage has been made.

System requirements :

SiteKiosk 7.0

Create local Webcam video/photo copies

Create local Webcam video/photo copies

This script creates local copies of videos/photos recorded with Webcam. Please see the included readme for installation instructions.

System requirements :

SiteKiosk 7.0

Change the volume on the SiteKiosk terminal using SiteRemote

Change the volume on the SiteKiosk terminal using SiteRemote

With this script you can change the volume on a SiteKiosk terminal through SiteRemote. The details for using the script can be found in the included "ReadMe.txt" file.

System requirements :

SiteKiosk 8.x