This module provides users with a way to branch on, and collect complex input.
Menus enable users to create multiple choice questions where each option is associated with a value, where it will be saved to the menu variable upon a valid entry.

Options can be added or removed with the add / remove buttons ( ).
The maximum number of options available in the module is 10, with a minimum choice of 1.

Audio Prompts

With this module, in addition to the user prompt text (“Welcome to the sample menu. ), built-in prompts ( ) entry will be automatically created in the Prompt Table for every menu option available. (“For value, press DTMF.” )

Clearing Prompts
The built-in prompt can be changed to a different text, or blank out completely if the entire menu resides within the user prompt text.
In the scenario where there is a repeat option, if there are no inputs, or if the caller entered an invalid choice, the entire module prompts will be repeated to the caller.

If there are any portion of the voice prompts that should not be repeated, they should be separated out in a Prompt ( ) module before the menu system,


If the user input matches one of the menu options that is listed, the call flow will follow the path to the node on the side of the menu option ( ) .
If the option node is not connected ( ), then call-flow will go through the bottom node of the module ( ).

This can be useful to capture multiple selections that follows the call flow without needing to create a link for all the options available. The menu variable can then be used to determine the value that was set.

See the following exaxmple:

The call reaches the fruit_menu module that awaits for a DTMF entry

The call path will be different depending on the caller's input:
1: Goes right to apple_menu
2-5: Goes down to fruit_result_prompt
Other: No Match error

Module Settings

This setting allows callers to interrupt a prompt before it finishes playing.
When enabled, DTMF input interrupts the prompt and progresses the call forward in the call-flow. If speech recognition is enabled on the ensuing module in the call-flow, then end-users can also interrupt the prompt with a spoken utterance, too. Disabling barge-in forces callers to listen to the entire prompt.

A barge-in enabled module will have a dashed line on top of the text box. See example here.

Note: This setting is enabled by default.

Enable Speech Input (Menu)
This setting enables Automatic Speech Recognition (ASR) for the menu module.
A green microphone ( ) icon appears in the module when this is enabled.

Enabling speech recognition generates an additional column in the module called ‘Utterance’.
Each option line includes a DTMF input, a speech utterance, and a corresponding value.
The DTMF and speech inputs can be different, as the system expects the utterance as speech input, but the menu variable will carry the actual value.

With the example above, if the user press 1 or says “Eastern”, the sample_voice_menu variable will carry the value “est”.

Note: Utterance is required to be filled when expecting any speech input. Even if the utterance is the same as value, the utterance field cannot be blank.
For accepting multiple utterances for a selection, a new, separate choice needs to be created and they can both branch into the same module, or have the same value.

The audio manager auto-generates prompts for these options in the format of “For <value>, Press <DTMF> or say <utterance>”.

To set the utterance for other languages in the application, the corresponding language tab in audio manager will have an utterance entry for each choice, along with an utterance icon ( ) in the left and the primary language text underneath for identification.

Note: It is recommended to only enable speech recognition when absolutely necessary. Introducing speech recognition increases the chance of errors occurring and can detract from the end-user experience.

This setting controls the logging function of a module.
Enabling the 'Private' setting instructs the module to not record, report, or retain the information input to that module for reporting or any other purposes. When enabled any information entered into a module during a call will be lost immediately when the call terminates.
The 'Private' setting is critical for businesses that need to maintain PCI-DSS or HIPAA compliance.

The module icon, in the upper left-hand corner, becomes grayed-out when this setting is enabled. See more details here.

Show Custom Errors
Enabling this setting overrides the default, global error options set in the Application Settings > User Input Settings.
This allows users to establish custom error handling in order to act on errors in a specific way in that module.
Instead of progressing to the next module in the call-flow, custom error handling allows users to re-prompt the same module, to provide a custom error message, to re-direct the call based on the error, or any other desired behavior.

Adding multiple errors ( ) to a module functions behave the same way as a counter.
The first error follows the path for the first error listed, if a second error occurs in the same module it follows the second listed error, and so on until all errors are exhausted or an error directs the end-user away from that module.

No Input occurs when the caller does not provide an input based on the timeout settings.
This is based on the “Initial input timeout” in User Input Settings

No Match occurs when the caller input does not match the module's criteria for the input module.

Advanced Settings: Advanced Fuse users may want to use shadow variables that are available with input modules. For more information on this functionality, please visit the Shadow Variables page.

modules/menu.txt · Last modified: 2020/01/09 16:04 (external edit)