From Bright Pattern Documentation
Jump to: navigation, search
 
(Updated via BpDeleteTranslateTags script)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<translate>= Menu=
+
= Menu=
The Menu scenario block plays a menu prompt with options to choose from and then allows the caller to select an option by pressing a DTMF key.
+
[[File:Menu-Scenario-Block.png|225px|Scenario Builder Menu scenario block]]
 
 
  
[[File:Menu-Scenario-Block.png|225px|Scenario Builder Menu scenario block]]
 
  
 +
The Menu scenario block plays a menu prompt with options to choose from and then allows the caller to select an option by pressing a dual-tone multi-frequency (DTMF) key. DTMF refers to telephone touch-tones  (numbers from 0 to 9, as well as symbols # and *), which are transmitted from phones to other communication devices, such as IVR.
  
 +
== How It Works ==
 
The Menu block moves through the following steps:
 
The Menu block moves through the following steps:
# The menu prompt announces options with corresponding keys from a phone keypad (0-9, *, #). Each selected option corresponds to a conditional exit.
+
# The menu prompt announces options with corresponding keys from a phone keypad (0-9, *, #). Each selected option corresponds to a conditional exit.<br /><br />
# The caller presses the key corresponding to the desired menu option.
+
# The caller presses the key corresponding to the desired menu option.<br /><br />
 
# The block receives the input from the caller and processes the corresponding conditional exit.
 
# The block receives the input from the caller and processes the corresponding conditional exit.
  
Line 14: Line 14:
 
If a key is not defined, it has no meaning and is considered invalid. The Menu block informs the caller if the input is invalid, or if the time allotted for the caller to enter digits expires. If a caller enters an invalid option or does not enter an option in the allotted time, the scenario executes the subsequent block in the flowchart.
 
If a key is not defined, it has no meaning and is considered invalid. The Menu block informs the caller if the input is invalid, or if the time allotted for the caller to enter digits expires. If a caller enters an invalid option or does not enter an option in the allotted time, the scenario executes the subsequent block in the flowchart.
  
To assign a menu option to a key, select the checkbox corresponding to that key in the '''Valid choices''' section. When you enable a key, a text field appears where you can enter a description of the option enabled by this key. The description you enter here will appear in the flowchart as the label of the conditional exit corresponding to the key. By default, the label is the key name.
+
== Properties ==
 +
[[File:Menu-Block-Settings.png|650px|thumbnail|center|Scenario Builder Menu scenario block settings]]
  
  
== Conditional Exits ==
+
=== Prompt to play ===
With the Menu block, you can configure a conditional exit for each telephone key (0-9, *, #). By default, the block has conditional exits for keys 1 and 2.
+
''Prompt to play'' is the prompt that the scenario initially plays to the caller. Usually this prompt explains the available menu options. For example, the prompt can say, ''For customer service, press 1, for technical support, press 2, to speak with an operator, press the pound sign.''
  
 +
Learn more about managing prompts in this guide's [[5.3:Scenario-builder-reference-guide/VoicePrompts |  Voice Prompts]] section.
  
== Prompts ==
+
=== Valid choices ===
=== Prompt to play ===
+
These are the numeric key values assigned to each menu option. To assign a menu option to a key, select the checkbox corresponding to that key.  
''Prompt to play'' is the prompt that the scenario initially plays to the caller. Usually this prompt explains the available menu options. For example, the prompt can say, ''For customer service, press 1, for technical support, press 2, to speak with an operator, press the pound sign.''
 
  
=== Timeout prompt ===
+
When you enable a key, a text field appears where you can enter a description of the option enabled by this key. The description you enter here will appear in the flowchart as the label of the conditional exit corresponding to the key. By default, the label is the key name.
The ''Timeout prompt'' is the prompt that the scenario plays when the time allotted for the caller to respond expires.
 
  
 
=== Invalid input prompt ===
 
=== Invalid input prompt ===
 
The ''Invalid input prompt'' is the prompt that the scenario plays when the caller enters an invalid key. Click '''Select''' to choose to ignore a specific invalid digit selection.
 
The ''Invalid input prompt'' is the prompt that the scenario plays when the caller enters an invalid key. Click '''Select''' to choose to ignore a specific invalid digit selection.
 
=== Short version of main prompt ===
 
The ''short version of the main prompt'' (''Prompt to play'') is what the scenario plays after the ''Timeout prompt'' and ''Invalid input prompt''. This prompt can remind the caller about the available menu options.
 
 
 
== Settings ==
 
[[File:Menu-Block-Settings.png|650px|thumbnail|center|Scenario Builder Menu scenario block settings]]
 
 
  
 
=== Allow interrupting prompt by a phone button ===  
 
=== Allow interrupting prompt by a phone button ===  
 
Select this setting in order to allow callers to interrupt the prompts by entering the desired option at any time; uncheck this setting if input is not allowed until the prompt is complete.
 
Select this setting in order to allow callers to interrupt the prompts by entering the desired option at any time; uncheck this setting if input is not allowed until the prompt is complete.
 +
 +
=== Ignore invalid choices ===
 +
Select this setting to ignore the caller's invalid input. If a caller enters an invalid option, the scenario executes the subsequent block in the flowchart.
  
 
=== Input Timeout ===  
 
=== Input Timeout ===  
 
''Input Timeout'' is the number of seconds that the scenario waits for a caller’s input after playing the initial prompt or its short version before playing the Timeout prompt. If left blank, the block will wait for input indefinitely.
 
''Input Timeout'' is the number of seconds that the scenario waits for a caller’s input after playing the initial prompt or its short version before playing the Timeout prompt. If left blank, the block will wait for input indefinitely.
 +
 +
=== Timeout prompt ===
 +
The ''Timeout prompt'' is the prompt that the scenario plays when the time allotted for the caller to respond expires.
 +
 +
=== Short version of main prompt ===
 +
The ''short version of the main prompt'' (''Prompt to play'') is what the scenario plays after the ''Timeout prompt'' and ''Invalid input prompt''. This prompt can remind the caller about the available menu options.
  
 
=== Retries ===  
 
=== Retries ===  
 
''Retries'' represents the maximum number of times that the voice application will allow the caller to provide input after the input timeout expiration or invalid input. If the number of retries is reached without successful input, the scenario moves to the next block in the flowchart. This parameter can either be set explicitly or via a scenario variable. This parameter can be set to zero to exit menu without retries.
 
''Retries'' represents the maximum number of times that the voice application will allow the caller to provide input after the input timeout expiration or invalid input. If the number of retries is reached without successful input, the scenario moves to the next block in the flowchart. This parameter can either be set explicitly or via a scenario variable. This parameter can be set to zero to exit menu without retries.
  
 
+
== Conditional Exits ==
 
+
With the Menu block, you can configure a conditional exit for each telephone key (0-9, *, #). By default, the block has conditional exits for keys 1 and 2.
 
 
<center>[[scenario-builder-reference-guide/Log|< Previous]]  |  [[scenario-builder-reference-guide/PlayPrompt|Next >]]</center>
 
</translate>
 

Latest revision as of 04:03, 29 May 2024

• 5.19 • 5.3 • 5.8

Menu

Scenario Builder Menu scenario block


The Menu scenario block plays a menu prompt with options to choose from and then allows the caller to select an option by pressing a dual-tone multi-frequency (DTMF) key. DTMF refers to telephone touch-tones (numbers from 0 to 9, as well as symbols # and *), which are transmitted from phones to other communication devices, such as IVR.

How It Works

The Menu block moves through the following steps:

  1. The menu prompt announces options with corresponding keys from a phone keypad (0-9, *, #). Each selected option corresponds to a conditional exit.

  2. The caller presses the key corresponding to the desired menu option.

  3. The block receives the input from the caller and processes the corresponding conditional exit.


If a key is not defined, it has no meaning and is considered invalid. The Menu block informs the caller if the input is invalid, or if the time allotted for the caller to enter digits expires. If a caller enters an invalid option or does not enter an option in the allotted time, the scenario executes the subsequent block in the flowchart.

Properties

Scenario Builder Menu scenario block settings


Prompt to play

Prompt to play is the prompt that the scenario initially plays to the caller. Usually this prompt explains the available menu options. For example, the prompt can say, For customer service, press 1, for technical support, press 2, to speak with an operator, press the pound sign.

Learn more about managing prompts in this guide's Voice Prompts section.

Valid choices

These are the numeric key values assigned to each menu option. To assign a menu option to a key, select the checkbox corresponding to that key.

When you enable a key, a text field appears where you can enter a description of the option enabled by this key. The description you enter here will appear in the flowchart as the label of the conditional exit corresponding to the key. By default, the label is the key name.

Invalid input prompt

The Invalid input prompt is the prompt that the scenario plays when the caller enters an invalid key. Click Select to choose to ignore a specific invalid digit selection.

Allow interrupting prompt by a phone button

Select this setting in order to allow callers to interrupt the prompts by entering the desired option at any time; uncheck this setting if input is not allowed until the prompt is complete.

Ignore invalid choices

Select this setting to ignore the caller's invalid input. If a caller enters an invalid option, the scenario executes the subsequent block in the flowchart.

Input Timeout

Input Timeout is the number of seconds that the scenario waits for a caller’s input after playing the initial prompt or its short version before playing the Timeout prompt. If left blank, the block will wait for input indefinitely.

Timeout prompt

The Timeout prompt is the prompt that the scenario plays when the time allotted for the caller to respond expires.

Short version of main prompt

The short version of the main prompt (Prompt to play) is what the scenario plays after the Timeout prompt and Invalid input prompt. This prompt can remind the caller about the available menu options.

Retries

Retries represents the maximum number of times that the voice application will allow the caller to provide input after the input timeout expiration or invalid input. If the number of retries is reached without successful input, the scenario moves to the next block in the flowchart. This parameter can either be set explicitly or via a scenario variable. This parameter can be set to zero to exit menu without retries.

Conditional Exits

With the Menu block, you can configure a conditional exit for each telephone key (0-9, *, #). By default, the block has conditional exits for keys 1 and 2.

< Previous | Next >