Providing a Custom Help Prompt

The Vocera system provides a Help command to help users learn how to use their Vocera devices.

The Help command does not result in a predefined response. Instead, you can record your own Help prompt as a WAV file and place it in the correct folder on the Vocera Voice Server. The Help prompt could be used to direct users to a Vocera super user, an administrator, an internal Web site, or a local help desk for assistance.

To provide a custom Help prompt for your Vocera system:

  1. Create a WAV file named help_top_level.wav.
    The WAV file must use the required audio format and sampling rate. See Required Format of Audio Prompt Files.
  2. Place the help_top_level.wav file in the following folder on the active Vocera Voice Server:


    Important: Before putting a WAV file onto a production Vocera Voice Server, you should always test it first on a staging server. If the Nuance service is unable to play a WAV file because it was recorded incorrectly, the service throws an exception, which causes the Vocera Voice Server to restart.
  3. If you have a Vocera Voice Server cluster, restart the standby nodes to force a remote restore. This causes the custom Help prompt to be replicated on the standby nodes.
  4. To test the help prompt, log into a Vocera badge and say the command, "Help."
    The badge should play your custom WAV file.
Note: If the help_top_level.wav file is missing from the \vocera\data\prompts\custom folder, when a badge user says the "Help" command the system uses the standard Help prompt: "No help is currently available."