Docstoc

Kiosk Pro iPad Kiosk Apps Plus_ Pro _ Lite

Document Sample
Kiosk Pro iPad Kiosk Apps Plus_ Pro _ Lite Powered By Docstoc
					                                                                                                                Kiosk Group, Inc.




Overview ......................................................................................................................... 3

Requirements .................................................................................................................. 3

Media & Content for your Kiosk ....................................................................................... 4

Features: Lite, Pro & Plus ............................................................................................... 5

Getting Started ................................................................................................................ 6

Editing Kiosk Pro Settings ............................................................................................... 6

Unique iPad ID ................................................................................................................ 7

Home Page ..................................................................................................................... 7

Allowed Domains (use ; as separator)............................................................................. 8

Idle Time Limit ................................................................................................................. 9

Show Top Information Bar ............................................................................................. 10

Show Address Bar......................................................................................................... 10

Show Bottom Navigation Bar ........................................................................................ 11

Disable Zooming ........................................................................................................... 11

Printing .......................................................................................................................... 12

On-Screen Progress Indicator ....................................................................................... 13

Digital Sign Mode .......................................................................................................... 14

Clearing Cache and Cookies ......................................................................................... 15

Browsing Time Limit ...................................................................................................... 16

Good-Bye Page ............................................................................................................. 17

Show Off-Domain Dialog ............................................................................................... 18

Text for Off-Domain Dialog ............................................................................................ 18

Email on Power Supply Change .................................................................................... 19

                                                                                                                                  1
                                                                                                            Kiosk Group, Inc.



SMTP Server Settings ................................................................................................... 20

Remote Settings Control ............................................................................................... 21

Local Mode.................................................................................................................... 23

Remote Update of Local Files ....................................................................................... 26

Remote Monitoring ........................................................................................................ 28

Night Mode .................................................................................................................... 29

Custom Navigation Links............................................................................................... 30

AutoPlay Audio & Video Files ........................................................................................ 31

Calling the Unique iPad ID with JavaScript ................................................................... 32

Saving User Data with JavaScript ................................................................................. 32

Signature Capture ......................................................................................................... 33

Photo & Video Capture.................................................................................................. 34




                                                                                                                              2
                                                                                          Kiosk Group, Inc.




Turn your iPad into a professional kiosk! You just need Kiosk Pro, an enclosure that covers the home
button and your HTML pages.

Kiosk Pro is based on Apple‟s UI WebView browser and is designed to present your web-friendly content
and media as a customized kiosk app. Kiosk Pro is highly configurable and allows you to customize how
your web content is presented on the iPad.

Kiosk Pro is available in three versions:

       Kiosk Pro Lite - an introductory version of Kiosk Pro, available free of charge
       Kiosk Pro - our standard version of Kiosk Pro including support for local files on the iPad
       Kiosk Pro Plus - a premium version of Kiosk Pro for advanced users interested in customization
        and additional features

The different features and capabilities of each app in the Kiosk Pro series can be explored on the
Features page of our website at www.kioskproapp.com/features.html




Getting started is simple. Let‟s begin with what is required to use our app.

       Web-friendly content (see Media & Content for your Kiosk on the next page)
       Apple iPad running iOS 3.2 or later (iOS 5.0 recommended)
       A computer with iTunes Version 10.1 or later (required for transferring local files to iPad)
       An iPad enclosure (currently available at www.ipadkiosks.com) is highly recommended to secure
        your iPad and cover the Home Button (see Keeping Users Within Kiosk Pro on the next page).


Note: In this document, the term “Owner” will refer to you, the person setting up the kiosk application and
“User” will refer to the public individual(s) who will use your app.




                                                                                                         3
                                                                                         Kiosk Group, Inc.




Due to software restrictions by Apple, apps (including Kiosk Pro) are unable to restrict access to the
home button. To prevent your users from exiting Kiosk Pro (and your content), the iPad's home button
must be physically covered.


In iOS 5, new support for multitasking gestures allows users to exit or browse between apps with touch
gestures on the screen. To limit your users to Kiosk Pro, you must disable these gestures under
'Settings' > 'General'> 'Multitasking Gestures': Off.


If you are using Kiosk Pro in an unsupervised setting, we also recommend removing any unnecessary
apps and using the 'Restrictions' menu to put a passcode lock on most apps and settings, including
purchases through the App Store, in case Kiosk Pro is exited by the system or your users find a way to
access the home button.




Kiosk Pro is based on Apple‟s UI WebView browser, operating similarly to Safari for iPad. As such, Kiosk
Pro is designed to present web-friendly content and media as a customized kiosk app. For optimal
performance, your content should be coded as web pages using HTML, CSS, and JavaScript.

Kiosk Pro supports viewing of:

       .html webpage files
       embedded .mp4 videos
       modal pop-up windows
       .pdf files *
       Microsoft Office (97 or newer) files, including PowerPoint, Excel, Word *
       certain Keynote files *

* Note: If you are considering these formats, we highly recommend finding a sample file to view in Kiosk
Pro or Lite before spending time in development. While Kiosk Pro is able to show these files, they are not
optimized in the same way as a traditional web page. We recommend viewing these files with the Disable
Zoom setting turned off. For more information about Apple UI WebView's support of and specific
requirements for these files, please click here.

Kiosk Pro is unable to support:

       standard child pop-up windows (including browser error messages caused by your page)
       Flash content
       user-writable .pdf forms
       multiple windows




                                                                                                         4
Kiosk Group, Inc.




              5
                                                                                        Kiosk Group, Inc.




All three versions of Kiosk Pro are available through iTunes and can be downloaded via your computer
and synced to your iPad or can be installed directly through the App Store icon on your iPad.

When running any version of Kiosk Pro for the first time (without changing the default settings) you will
be directed to our demo web page, which can also be accessed by clicking here. Our demos provide just
a few code examples of what you can do with our application, including screensavers, digital signs, and
interactive content.




After you check out our demos, change the default home page to your home page. To find the settings
page, touch the Settings button (usually located on the iPad‟s home screen). Then scroll down the left
sidebar to find Kiosk Pro Plus, Kiosk Pro or Kiosk Pro Lite listed under the Apps column and touch to
select it.




You will see all the available settings your version of Kiosk Pro has to offer on the right side of the
screen. Kiosk Pro Lite provides the basics tools needed to turn your webpage into a kiosk app, while
Kiosk Pro and Kiosk Pro Plus provide more advanced features and opportunities for customizing your
app.



                                                                                                       6
                                                                                            Kiosk Group, Inc.




This feature is only available for Kiosk Pro and Kiosk Pro Plus.




If you are using any of Kiosk Pro‟s remote functions, such as the Email on Power Supply Change feature
discussed later in this guide, you can give your kiosk a unique identifier (ID) which will help you
distinguish which iPad is sending you messages or data.

This feature is helpful if you have multiple kiosks in different locations. For instance say you have an iPad
ID labeled Lobby and another iPad labeled Second Floor; if power is lost to one iPad, the email sent out
will contain the unique iPad ID, indicating which iPad is in trouble. Note: If connection to the internet is
disabled or unavailable, no messages will be sent.

The unique iPad ID can also be accessed via JavaScript, see Calling the Unique iPad ID with JavaScript
(on page 32) for more details.




This is the most important setting you will enter, displaying the given URL in the content window.




URL Format Examples:

       http://www.example.com/index.html
       https://www.example.com
       www.example.com

Local File Format Examples:
(This feature is only available in the Plus and Pro versions using files stored locally on your iPad and is
discussed in more depth later in this manual.)

       index.html
       example.pdf




                                                                                                              7
                                                                                             Kiosk Group, Inc.




In many kiosk scenarios you may want to require users to stay within certain Internet domains. Using the
allowed domains list will allow you to specify which domains the user is able to visit while using your
kiosk.




When using multiple domains under the white list, use a semi-colon to separate the domains.

        Example: kioskproapp.com; ipadkiosks.com

Using these parameters will tell the app that these are the only domains a user is allowed to visit. If a
kiosk is using the list above and a user tries to visit google.com, they will be denied.

If the allowed domains list is left blank, no restrictions will be placed on the browser and the user will be
able to view any website they choose.

It is not necessary in allowed domains to prefix the domain name with http:// or www. Kiosk Pro is only
interested in the domain name itself.

URL Format Examples:

       example.com in the allowed domain list would allow access to
              o http://www.example.com
              o http://www.example.com/index.html (or any other page or folder following /)
              o https://www.example.com
              o http://example.com
              o http://mobile.example.com
       It is also possible to limit Kiosk Pro to specific prefix sub domains, so mobile.example.com in the
        allowed domain list would allow access to
              o http://mobile.example.com
              o BUT NOT http://www.example.com or http://example.com

It is not possible to limit users to only certain pages or folders within a domain using the Allowed Domains
settings (so example.com/index.html or example.com/images/ are not valid entries in the allowed domain
list).




                                                                                                            8
                                                                                             Kiosk Group, Inc.




The idle time limit is one of Kiosk Pro‟s most popular features and is available in all three versions. The
idle time limit will start a timer after every touch to the iPad. If the iPad has not been touched upon timer
completion, the web page will redirect to the Home Page specified earlier in the settings.




This will allow other users to view your content from the starting point. Depending on your content, a
typical setting is anywhere from 30 to 60 seconds.

(For testing, you‟ll want to use 15 seconds to minimize the amount of time you have to wait for refresh.
For showing off your programs to potential customers, you might want to use a long value or disable the
feature completely.)

If the idle time limit field is left empty or with a value of 0, Kiosk Pro will not return the program to the
home page on its own. The idle timer does not run when the home page itself is being viewed; using the
functionality of the idle time limit is dependent on having a site structure with multiple pages that the user
can navigate or creating an index page that redirects to your home page.




                                                                                                            9
                                                                                         Kiosk Group, Inc.




This ON/OFF switch controls the view of the thin black information bar at the top of your iPad‟s screen.




This information bar normally displays Wi-Fi/3G connectivity/range, the current time, and the amount of
battery time remaining. Typically this is turned off to maximize viewing area.




This ON/OFF switch toggles the view of the URL address of the web page currently in view.




The address bar is located at the top of the iPad screen. Typically the address bar should be hidden
unless you want your viewers to be able to browse the internet freely. Hiding the address bar also
maximizes the display area.




                                                                                                       10 
                                                                                         Kiosk Group, Inc.




This ON/OFF switch changes the visibility of the BACK, FORWARD, and HOME navigation buttons. In
Kiosk Pro and Kiosk Pro Plus, the navigation bar can also contain the optional PRINT button (on page
1212).




The navigation bar is located at the bottom of the iPad screen. The BACK and FORWARD buttons allow
the user to go back or forward between web pages, as in a standard browser. The HOME button takes
the user to the Home Page setting mentioned earlier.




Some web sites may require these navigation buttons; however, you may want to hide these buttons and
use a custom user interface built with HTML/JavaScript/CSS or only allow the user to navigate via the
links on your page.




This feature is only available for Kiosk Pro and Kiosk Pro Plus.

This mode allows you to toggle a user‟s ability to pinch and zoom within a webpage.




The default position is set to OFF, which allows preset iPad pinch gestures to zoom in and out for a closer
view of content. Zooming in or out occurs when a user uses two fingers and drags them away from or
toward each other or if a user double taps on a text column.

Disabling zoom allows you to have more control over the ways in which your content is viewed.




                                                                                                       11
                                                                                           Kiosk Group, Inc.




This feature is only available for Kiosk Pro and Kiosk Pro Plus.

This mode allows your users to print content from your kiosk to your Airprint-enabled printer.




The default position is set to OFF to prevent accidental usage of this feature. When the print setting is
enabled, your users can either print through a print button that will come up on the bottom navigation bar
(which must be set to show, on page 11).




For more information about Airprint-enabled printers currently available, you can visit:
http://www.apple.com/ipad/features/airprint.html




                                                                                                       12 
                                                                                          Kiosk Group, Inc.




This feature is only available for Kiosk Pro and Kiosk Pro Plus.

This mode allows you to provide your users with feedback if they have to wait for links to load.




The default position is set to OFF to prevent accidental usage of this feature. When the progress
indicator is enabled and your users touch a link on your kiosk pages, a transparent grey screen with a
spinner in the middle will overlay your content while the page loads to indicate to your user that
something is happening.




If the page has not loaded within a 30 second time period or there is an error event returned while loading
the page, the progress indicator will time out, leaving the user on the same page.




                                                                                                         13
                                                                                          Kiosk Group, Inc.




This mode allows an owner to toggle the iPad‟s response to user touch, effectively turning the iPad into a
non-interactive digital sign.




The default position is set to OFF. However if your program requires the iPad to be a visual display only,
you‟ll want to use this setting. Once switched to ON, the iPad will be unable to respond to touches,
pinches or any other hand gestures. This is great for digital advertising or portfolio illustrations.

Your content will need to be self-cycling (via HTML/CSS /JavaScript programming), changing the graphic
display every few seconds. Many digital signs will play a loop of five to ten screens.



A sample file demonstrating a slideshow loop is available as a zipped file at:

http://www.kioskproapp.com/documents/imageloop.zip

After downloading the file, it can be unzipped and examined in a text editor as a code example or
transferred to the iPad to be viewed as a local file for demonstration purposes. This demonstration can
also be viewed on the Kiosk Pro app website by setting your Kiosk Pro homepage to:
www.kioskproapp.com/demos.html and clicking on the Digital Sign Example.




                                                                                                       14 
                                                                                          Kiosk Group, Inc.




This feature is only available for Kiosk Pro and Kiosk Pro Plus.

This pair of settings allows Kiosk Pro and Pro Plus to clear the cache and/or cookies each time it returns
to the Home Page, either through timing out with the Idle Time Limit or by navigation by the user.




Clearing the cache can be useful for users who need their content pages to reload entirely on a regular
basis. Clearing cookies might be used on kiosks where a user can sign in to applications to make sure
that he or she is signed out when the application times out or to make sure that any sensitive information
entered by the user is cleared from system memory.




                                                                                                        15
                                                                                         Kiosk Group, Inc.




This time limit allows you to specify how long you want your users to be able to use the kiosk before
directing them to a Good-Bye Page (see next page).




The default position is set to „Forever‟. The browse limit starts when a user first touches your Home Page.
This feature is ideal for a busy kiosk situation like a tradeshow where you may want to limit each user‟s
time on the kiosk.




It is recommended that this feature be used in conjunction with a Good-Bye Page (see next page).




                                                                                                        16 
                                                                                              Kiosk Group, Inc.




This option is used in conjunction with the Browse Limit feature and allows you to specify the web page
that the user will be sent to once the Browse Limit event occurs.




By default this section is blank, however for demonstration purposes a sample URL is listed above. This
web page will be displayed upon completion of the Browser Limit mentioned previously. This is useful if
your situation has many users waiting on the same kiosk.




The URL needs to be the full web address of the page, including http://

We suggest that you make the Good-Bye Page non-interactive. Having no means to change the page,
the current user will walk away. Eventually the Idle Time feature will take the program to the Home Page,
where the next user can get a chance to use the kiosk. Make sure you specify a value for the Idle Time or
the app will get stuck on the Good-Bye Page.

If this field is left blank and the Browser Limit is set to a value, Kiosk Pro will take the user to the Home
Page. To correct this, set a Good-Bye Page.




                                                                                                            17
                                                                                             Kiosk Group, Inc.




This ON/OFF button allows you to display a message if a user tries to access a site not listed in the
Allowed Domains list (on page 8).




By default the switch is set to OFF. If there are sites listed in the Allowed Domains list and this setting is
off, any non-designated link or web address will not work and there will be no explanation to the user.

By setting the switch to the ON position, Kiosk Pro will show an alert box informing the user that the web
site is not allowed. The Pro and Plus versions allow you to customize the text of the message (see Text
for Off-Domain Dialogue below). This switch is useful if you have a web site containing many off-domain
links, such as ads.




This feature is only available for Kiosk Pro and Kiosk Pro Plus.

This feature allows you to customize the text message warning shown when users attempt to visit
domains not listed in the Allowed Domains list (on page 8).




By default, this entry is supplied with the phrase “Sorry, this site is not allowed.” In both the Pro and Plus
versions, you can easily change this text. This feature is useful if your web site is in another language or if
you just want your message to better match the overall tone of your kiosk content.




                                                                                                           18 
                                                                                        Kiosk Group, Inc.




This feature is only available for Kiosk and Kiosk Pro Plus.

This ON/OFF button allows the owner to receive email notification when the power status changes.




Email on Power Supply Change can be a useful tool for notification if the iPad loses external power due
to a system-wide power outage, a blown breaker, a pulled plug or theft. This feature will also send a
notification when external power is restored.

The default setting is set to OFF. This setting can only be used in conjunction with the SMTP Server
Settings which must be set up for email to be sent (on page 20).




                                                                                                       19
                                                                                        Kiosk Group, Inc.




This feature is only available for Kiosk Pro and Kiosk Pro Plus.

SMTP - Simple Mail Transfer Protocol settings must be obtained from your email provider.




Once the server settings are set, you will have the ability to use Email on Power Supply Change feature
mentioned previously.




       The From E-mail can be any properly formatted email address you choose.
            o Example: ipad@example.com
       The To E-mail must be a valid and properly formatted email address.
            o Example: tech@example.com
       The SMTP Server refers to an IP or web address assigned by the email host/provider
            o Example: smtpout.secureserver.net
       The Requires Authentication switch toggles the authenticity requirement. By default, this is set
        to ON. If your mail server does not require a username and password to send mail, you may
        switch this to OFF.
       The User Name refers to the account sending the email. This information is given by your email
        host/provider.
       Password refers to the password of the account sending the email.
       Enable SSL (Secure Socket Layer) provides an extra layer of security while sending your email.
        By default this option is set to OFF.



                                                                                                     20 
                                                                                             Kiosk Group, Inc.




This feature is only available for Kiosk Pro and Kiosk Pro Plus.

This setting allows you to change the settings of Kiosk Pro remotely by changing corresponding values in
an XML file and posting it on your servers for Kiosk Pro to visit.




Remote settings control can be extremely useful when deploying many kiosks with similar settings as
multiple kiosks can be set up with a single .xml file. Alternately, you may want to create a separate XML
file for each iPad Kiosk that you operate, giving you more individualized control over each kiosk. For
instance, you might want the kiosks in certain areas to default to a different language version of your web
site.

Just create your settings XML file and upload it to the web through your hosting provider. Then enter the
full internet address path to your XML file in the XML File Location setting, toggle Remote Settings
Enable to ON and set the update period to how often you want Kiosk Pro to check your server for
changes to your XML Settings File. While testing this feature, we suggest setting the update period to
only 1 or 2 minutes, then once you are sure everything is configured correctly, increase the setting for
deployment.

For URL, remote settings control requires the full internet address (including http://, https://, and any prefix
sub domain such as www) of the configured .xml file on your server.

To download a .zipped file containing a template for remotely changing settings, click here if using Kiosk
Pro or click here if using Kiosk Pro Plus.

Unzip and save this template to your hard drive and then open it in a simple text editor (like Notepad, not
Word). Look through the key/value pairs to find the settings your kiosk uses.

Settings that accept text will be filled out in between the <string> </string> tags and settings that require a
number will use <integer></integer> tags. As an example, to change the home page setting of the kiosk,
you would find the matching key/value pair in the list:

        <key>Key</key><string>homePage</string>
        <key>Value</key><string>http://kioskproapp.com</string>

and change the contents of the string tags to <string>http://example.com</string> .

(continued on next page)



                                                                                                            21
                                                                                           Kiosk Group, Inc.



Settings that are toggled either on or off accept <true/> or <false/> like the Show Navigation Bar setting:

        <key>Key</key><string>showNavigationBar</string>
        <key>Value</key><true/>

The above pair sets the Show Navigation Bar setting to on.

You can quickly test the basic syntax of your .xml file by opening it in any browser. Correctly-structured
XML should display as a text file; mistakes in the XML file will generate an error message in the browser.

Be very careful to not set the External Settings File name to an incorrect value in your XML file.
For example, if you misspell the domain name, you will lose the ability to remotely update your iPad and
will have to visit the kiosk in person to manually correct the error.

Note: If you previously had Allowed Domains set and your new Home Page would not be allowed by the
previously Allowed Domains list, Kiosk Pro must be exited and restarted for the XML settings to
successfully take effect.




                                                                                                        22 
                                                                                            Kiosk Group, Inc.




This feature is only available for Kiosk Pro and Kiosk Pro Plus.

This feature allows Kiosk Pro to use files directly stored on the iPad. Local mode lets you show off your
content without having to worry about remaining constantly tethered to an internet connection.

To view local files on the iPad through Kiosk Pro, you must first transfer your files to the iPad then set
your home page to a local file. There are no other Kiosk Pro menu settings required to run your kiosk in
local mode.

To transfer files onto your iPad, you can use either third-party software (like DiskAid detailed below) or, in
certain circumstances, iTunes. When using iTunes to transfer files, folder structures are NOT
retained. All documents must be located in the same folder. If your content requires you to retain
the folder structure, you must use DiskAid or another third-party application to transfer the files.
Steps to use each program are outlined on the next two pages.

For examples of how to name and set up your local files as your kiosk home page in Kiosk Pro settings,
see the Home Page settings (on page 7).

While remote update of local files (see next page) relies on files being uploaded as a .zip file, local update
through DiskAid or iTunes cannot use zipped formats. Your home page (i.e. index.html) must be in an
unzipped format and placed directly in the root „Document‟ folder.




                                                                                                          23
                                                                                           Kiosk Group, Inc.



Transferring Files using DiskAid for Mac or PC
   – Free 14 day trial, then $9.90 for a full license at http://www.digidna.net/products/diskaid

    1. Connect your iPad to the computer and open DiskAid

    2. On the left hand side of the DiskAid application, expand the icon labeled „Apps‟.

    3. Click on the version of Kiosk Pro you are using.

    4. To add your files and folders, simply drag and drop them into the Kiosk Pro folder space on the
       far right side of the DiskAid window or click on the 'Copy Files to Device' or 'Copy Folder to
       Device' icons at the top.
    5. To delete files, select the files you wish to delete and click the 'Delete from Device' icon.
    6. To download files from the iPad, select the files you wish to download and either drag and drop
       them to your desktop or click the 'Copy to PC' icon.
    7. Finally, disconnect the iPad and type the filename of your home page into the Home Page setting
       for Kiosk Pro. For example,‟ Home Page: index.html‟.




                                                                                                       24 
                                                                                           Kiosk Group, Inc.



Transferring Files using iTunes

   1. Start by hooking up the iPad to a computer and opening iTunes.

   2. Click on your iPad Device under the heading 'Devices' in the left-hand grey navigation bar.

   3. Then near the top middle of the screen, click „Apps‟.

   4. Scroll down to „File Sharing‟, click on the version of Kiosk Pro you are using and use the „Add…‟
      button to transfer your files to the iPad.

   5. To download files from the iPad, select the file, and then click 'Save As...' at the bottom of the file
      listings. To delete files, you must use iPhone Explorer or uninstall/reinstall Kiosk Pro.

   6. Finally, disconnect the iPad and type the filename of your home page into the Home Page setting
      for Kiosk Pro. For example, „Home Page: index.html‟.




                                                                                                          25
                                                                                             Kiosk Group, Inc.




This feature is only available for Kiosk Pro Plus.

This feature allows Kiosk Pro Plus to update the local files on the iPad remotely by visiting a pair of .xml
and .zip files hosted on your servers.




When Remote Update of Local Files is enabled, Kiosk Pro will check the .xml file at the URL you provide
to see if it has been updated and then, if it finds a new version number, will upload any files in the
associated zip file, overwriting any files with the same name currently on the iPad.

You can control how often this is checked through the Update Period setting. Remote update of local
files will occur in the background while Kiosk Pro is running and will update the content without a restart
of Kiosk Pro.

Click here to download a sample .xml file. Save this template to your hard drive and then open it in a
simple text editor (like Notepad, not Word, which adds formatting). This .xml file consists of a single
key/value pair:

        <dict>
                  <key>version</key><integer>1</integer>
                  <key>zip</key><string>localContent.zip</string>
        </dict>

The version value is how Kiosk Pro determines if the .xml file has been changed. For Kiosk Pro to
update, this value must be larger than the last time this feature was used. Each time you use this feature
to remotely update, you must increase the number inside the <integer> tags by at least 1.

The zip value contains the name of the zip file containing the new files to be placed on the iPad. All the
new files must be placed directly in a single .zip file which must be placed in the same folder on your
server as the .xml file described above.

When zipping your files for upload, it is important to zip the files directly, rather than zipping a folder
containing the files. For example, if you were trying to upload a new index.html file and a folder of
images, you would select the index file and the image folder directly (either by Select All (Ctrl-A) or by



                                                                                                              26 
                                                                                              Kiosk Group, Inc.



pressing Ctrl and clicking each file), then right-click and „Send to Compressed Folder‟. You would not zip
the folder containing the index file and image folder.

The URL for content update setting will be the full server path to your .xml file, including http://.

Note: If the homepage file has a different name than what was previously in the field, the homepage
setting must be updated (either remotely by .xml file or manually in the settings) to reflect the new name.
To avoid having to update both every time, it is recommended that you use a generic file name such as
index.html.



Troubleshooting the Remote Settings Update function:

    1. Make sure your files and web address are named and formatted correctly.
            a. The .xml file can be named anything as long as it is correctly referenced in the web
                address and ends in .xml
            b. The zip file can be named anything as long as it is correctly referenced in the .xml file and
                ends in .zip
            c. The web address requires the full http:// treatment, like
                http://www.example.com/localVersion.xml
    2. Make sure you have updated your version number in the .xml file. If the version number has not
       been updated since the last time Kiosk Pro Plus checked the file, it will not download the contents
       of the .zip file.
            a. It is best to make a practice of first uploading the zipped content file and then once that is
                complete, upload the .xml file to instruct Kiosk Pro Plus to check for new content. If Kiosk
                Pro Plus goes to check the .xml and the associated .zip either is not there or has not yet
                been updated, it will not update the content until the next time the .xml file is updated.
    3. Make sure your .zip file is structured correctly.
            a. Make sure the zipped folder contains the files directly, so zip (contains index.html, image
                folder), not zip (contains folder (which contains index.html, image folder))
            b. If you are using a Mac, you will need to download a file zip utility that does not add an
                extra layer of folder structure to the .zip file. One of our customers suggested YemuZip
                (http://download.cnet.com/YemuZip/3000-2250_4-10215343.html), a free zip utility for
                Mac.
    4. Set your update period to 1 or 2 minutes until you have everything working, and then extend it for
       deployment.




                                                                                                           27
                                                                                                Kiosk Group, Inc.




This feature is only available in Kiosk Pro Plus.

Remote monitoring is an advanced feature that allows Kiosk Pro Plus to send predetermined variables to
your servers on a regular basis. This can allow you to monitor the status of your kiosks more closely.




Data variables set through your HTML/JavaScript code will be delivered to your server through POST
requests similar to a form submit.

A set of sample files demonstrating this function is available as a zipped file at:

http://www.kioskproapp.com/documents/remotemonitor.zip

 After downloading the files, they can be unzipped and examined in a text editor as a code example or
placed on a server to be run. Since this code example is reliant on the built-in JavaScript functions of
Kiosk Pro, it will not run successfully in any other browser environment. It also requires a server
configured with PHP and so cannot be run locally on the iPad.

A text file with instructions on how to run these files successfully is included in the .zip file.




                                                                                                            28 
                                                                                         Kiosk Group, Inc.




This feature is only available in Kiosk Pro Plus.

This feature allows Kiosk Pro Plus to dim and wake itself at predetermined times.




Enabling night mode allows Kiosk Pro Plus to dim the iPad‟s screen to black and temporarily remove
response to touch gestures for the time period you designate. As full disclosure, Kiosk Pro Plus is unable
to turn off the LED backlight completely or to technically put the iPad to sleep, but is able to give you
control over the times that your kiosk is available for use.

The „Begin Time‟ and „End Time‟ settings must be set using times from a 24-hour clock (also known as
„military time‟).




                                                                                                      29
                                                                                            Kiosk Group, Inc.




This feature is only available in Kiosk Pro and Kiosk Pro Plus.

This feature allows you to add up to six custom links with labels of your choice to the bottom navigation
bar of Kiosk Pro. The bottom navigation bar must be set to show to enable this feature successfully.




Links are comprised of a label shown on the navigation bar button and a link address where you want the
user directed when he or she presses the button. Links can either be to remote or local pages.

Label text that is too long will be cut off so you will want to check your links after you set them up to make
sure none have been abridged. Links that are left empty are not created.

The link settings include an RGB background color setting that allows you to coordinate the color of your
links with your site or corporate color scheme. The preset RGB color (111,111,111) matches the other
icons on the navigation bar. This setting must be filled out in R,G,B decimal format, separated by
commas, and will not accept hexadecimal or other format.




                                                                                                          30 
                                                                                              Kiosk Group, Inc.




This feature is only available in Kiosk Pro and Kiosk Pro Plus.

This feature allows your script to autoplay audio or video files on page load.

To function correctly, files must be labeled with the autoplay attribute inside the <audio> or <video> tag
itself:

<video src=”video.mp4” autoplay></video>



Sample files demonstrating this function in both audio and video are available as a zipped file at:

http://www.kioskproapp.com/documents/autoplay.zip

 After downloading these files, they can be unzipped and examined in a text editor as a code example or
transferred to the iPad to be viewed as a local file for demonstration purposes. Since this code example
is reliant on the built-in JavaScript functions of Kiosk Pro, it will not run successfully in any other browser
environment.

Previous users: Version 2.0 of Kiosk Pro simplifies how Kiosk Pro handles autoplay of video and may
require changes to your current implemented solution. We have eliminated the JavaScript call that must
be run prior to the video and so any video tagged with the appropriate tag will autoplay automatically.
Our previous example relied on a callback from this script to forward the page location and as that
function and callback no longer exist, your page may not forward correctly. If this is the case, your
second page will become the home page and the previous home page simply eliminated.




                                                                                                            31
                                                                                           Kiosk Group, Inc.




This feature is only available in Kiosk Pro and Kiosk Pro Plus.

Including the following JavaScript function in your code allows you to integrate the unique ID set for your
kiosk in the Settings menu of Kiosk Pro (see page 9). This can allow you to tag or user data with the ID
of the sending kiosk.

function getID() {
       try {
               return kioskpro_id.toString().split(" ").join("");
       }
       catch(e) {
               return "";
       }


An example of this code can be viewed as part of the example files demonstrating the signature capture
capabilities of Kiosk Pro Plus (on page 33).




These functions are only available in Kiosk Pro Plus running without remote Internet access.

Using the following JavaScript functions, you can save user data locally on the iPad and email files.

fileExists(filename, callback);

writeToFile(filename, data, callback);

deleteFile(filename, callback);



Sample files demonstrating saving user data from a form locally to the iPad in a .csv file are available as
a zipped file at:

http://www.kioskproapp.com/documents/savedata.zip

 After downloading the file, it can be unzipped and examined in a text editor as a code example or
transferred to the iPad to be viewed as a local file for demonstration purposes with index.html set as your
Home Page. As this example requires the maintenance of file structure to run successfully, you must use
a third-party app like DiskAid to transfer the files to your iPad and download the resulting user data files
back to your computer to be viewed. Since this code example is reliant on the built-in JavaScript
functions of Kiosk Pro, it will not run successfully in any other browser environment.


                                                                                                        32 
                                                                                           Kiosk Group, Inc.




This feature is only available in Kiosk Pro Plus running without remote Internet access.

Kiosk Pro Plus allows your kiosk to capture visitor signatures or drawings through the use of HTML5
canvas and built-in JavaScript calls:

saveScreenToPng(filename, x-axis, y-axis, width, height, callback );

definition of parameters:

       filename: must be generated dynamically to be unique or will save over previous file each time it
        is called
       x-axis: the number of pixels from the left edge of the page the area to be saved (the canvas) will
        begin
       y-axis: the number of pixels from the top edge of the page the area to be saved (the canvas) will
        begin
       width/height: the width/height of the area to be saved
       callback: any function you would like to run following the completion of saveScreenToPng



Sample files demonstrating a signature capture saved locally to the iPad as a .png file is available as a
zipped file at:

http://www.kioskproapp.com/documents/signaturecapture.zip

After downloading the file, it can be unzipped and examined in a text editor as a code example or
transferred to the iPad to be viewed as a local file for demonstration purposes. Since this code example
is reliant on the built-in JavaScript functions of Kiosk Pro Plus, it will not run successfully in any other
browser environment.




                                                                                                          33
                                                                                            Kiosk Group, Inc.




This feature is only available in Kiosk Pro Plus using an iPad2 and running without remote Internet
access.

Kiosk Pro Plus supports photo and video capture through JavaScript calls within your page.

Using the built-in JavaScript functions:

takePhotoToFile();

takeVideoToFile();

you can access the camera available in the iPad2 and save the result locally on the iPad. Additionally,
you can delete individual files by calling:

deleteFile();

The camera function will always default to the front-facing camera as this is the one most likely to be
accessible in kiosks.



A sample file demonstrating these functions is available as a zipped file at:

http://www.kioskproapp.com/documents/takephotovideo.zip

 After downloading the file, it can be unzipped and examined in a text editor as a code example or
transferred to the iPad to be viewed as a local file for demonstration purposes. Since this code example
is reliant on the built-in JavaScript functions of Kiosk Pro Plus, it will not run successfully in any other
browser environment.




                                                                                                          34 

				
DOCUMENT INFO
Shared By:
Categories:
Tags:
Stats:
views:115
posted:11/21/2011
language:English
pages:35