JAWS for Kiosk User Guide

Welcome to JAWS® for Kiosk, an accessibility solution for adding text-to-speech audio output to self-service kiosks running on the Android™ operating system. With JAWS, blind or low vision users can enjoy increased independence when performing tasks such as ordering at a quick service restaurant, filling out private information at a doctor’s office or job application site, voting in an election, and more.

Features and benefits of JAWS for Kiosk include:

• Support for kiosk software running on the Android operating system. Includes software running on a terminal device or tablet.
• High-quality voices for speech output.
• Support for multiple languages.
• Auto start JAWS upon insertion of audio device and auto stop/end session when audio output is disconnected.
• Offers features that work specifically with Storm assistive technology products as well as other alternative input solutions such as touch screens.
• A dictionary that administrators can use to customize how JAWS pronounces specific words or abbreviations.
• Ability for administrators to assign custom labels and tutor messages to poorly labeled kiosk application controls.
• For businesses or agencies with several locations, ability for administrators to export JAWS settings to an external file which can then be imported into other installations of JAWS Kiosk to eliminate the need to configure each individual device.
• No Internet connection required for full functionality.

Once installed, JAWS for Kiosk becomes an interface between your kiosk application and the blind or low vision user to provide increased accessibility for navigating and reading onscreen content. JAWS for Kiosk does not alter your application in any way and sighted users will continue to interact with the kiosk as usual. No changes to your kiosk application are required to use JAWS for Kiosk.

Deploying JAWS for Kiosk in your business ensures that all blind and low vision users have a positive experience similar to sighted users when using your website or application. Offering an accessible kiosk can also help your business meet ADA (Americans with Disabilities Act) compliance.

This document is intended to be a guide for kiosk administrators responsible for deploying kiosk applications throughout their company or agency.

System Recommendations

To use JAWS for Kiosk, you need a tablet or device that offers a standard 3.5MM audio jack or USB port for connecting headphones. The device must also offer a touch screen or be connected to a Storm keypad. If using a Storm keypad, users will connect directly to the audio jack on the keypad. Additionally, we recommend the following:

Supported Languages

Important Note for TalkBack Users

Throughout this guide, there are numerous references to scrolling and tapping when instructions are given to move to and activate controls. If you are a visually impaired administrator using the TalkBack screen reader, you should substitute the appropriate screen reader gestures. For example, using one finger to swipe left or right through options and double tapping to select one.

Once JAWS is installed on the Android device running the Kiosk software, you must first enable the JAWS service.

Note: If the device is running Android 13 or later and restricts enabling the accessibility service, navigate to Settings, Apps, JAWS for Kiosk, App info, Permissions, More options, choose Allow restricted settings, and enter the lock code when prompted.

1. Scroll to and tap Settings. The location of the Settings app may be different depending on the type of device you are using.
2. Scroll to and tap Accessibility.
3. Scroll to and tap Installed Apps (or Installed Services depending on your device).
4. Scroll to and tap JAWS for Kiosk.
5. Tap JAWS for Kiosk to turn it on. You are asked to allow JAWS Kiosk to have full control. Tap Allow to continue.
   

   

Once enabled, JAWS begins speaking as soon as you connect headphones or speakers to the headphone jack on your device or Storm Keypad. Once you disconnect from the headphone jack, the JAWS session stops and any settings modified by the user, such as the voice rate or volume, are reset to their defaults.

Note: If the TalkBack screen reader is currently enabled, it is recommended you turn it off before plugging into the headphone jack to avoid both screen readers speaking at once. In most cases, you should be able to disable TalkBack by simultaneously pressing and holding the Volume UP and Volume Down buttons on your device for a few seconds.

Once JAWS is enabled, you can begin setting it up for your kiosk environment. To begin, scroll to and tap JAWS for Kiosk Settings. A screen displays containing version information, an option to access Help, and an option to access Admin Settings.

To configure JAWS, tap Admin Settings. When prompted to enter the admin password, type “Password” (passwords are case sensitive) and select Continue to open the main Admin Settings screen. “Password” is the default for new installations. At this point, the Admin Settings screen remains available until you log out.

IMPORTANT: Once you have finished making any of the customizations described in the following sections, make sure to select Logout from the Admin Settings screen before making your kiosk available to customers. This ensures kiosk users are unable to perform any admin-specific gestures or commands.

When you first install JAWS for Kiosk, it runs as a trial version. The trial offers full functionality so you can configure the software and evaluate how it performs with your kiosk application. Trial information is displayed on the main JAWS for Kiosk screen and a trial message is spoken prior to the welcome message when connecting headphones. To obtain a production license, please contact TPGi sales at:

• Phone: +1 (877) 775-9474
• Email: Info@TPGi.com

Installing a License

Once you receive your license file, you can install it by doing the following:

1. Open the JAWS for Kiosk Admin Settings.
2. Scroll to and tap Licensing.
3. Tap I have a license and then do one of the following depending on where you stored the license file:
   

   

   • If the license file is saved in a network location, enter the link and tap Import from URL.
   • If the license file is saved locally on the device, tap Import from file.
     

     

   • Once imported, the Licensing screen shows the details for the active JAWS for Kiosk license. If you ever receive an updated license file, tap Change License and follow the prompts to update your current license.
     

     

Once logged in to the Admin Settings, please configure a unique password for added security.

1. Open the JAWS for Kiosk Admin Settings.
2. Scroll to and tap Manage Password.
3. Type the current password you are using and swipe to the next edit field. If you have not previously changed the password, then type “Password” which is the default. Note that passwords are case sensitive.
4. Type the new password you want to use and swipe to the next edit field.
5. Type your new password again to confirm it and then tap Continue.
   

   

6. A confirmation screen appears stating that your password was changed. Tap OK.

The next time you log in to the Admin Settings, you will need to provide your new password.

Note: You can choose to leave the password fields blank, so you do not have to enter a password when accessing the JAWS for Kiosk Admin Settings screen. You should only do this if you use other methods for securing the device running your Kiosk application.

JAWS allows you to configure the default volume, rate, and pitch for the speech output. You can also add new voices for other languages as well as configure JAWS to automatically switch to the appropriate language when the user selects it in multi-lingual kiosks.

Configuring Speech Settings

Note: Before changing the settings described in this section, it is recommended you connect headphones or speakers so you can preview your speech changes. When JAWS is talking, note that you need to perform a double tap gesture to activate an item.

1. Open the JAWS for Kiosk Admin Settings.
2. Scroll to the Speech group and double tap Speech settings.
3. Scroll to the Volume slider control and swipe up or down with one finger to set a preferred volume level for JAWS speech.
4. Under the Default speech settings group, scroll to the Rate and Pitch slider controls and swipe up or down with one finger to make any adjustments that you think would be ideal for most customers when navigating and reading content. For instance, you may not want to set the rate extremely slow, but you also do not want it to be too fast.
5. Under the Tutor speech settings group, scroll to the Rate and Pitch slider controls and swipe up or down with one finger to make any adjustments you think would be ideal for customers listening to tutor messages describing how to interact with an application control.
   

   

When a user is accessing the kiosk with JAWS, they can perform a One-finger swipe down then right to open the Options dialog where they can change the current rate and volume. They can also use the volume buttons on the Storm keypad or tablet or perform a One-finger swipe left then right or One-finger swipe right then left to lower or raise the current volume. When the user disconnects their headphones and the JAWS session stops, any speech settings changed by the user will revert to their defaults specified through the Admin settings.

Adding a Language

If your kiosk supports additional languages besides English, and you would like JAWS to switch to a particular language when selected by the user, you need to first enable these languages in JAWS.

1. Open the JAWS for Kiosk Admin Settings.
2. Scroll to the Language group and tap Supported kiosk app languages. If you have not yet added a language, then English will be the only language listed here.
3. Tap Add language.
4. Tap one or more languages you want to add based on the languages offered by the kiosk application. For example, if your application supports English and Spanish, tap Spanish. If it supports English and French, tap French.
   

   

5. Once you have selected the languages you want, tap the Add button. You are returned to the list of supported kiosk app languages which now contains the new languages you just selected.

Installing Additional Voices

By default, JAWS installs one English voice. However, there are several other voices you can download and try out. Additionally, once you have added a supported language, you must now install a voice for that language.

1. Open the JAWS for Kiosk Admin Settings.
2. Scroll to the Speech group and tap Manage voices.
3. Scroll to and tap on a language to display a list of voices for that language. Note that if you have not yet added a supported kiosk app language as described above, you will only be able to manage voices for English.
4. Scroll to the voice you want to install and tap Download.
   

   

5. The first voice you install is automatically set as the default voice for that language. If you install additional voices for a particular language and you want to choose a different one as the default, scroll to the voice you want to use and tap Set as default.
   

   

Note: You can download as many voices as you want for previewing purposes. However, once you have decided on the voice to use as the default for a language, you should remove any other voices to conserve storage space.

Setting a Default Kiosk Language

By default, when a user plugs in headphones, JAWS uses the default system language configured in the settings of the Android device. If the primary device language is English, JAWS always starts up in English. If the primary device language is Spanish, or another JAWS supported language, JAWS always starts up in the specific language if it was added using the steps above in the Adding a Language section. If the specific language matching the device language was not added to JAWS, English is used Instead.

If necessary, you can configure JAWS to start using a specific language when headphones are connected, even if it does not match the primary device language.

1. Open the JAWS for Kiosk Admin Settings.
2. Scroll to the Language group and tap Default language of kiosk. The default for this option is System Default.
3. Tap the specific language you want JAWS to use when a customer connects their headphones. For example, Spanish. Note that you must add the language using the steps in the Adding a Language section above.
   

   

Configure Automatic Language Switching

In most cases, when a user chooses to navigate your Kiosk in a different language, you will want JAWS to automatically switch to the appropriate voice for that language so that application controls and other content is spoken correctly. For example, if the user chooses the Spanish option in the application, JAWS should switch to a Spanish voice, so the Spanish kiosk interface is read correctly. Once you have enabled your supported kiosk languages in JAWS and set up a default voice for each language, JAWS now switches to the correct voice language when the kiosk application language changes. Exactly how JAWS is alerted to change the language voice depends on the type of application in use.

Add Language Attributes in Web-Based Apps

If your kiosk connects to a web-based application or web site, make sure the web developer includes the correct language attributes to the content to indicate to JAWS which language should be used. For example, we write the text “Enter contact details” in Spanish:

<span lang="es" xml:lang="es”>ingrese los datos de contacto</span>

When JAWS encounters this text tagged with the “es” attribute, JAWS automatically changes to the Spanish voice.

Refer your developer to the W3C website (opens in a new tab) as a starting resource for working with language tags.

Use JAWS SDK Functions in Native Apps

The JAWS for Kiosk Software Development Kit (SDK) can be used to tell JAWS to perform a specific language action. App developers can use the SDK to trigger a language change method in JAWS by passing in the appropriate language code such as en (English), fr (French), es (Spanish), and de (German).

For example, a developer can add the following code snippet to a kiosk application to send a language change notification to JAWS:

fun changeLanguage(languageCode: String) {
	JAWSKiosk.getSession().changeLanguage(languageCode)
}

Configure JAWS Language Actions

In situations where you are unable to directly modify the kiosk application, JAWS allows you to manually assign a language action to each control in your app that is used to select a language.

Note: Before performing the actions described in this section, it is recommended you connect headphones or speakers, so JAWS is talking. When JAWS is active, note that you need to perform a double tap gesture to activate an item.

1. Open the JAWS for Kiosk Admin Settings and scroll to the Language group.
2. Double tap Enable Language Change Detection which is off by default.
   

   

3. Open your kiosk application and navigate to the controls a user would select to change the application language. For instance, you may have buttons for choosing between English or Spanish.
4. Place focus on a language option other than English. For example. Spanish.
   

   

5. Perform the JAWS gesture, One-finger swipe up and right, to open the JAWS for Kiosk Admin Task dialog box and double tap Set language action. Note that if you previously logged out of the JAWS admin settings, you need to log back in before you can access this dialog box.
   

   

6. In the list of available languages, double tap Spanish to select it and then double tap OK.
   

   

7. Now, place focus on English and perform the One-finger swipe up and right gesture again to open the JAWS for Kiosk Admin Task dialog box and double tap Set language action.
8. Make sure English is selected in the list and double tap OK.
9. Repeat these steps for any other languages that are supported by the kiosk and that you have added in JAWS.

Now, for example, if a user double taps on the control that switches the kiosk to Spanish, JAWS uses the language action you defined for that control to switch to a Spanish voice, so controls and other information are read correctly. If the user then double taps the control to switch the kiosk back to English, JAWS automatically switches back to the English voice based on the language action you defined for this control.

The JAWS Dictionary lets you change the way words, phrases, or abbreviations are spoken. For instance, if you have food items on a restaurant menu that are regularly mispronounced, you can add rules to the dictionary for each individual item to ensure it is pronounced correctly as the customer navigates. Another example is the abbreviation “QTY”, which is typically used to represent “quantity” when displaying items in a cart. You could add a rule for “QTY” to the dictionary so that JAWS always says “quantity” when this text is encountered.

If working with multiple languages, note that each language uses its own dictionary. This means if you create pronunciation rules for English and then switch to Spanish, these rules no longer apply. You will need to explicitly create pronunciation rules for Spanish that will take affect when this language is active.

Adding an Entry

1. Open the JAWS for Kiosk Admin Settings.
2. Scroll to the Dictionary group and tap Manage dictionary.
3. Since dictionary rules are language specific, tap the language you want to add rules for, for example, English.
4. Tap Add dictionary entry.
5. In the Original text edit box, type the actual word or abbreviation as it appears in the kiosk application.
6. In the Replacement text edit box, type the corrected pronunciation. When you add or change a dictionary definition, you are telling JAWS how to phonetically pronounce the word. The Replacement Word can be a word or a combination of letters and spaces. You may need to try several combinations until JAWS speaks the word or phrase correctly.
7. Use the Listen button to preview your rule. If it isn’t spoken the way you like, continue making changes in the Replacement text edit box until it is spoken correctly.
   

   

8. When the new entry is spoken the way you want, tap the Add button to save your rule.

Changing or Removing an Entry

1. Open the JAWS for Kiosk Admin Settings.
2. Scroll to the Dictionary group and tap Manage dictionary.
3. Since dictionary rules are language specific, tap the language containing the rules you want to modify, for example, English.
4. Tap the entry you want to modify and then do one of the following:
   • Make any necessary changes to the contents in the Original text and Replacement text edit boxes and then tap the Change entry button. Or
   • Tap the Remove entry button to completely delete the rule.
     

     

For kiosks that are used for financial transactions, symbols may be displayed to represent various types of currency, such as “CA$” and “CA $” for Canadian dollars. JAWS for Kiosk allows you to map symbols to various currency types so the specific currency is spoken correctly.

1. Open the JAWS for Kiosk Admin Settings.
2. Scroll to the Currency group and tap Currency Manager.
   

   
   

3. Tap Add.
4. In the Symbol edit box, enter the symbol for the currency used in your kiosk.
   

   
   

5. Tap the list of available currencies and choose the one you want to map to the symbol you entered.
   

   
   

6. Tap Add.
7. Repeat this process for any additional currencies you want to map.

To update an existing currency entry, from the Currency Manager screen, choose a mapped currency from the list. Make any changes to the symbol or select a different currency type and tap Update. You can also tap Delete to completely remove the entry.

Sometimes, JAWS may not properly read labels (prompts) for some of the controls in your kiosk application, or the label that is provided is not very meaningful. If you find a control that seems poorly labeled, you can assign your own custom text that JAWS will speak when encountering the control. Additionally, while JAWS includes generic tutor messages describing how to use certain controls, you can add your own custom tutor messages for specific controls to describe how the user should interact with them.

Sometimes, JAWS may not properly read labels (prompts) for some of the controls in your kiosk application, or the label that is provided is not very meaningful. If you find a control that seems poorly labeled, you can assign your own custom text that JAWS will speak when encountering the control. Additionally, while JAWS includes generic tutor messages describing how to use certain controls, you can add your own custom tutor messages for specific controls to describe how the user should interact with them. For example, Plus and Minus buttons may be used for changing the quantity of an item in a shopping cart. In this case, you could add custom labels for these buttons such as “increase number of items” or “decrease number of items.” You could also add a custom tutor message to say something like “double tap to increase or decrease this item’s quantity in your cart.” When the user encounters a Plus or Minus button while navigating your kiosk, they would now hear the custom labels and tutor messages instead of the defaults.

Note: Before performing the actions described in this section, it is recommended you connect headphones or speakers, so JAWS is talking. When JAWS is active, note that you need to perform a double tap gesture to activate an item. Also note that if using the onscreen keyboard, you will need to double tap on a key to enter it.

Adding a Custom Label and Tutor Message

1. Open your kiosk application and place focus on the control you would like to label.
   

   

2. Perform the JAWS gesture, One-finger swipe up and right, to open the JAWS for Kiosk Admin Task dialog box and double tap Add Label and Tutor Message. Note that if you previously logged out of the JAWS admin settings, you need to log back in before you can access this dialog box.
   

   

3. In the Enter Custom Label edit box, type the label text you want announced when a user encounters this control.
4. In the Enter Tutor Message edit box, type the message you want announced after the label when a user encounters this control. If you are fine with the default tutor message text already in this edit box, you can skip this step.
   

   

5. When finished, double tap OK to save your changes.
6. Repeat these steps again for each control that does not offer a meaningful label.

Note: Labels and tutor messages are language specific. For example, if you create custom labels for controls while English is the active language, these labels will not be spoken if you change the language to Spanish, you will need to set the kiosk application and JAWS to the appropriate language and repeat these steps to create custom labels for that language.

Editing Labels and Tutor Messages

There are a couple ways you can edit custom labels and tutor messages.

The first way is to edit them directly from the kiosk application.

1. Open your kiosk application and place focus on the control containing the custom label you would like to modify.
   

   

2. Perform the JAWS gesture, One-finger swipe up and right, to open the JAWS for Kiosk Admin Task dialog box and double tap Edit Label and Tutor Message.
   

   

3. Do one of the following:
   • Make any necessary changes in the Enter Custom Label and Enter Tutor Message edit boxes and then double tap OK. Or
   • Double tap Remove Label and Tutor Message to completely delete the entry.

You can also manage labels and tutor messages directly through the JAWS for Kiosk Admin Settings.

1. Open the JAWS for Kiosk Admin Settings.
2. Scroll to the Custom Labels and Tutor Messages group and double tap Manage Custom Labels and Tutor Messages.
3. The applications for which you have added custom labels are listed here. Double tap the application whose labels you want to modify.
   

   

4. Select a language.
5. For sighted users, you will see a screen shot for each control from the kiosk application that contains a custom label and tutor message. Double tap on the label and tutor message you want to modify to open the Edit Label and Tutor Message dialog box.
   

   

6. Do one of the following:
   • Make any necessary changes in the Enter Custom Label and Enter Tutor Message edit boxes and then double tap Save. Or
   • Double tap Remove Label and Tutor Message to completely delete the entry.

Note: If you want to change the amount of time JAWS pauses between speaking the label and the tutor message, double tap Tutor Message Delay on the main Manage Labels and Tutor Messages screen, type a different value into the edit box, and then double tap OK.

Changing the Default Tutor Message Voice

By default, tutor messages are spoken using the same voice heard as you navigate. To help users distinguish between a label and the tutor message describing how to interact with a control, you can specify a different voice to be used for speaking tutor messages.

1. Open the JAWS for Kiosk Admin Settings.
2. Scroll to the Speech group and double tap Manage Tutor Message Voices.
3. Select a language.
4. If the voice you want to use has not previously been installed, scroll to the voice you want to install and double tap Download.
   

   

5. Scroll to the voice you want to use for speaking tutor messages and double tap Set as default.
   

   

For added security, the Privacy Screen prevents others from seeing what the kiosk user is typing or reading. There are three ways to toggle this feature:

• The kiosk user can perform a One-finger swipe up and left. The kiosk administrator can also configure this gesture through the JAWS for Kiosk Admin Settings as described in the Customizing Verbosity and Gesture Navigation section.
• The Kiosk user can perform a One-finger swipe down and right to open the Options dialog and double tap the Enable Screen Privacy switch.
• Kiosk applications can enable and disable the Privacy Screen using a JAWS for Kiosk SDK method.

For example, a developer can add the following code snippet to a kiosk application to enable the Privacy Screen in JAWS for Kiosk:

fun updatePrivacyScreen(isPrivacy: Bool) {
	JAWSKiosk.getSession().setPrivacyScreen(isPrivacy)
}

Storm assistive technology products can help enhance your self-service kiosk environment for those with visual, mobility, or dexterity impairments by providing an audio and tactile interface as an alternative to touch screen navigation. JAWS for Kiosk supports the Storm AudioNav series of keypads which typically features an audio jack, four navigation keys, an ENTER key, and controls for adjusting volume.

Calibrating the Storm Keypad

If the Storm Keypad will be the primary means of interacting with your kiosk, you first need to calibrate the keypad for use with JAWS.

1. Open the JAWS for Kiosk Admin Settings.
2. Scroll to and tap Manage Storm Keypad.
3. Scroll to and tap Calibrate Storm Keypad. A message displays confirming that the keypad is connected and headphones are plugged in to the audio jack on the keypad. Once you have verified everything is connected, tap Start Calibration to continue.
4. Choose your Storm Keypad model, 6-keys or 9-keys (images for each model are shown on the screen).
5. Select the Storm Keypad orientation, Horizontal or Vertical(images for both orientation types are shown on the screen).
6. When prompted, unplug the headphones from the keypad, wait at least two seconds, and then reconnect the headphones.
7. After disconnecting and reconnecting the headphones, you are asked to confirm the orientation of the keypad.
8. You are then asked to press the UP ARROW, DOWN ARROW, LEFT ARROW, RIGHT ARROW, ENTER, and OPTIONS buttons on the keypad.
9. Once all buttons have been pressed, JAWS should display a message stating that the Storm keypad was configured successfully.

Note: During calibration, do not press any buttons or connect headphones unless explicitly instructed to by JAWS.

Storm Keypad Settings

In addition to Storm keypad calibration, the Manage Storm Keypad screen contains the following items:

• App Type: Use this group of radio buttons to specify the type of kiosk application you have. You can choose between Native Kiosk App (selected by default) or Web Kiosk App. This setting effects the behavior of the navigation keys.
• Remap Key Actions: Allows you to customize the behavior of the individual keys. Tap a key name to view available actions and tap the action you want to use instead.
• Allow the Kiosk to Handle Storm Keypad: Enable this option to pass key presses through directly to the kiosk application so they are not captured by JAWS. This option is off by default, and in most cases, you will want JAWS to handle all Storm keypad actions.
• Configure Storm Keycode Manually: If the standard calibration process does not work as expected, use this option to manually configure the Storm keypad by providing the key codes and scan codes for the various keys along with the headphone connect and disconnect. In most cases however, the normal calibration procedure should work correctly.

Virtual Storm Keypad Test Mode

This mode enables kiosk application developers to simulate a Storm Keypad interface using a standard keyboard for testing purposes when a physical Storm device is not available.

1. Open the JAWS for Kiosk Admin Settings.
2. Scroll to the Developer Tools group and tap Developer Settings.
3. Scroll to the Storm Keypad group and tap Virtual Storm Keypad Test Mode.
4. Tap Enable Virtual Test Mode to turn it on.
5. Select the model of Storm keypad to simulate based on what will be used with the kiosk. Available choices are 6-key or 9-key.

Once this mode is enabled, the following keys on your keyboard simulate Storm keypad actions.

• Plug in headphones: I
• Unplug headphones: O
• Up Arrow button: W
• Left Arrow button: A
• Down Arrow button: S
• Right Arrow button: D
• Middle button: ENTER

For 6-key model simulation, F6 activates the Options button.

For 9-key model simulation, the following additional keys are available.

• Increase Volume button: F5
• Decrease Volume button: F6
• Increase Speed button: J
• Decrease Speed button: K

If your kiosk requires users to enter information using an onscreen keyboard or physical keyboard, you can configure custom announcements for each edit field to be spoken by JAWS when the keyboard is displayed.

To add keyboard announcements:

Note: Before performing this procedure, it is recommended you connect headphones or speakers, so JAWS is talking. When JAWS is active, note that you need to perform a double tap gesture to activate an item. Also note that if using the onscreen keyboard, you will need to double tap on a key to enter it.

1. Open your kiosk application and place focus on the edit control you would like to add a custom keyboard announcement for.
2. Perform the JAWS gesture, One-finger swipe up and right, to open the JAWS for Kiosk Admin Task dialog box and double tap Add Keyboard Announcement. Note that if you previously logged out of the JAWS admin settings, you need to log back in before you can access this dialog box.
3. In the edit box, type the message you want spoken when the keyboard is displayed for the current edit control.
4. When finished, double tap OK to save your changes.
5. Repeat these steps again for each edit control where you want to offer a custom keyboard announcement.

Note: Keyboard announcements are language specific. For example, if you create announcements while English is the active language, they will not be spoken if you change the language to Spanish, you will need to set the kiosk application and JAWS to the appropriate language and repeat these steps to create custom keyboard announcements for that language.

To modify or remove any custom keyboard announcements:

1. Open the JAWS for Kiosk Admin Settings.
2. Scroll to the Input group and tap Manage Keyboard Announcements.
3. Select a language. Only the languages that include keyboard announcements are displayed.
4. Tap on the announcement you want to modify.
5. Make any necessary modifications to the announcement text and then tap Save.

To completely delete the specific announcement, tap Remove Keyboard Announcement.

You can customize how much information JAWS speaks as users navigate. Additionally, if your kiosk users interact using a touch screen, you can configure which gestures are used to perform specific actions.

To access these settings, Open the JAWS for Kiosk Admin Settings, scroll to the Verbosity and navigation group, and then tap Manage verbosity and navigation. Once on this screen, tap Verbosity, Sound, Customize Gestures, or Advanced settings depending on the settings you want to change.

Verbosity

Use this screen to determine the amount of information spoken by JAWS. Tap on one or more of the verbosity items to toggle them on or off depending on how much information you want spoken. Following is a brief description of each item.

Sound

Use this screen to configure audio related settings.

Overview of audio options.

Customize Gestures

For kiosks that use a touch screen, following are the default gesture assignments available to users. These should be fine in most situations.

To change the action assigned to a gesture, tap the gesture you want to change, and then tap the new action you want to assign. Tap Reset gesture settings to reset all gestures back to their defaults.

If you would like to assign gestures using multiple fingers, such as a Two-finger double tap, from the main JAWS for Kiosk Admin Settings screen, enable the Multi finger gesture support option located under the Verbosity and navigation group. When you return to the Customize gestures screen after enabling this option, multi finger gestures will now be available.

Note: Support for multi finger gestures is only available in Android 11 and later.

Advanced Settings

Use this screen to configure the following advanced options.

If you are deploying JAWS for Kiosk in multiple locations across your company or agency, you can use one installation of JAWS to make your customizations including speech and language settings, downloaded voices, dictionary rules, labels and tutor messages, and any other necessary customizations for your kiosk environment, and then export your settings to a single file. You can then save this file to a cloud-based service like Dropbox and import directly on to each kiosk device using a URL or load the settings file onto each kiosk device and then import it. This saves time, especially in large corporations that may have kiosk installations all around the country, as you do not have to manually configure JAWS on each individual kiosk. Simply export your settings, including all downloaded voices, and import the resulting file into each JAWS installation to quickly apply your configuration.

Exporting Settings

1. Open the JAWS for Kiosk Admin Settings.
2. Scroll to the Import/export group and tap Export settings to open the Export Settings wizard.
3. Do one of the following:
   • Choose the Export All Settings radio button and tap Next.
   • Choose the Export Language Settings and tap Next.
     

     

4. If you selected the option to export language settings, the next screen contains check boxes for each installed JAWS language. Select the languages you want to export and tap Next. Only settings for the selected languages will be exported.
   

   

5. In the Comment edit field, provide additional details about the export. If you chose to export all settings, this field contains “JAWS for Kiosk” along with the current date by default. If you chose to export language settings, this field contains “JAWS for Kiosk” along with the specific language and current date by default.
   

   

   

6. Select Include License if you want to include your JAWS license information in the settings file. Note that this option is not available with corporate builds and is also not available when exporting language settings.
7. Select Include Admin Password to export the password used to access JAWS for Kiosk Admin Settings on the current device. Note that this option is not available when exporting language settings.
8. Tap Export Settings, and you are prompted to choose a location to save the exported file. By default, it will be saved to your device’s Documents folder.
9. Once you have confirmed where the exported settings file will be saved, tap Save.

You can now move this settings file to a network location that can be accessed from any of your kiosk devices or store it in a cloud service like Dropbox.

Importing Settings

Before importing, make sure you have the link to your exported settings file, if stored in the cloud, or load the settings file on to the device running the new installation of the JAWS for Kiosk software.

Additionally, make sure your device has at least twice the amount of available space compared to the size of the settings file. For example, a settings file containing two voices is approximately 70 MB. This means for the import to succeed, you should have at least 140 MB of storage space available. Failing to provide sufficient storage space could potentially cause import failures.

1. Scroll to and tap JAWS for Kiosk Settings.
2. Tap Admin Settings. When prompted to enter the admin password, type “Password” and select Continue to open the main Admin Settings screen.
3. Scroll to and tap Import settings to open the Import Settings wizard.
4. 4. Depending on where your settings file is stored, do one of the following:
   • Tap From URL, enter the link to the network location where the file is stored, and tap Download. Or
   • Tap From File Storage, tap Choose File, then navigate to the location where you downloaded the JAWS settings file and select it. By default, JAWS looks in your device’s Documents folder.
     

     

5. Select one of the following depending on how you want settings to be imported:
   • Replace current settings with the new settings: Replaces all current settings with the newly imported settings.
   • Merge new settings on top of current settings: Settings from the file are imported and merged with existing settings. If there is a conflict, the setting on the device is replaced with the new setting from the file being imported.
     

     

6. Tap Apply Settings to perform the import. If you chose to include the admin password during the export process, this password will become the default password for the current device. Also, if you chose the option to include the license when exporting, JAWS will automatically be licensed on the new device following the import.
7. Repeat this process on all other devices where JAWS will be used with your kiosk software, so the same configuration is applied throughout your organization.

If you have imported multiple settings files on a device, you can select Settings Import History to review when settings were last imported. Developers can also use an SDK function to retrieve settings history data.

fun getSettingsHistory(resultListener: Result<List<SettingsHistoryData>>)

By default, JAWS only detects when headphones are connected or disconnected using the audio jack on the kiosk device or Storm keypad. To enable JAWS to also detect when USB headphones are connected or disconnected, open the JAWS for Kiosk Admin Settings, and under the Input group, tap Enable USB headphones.

JAWS for Kiosk only requires an active Internet connection for specific features, such as downloading additional voices. For general kiosk use by your customers, an Internet connection is not required to use JAWS for Kiosk. If your environment restricts Internet access, JAWS offers an Offline Mode which disables all network functionality. To enable this mode, open the JAWS for Kiosk Admin Settings, and under the Connectivity group, tap Offline Mode.

The Developer Tools screen under the JAWS for Kiosk Admin Settings is intended for use by those who develop Kiosk applications.

Manage APIs

The options on this screen are relevant for kiosks that utilize the JAWS for Kiosk SDK. Administrators can use the Advanced button to customize which APIs are used based on developer recommendations. By default, all APIs are enabled.

For example, a particular kiosk may not require modification of Import/Export settings through the SDK, but still wants to be able to utilize all other APIs. In this case, the administrator can conveniently turn off the Enable Import/Export API through the Advanced settings while leaving all other API options enabled.

If the Enable APIs option is turned off, the connection between the kiosk and SDK is completely closed and the Advanced settings are not available.

Developer Settings

The Developer Settings screen is specifically intended for use by JAWS for Kiosk developers. Changes made here can potentially impact overall usage of JAWS. It is recommended that administrators and users not access or modify these settings unless explicitly instructed to by TPGI support.

The Advanced Settings Screen under the JAWS for Kiosk Admin Settings currently offers one option: Enable JAWS for Kiosk in Direct Boot mode. Enabled by default, JAWS speaks using the pre-installed English voice when a secured Android device is in Direct Boot mode until the device is unlocked using a PIN or Pattern lock. Turn off this option if you do not want JAWS to work in Direct Boot mode.

Logs

While JAWS for Kiosk is running, it creates a log that can be submitted to our development team for troubleshooting in the event you encounter any issues with the software. To access the logs, open the JAWS for Kiosk Admin Settings, and under the Logging and Diagnostics group, tap Manage Logging. The following items are available:

Diagnostics

JAWS for Kiosk allows you to view various diagnostic information which could be useful if you ever need to perform any troubleshooting. To access these details, open the JAWS for Kiosk Admin Settings, and under the Logging and Diagnostics group, tap Diagnostics. The following items are available:

Developers can also use an SDK function to return diagnostic JSON data.

fun getDiagnosticsData(resultListener: Result<JSONObject>)

JAWS for Kiosk needs some Android permissions, which are special privileges that apps must ask the user for approval to use when they want to access sensitive information on your device. Users can check the permissions that we have granted to installed apps at any time. Open Settings > Apps > Manage Apps > App Permissions to view a breakdown of the major permissions.

The following table lists the available permissions and how they impact JAWS for Kiosk performance.

The JAWS for Kiosk software product does not automatically collect, transmit, log or otherwise share any data (including any personally identifiable data) with any third parties. The User may choose to enable certain product features that will allow the collection of certain data (these features can be enabled/disabled at any time) as further described below. In order to manage these data collection features, head to “Manage Logging” in the settings.

1) Turn on “Enable Log”

This will allow JAWS for Kiosk to collect descriptive data including,:

• JAWS for Kiosk starting and stopping events.
• Language events (currently spoken language, on adding a language, on language change, on changing language detection mode).
• Voice statistics.
• Text to speech events (Text to speech start and stop events).
• Custom labels and Tutor Messages (on inserting new Custom Labels and Tutor Messages, on deleting Custom Labels and Tutor Messages, on finding views with Custom Labels and Tutor Messages).
• Dictionary (on adding/deleting entries).
• Import/Export Events.

Any personal information entered into the Dictionary and Custom Labels and Tutor Message is not tracked. The app collects only event-related information (such as whether the dictionary entries were successful or not).

This data will be used solely for monitoring the JAWS for Kiosk app behavior.

2) Turn on “Report Crashes Automatically”

If both “Enable Logging” and “Report Crashes Automatically” are enabled, the crashes will be submitted to App Centre. Crash reports include the following data: Country, Language, OS, Device manufacturer, and details about the crash including logs. The crash reports will be used to get a holistic view of performance and make a better user experience.

To help optimize the deployment process across organizations, JAWS for Kiosk supports Mobile Device Management (MDM) solutions such as Eloview, VMware, and Esper. This section contains general info on how to apply settings over MDM
and provides steps on deploying over Eloview.

Applying Settings in MDM

Once JAWS for Kiosk is installed on your devices, exit the kiosk mode of the device and make sure the JAWS for Kiosk accessibility service is enabled. You can do this in the device settings by going to Accessibility and then Installed or Downloaded Services depending on the device manufacturer.

To use Managed App configuration, you need to upload the settings file to a hosting service like Dropbox and generate a URL with read access. Note that redirecting URLs are not supported.

Next, find the Managed App configuration in your MDM portal, and add configuration for JAWS for Kiosk.

Finally, configure JAWS for Kiosk to import settings from your MDM portal by doing the following:

1. Open the JAWS for Kiosk Admin Settings.
2. Scroll to the MDM Management group and tap Manage MDM Devices.
3. Tap Enable MDM Settings Import. Turning this feature on allows JAWS for Kiosk to import
   settings from an MDM.
4. Use the Path to read Settings files for MDM option to specify the path where your settings file
   is stored. JAWS for Kiosk checks this path for new settings.

Configuration format

• Key: URLBaseSetting
• Type: String
• Value: { URL to download base settings. (Redirection URLs are not supported)}
• Key: languages
• Type: Bundle Array
• Key: item
• Type: Bundle
• Key: language_code
• Type: String
• Value: { Language code }
• Key: url
• Type: String
• Value: { URL to download language packs. (Redirection URLs are not supported)}

Restriction format

<restrictions xmlns:android="http://schemas.android.com/apk/res/android">
                        <restriction android:key="URLBaseSetting"
                            android:title="@string/base_url"
                            android:description="@string/base_url_des"
                            android:restrictionType="string" />
                        <restriction android:key="languages"
                            android:title="@string/language_url"
                      android:description="@string/language_url_des"
                            android:restrictionType="bundle_array">
                            <!-- Bundle array must have one bundle restriction -->
                            <restriction android:key="item"
                                android:title="@string/language_item"
                                android:restrictionType="bundle">
                                <restriction android:key="language_code"
                                    android:restrictionType="string"
                      android:title="@string/language_item_code"/>
                                <restriction android:key="url"
                                    android:restrictionType="string"
                      android:title="@string/language_item"/>
                            </restriction>
                        </restriction>
                    </restrictions>
                    

JSON File Example

JSON example for managing settings with base settings and two language packs.

{
                    	"URLBaseSetting": "<URL to your base settings file>",
                    	"languages": [{
                    		"language_code": "en-EN",
                    		"url": "<URL to your first language pack>"
                    	}, {
                    		"language_code": "es-ES",
                    		"url": "<URL to your second language pack>"
                    	}]
                    }

Deploying Over Eloview

Note: Contact your TPGi sales representative if you need documentation for other MDM platforms.

Before you begin, ensure you have an EloView account and an enrolled device.

Upload APK:

1. Open Eloview management.
2. Navigate to Content.
3. Click the + button to the Left of the App Library.
4. Select APK.
5. Enter “JAWS for Kiosk” as the App Name.
6. Click Select and choose the JAWS for Kiosk APK from your file browser.
7. Click Add content.
8. Repeat these steps again for Uploading any additional APK files like your kiosk application.

Prepare settings for loading to Eloview (File and folder names are very important here):

1. Obtain the settings file exported from JAWS for Kiosk.
2. Name the base settings file “JAWSSettingsForMDM.jaws.”
3. If you have language pack settings, name it “JAWSSettingsForMDM-{two letter language code}-{two letter country
   code}.jaws.” For example, JAWSSettingsForMDM-en-US.jaws.
4. Create a Folder named “JAWSSettings.”
5. Move the Settings files to the “JAWSSettings” folder you created.
6. Zip the folder.

Upload settings:

1. Open Eloview management.
2. Go to Content.
3. Click the + button to the Left of the App Library.
4. Select Media.
5. Enter “JAWSSettings” as the name (very important).
6. Select the ZIP file you created in the previous procedure.
7. Click Add content.

Create bundle:

1. Open Eloview management.
2. Go to Content.
3. Click the + button to the Left of the App Library.
4. Select Smart Apps.
5. Switch to Bundle.
6. Enter a name for the bundle.
7. Select Foreground App.
8. Select your kiosk application from the List and click Select.
9. Select Background App.
10. Drag JAWSSettings to 1.
11. Drag JAWS for Kiosk to 2.
12. Select the check box below 2 and click Select.
13. Add content.

Once all of these steps are complete, deploy the bundle to your devices.

PUBLISHED BY
TPGi
www.TPGi.com

For sales, call +1 (877) 775-9474 or email Info@TPGi.com.

For customer and technical support, email kiosksupport@TPGi.com.

Information in this document is subject to change without notice. No part of this publication may be reproduced or transmitted in any form or any means electronic or mechanical, for any purpose, without the express written permission of TPGi.

Copyright © 2023 TPGI. All Rights Reserved.

JAWS is a registered trademark of Freedom Scientific in the United States and other countries.

Android is a trademark of Google LLC.