modules:module-settings

Module Settings

Barge-In

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.
Notes

Barge-In is enabled by default on several modules.


Canada

This setting allows end-users to enter either an American or Canadian address.
Enabling the ‘Canada’ setting extends the capability to include Canadian data in addition to, but not in lieu of U.S. data. There is no ‘Canada only’ option or functionality.

When active, the ‘City/State’ menu item changes to ‘City/State or Province’, and the ‘State’ menu item changes to ‘State or Province’.
Notes

The 'Canada' setting is unique to the Address ( ) module.


Compare Types

There are 3 different types of variables that can be used in the module.

  • String (default)
  • Number
  • Boolean

Most of the variables generated by input modules in the Fuse application are by default string types, therefore it is important to set the correct type when doing comparisons.

Any text entered into the module are compared as-is and the module does not evaluate any Javascript before the comparison.
Comparing for undefined or null values are not possible with this module as all input in the module will be converted to either of the 3 formats.


Type Notes Example
String The string compare type is used by default in the module.
Only = or ≠ operators should be used for string types.
Number When selected, Fuse will apply a javascript Number() function to both fields before making the comparison.

Using the incorrect compare type for numbers can have unexpected results because of how Javascript behaves with certain comparison operators and types. For example, “9” > “100” as string types, while 9 < 100 as number types.
Boolean True or False should be used for boolean comparisons.
Only = or ≠ operators should be used for boolean types.

Date or Time

This setting is toggles between the 'Date' and the 'Time' mode.

Enable Speech Input

This setting enables Automatic Speech Recognition (ASR) for that module.
A green microphone ( ) icon appears in the module when this is enabled.
Notes

ASR is automatically enabled in the Address ( ) and Name ( ) modules.


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.

Enable Speech Input (Dynamic Menu)

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

This setting allows expects additional “utterance” field much like the setting in a normal Menu ( ) module.

The following code shows the expected data structure for using utterance:
[{
  "dtmf": 1,
  "value": "red",
  "prompt": { "en-US": "For red, press 1 or say red", "es-US": "Para rojo, oprima 1 o diga rojo" }
  "utterance": { "en-US":"red","es-US": "rojo" }
 }, {
  "dtmf": 2,
  "value": "green",
  "prompt": { "en-US": "For green, press 1 or say green", "es-US": "Para verde, oprima 2 o diga verde" }
  "utterance": { "en-US":"green","es-US": "verde" }
 }, {
  "dtmf": 3,
  "value": "blue",
  "prompt": { "en-US": "For blue, press 1 or say blue", "es-US": "Para azul, oprima 3 o diga azul" }
  "utterance": { "en-US":"blue","es-US": "azul" }
}];

Final Silence

This setting establishes the threshold, in seconds, of silence necessary to trigger the end of a recording.
Acceptable number values range from 1 to 14400.
The default setting for Final Silence is 3 seconds.

For example, if this is set to 3 seconds, the recording stops once an end-user stops speaking for three consecutive seconds. To force-stop a recording, end-users can use any DTMF input.
Notes

The 'Final Silence' setting is unique to the Record ( ) input module.


Format as Currency

This setting changes the module to accept currency as the input, instead of a decimal number.
For speech inputs, it can understand “dollar” and “cents” formats, and no longer accepts “point” words.

To accept whole numbers only (ex: dollars) in currency, set both the min and max decimal point setting to 0. Other min/max configurations with currency enabled will allow either whole number or 2 decimal places for cents.

The output of the variable in currency mode will always be in X.XX format, even if the input is a whole number.
Notes

The 'Format as Currency' setting is unique to the Number ( ) module.


Hold Music

Enable this setting to play audio while an end-user is on hold.
To upload a file for hold music, go to Application Settings > Connection Settings > Webservices > Webservice fetch audio.

Max Length

This setting establishes the maximum threshold, in seconds, for how long to record audio.
Acceptable number values range from 1 to 14400 seconds.
The default setting for Max Length is 300 seconds (or 5 minutes).
Notes

The 'Max Length' setting is unique to the Record ( ) input module.


Max Decimal Places

It allows users to set the maximum number of allowable decimal places for end-user input.
Acceptable number values range from 0 to 9.

If the Format as Currency setting is enabled, the Fuse+ platform will only recognize this setting if the value is 0 (for whole numbers) or 2 (for cents).
Notes

The 'Max Decimal Places' setting is unique to the Number ( ) module.


Min Decimal Places

It allows users to set the minimum number of allowable decimal places for end-user input.
Acceptable number values range from 0 to 9.

If the Format as Currency setting is enabled, the Fuse+ platform will always use 0 as the min decimal place regardless of what is set here.
Notes

This setting is unique to the Number ( ) module.


Max Digits

It allows users to set the maximum number of allowable digits for end-user input.
Acceptable number values range from 1 to 128.

If the min and max digits are set to the same number, the module will only accept input of that length.
Notes

The 'Max Digits' setting is unique to the Number ( ) module.


Min Digits

It allows users to set the minimum number of allowable digits for end-user input.
Acceptable number values range from 1 to 128.

If the min and max digits are set to the same number, the module will only accept input of that length.
Notes

The 'Min Digits' setting is unique to the Number ( ) module.


Module Size

This setting allows users to toggle the size of the Fuse module between Small and Large.
This setting only affect size of the module cosmetically in the editor.

Play Beep

This settings enables the module to play an audible beep for end-users before starting the recording.
Notes

The 'Play Beep' setting is unique to the Record ( ) input module.


Private

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.

Show Custom Errors (Evaluate JS)

This setting can be used to catch any errors that might occur when evaluating the Javacsript.

Show Custom Errors (Subdialog)

This setting can be used to catch any server fetch errors that might occur when attempting to open the subdialog.
It is recommended that a call flow to be set to this error so the call flow can continue in the scenario that the web service is not available.
The two most common errors that users see with this module occur when a server times out or the subdialog application returns invalid data.

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.

Show Custom Errors (Transfer)

This setting can be used to catch any error that occur during the transfer.
This setting displays 'Error' and 'No Answer' options.
If a transfer experiences a connection timeout with 'Show Custom Errors' enabled, the call automatically flows to 'No Answer'. If this setting is not enabled, the call disconnects.

Show Custom Errors (REST)

This setting can be used to catch any error that occur with the REST call.
It can be used to branch off non-2XX responses from the web server.

To get the exact HTTP response code from the request, please refer to the Shadow Variables section.

Show Custom Errors (SOAP)

This setting can be used to catch any error that occur during the SOAP call.
The two common errors associated with a SOAP webservice are timeouts and faults. The latter are custom SOAP errors.

Show Custom Timeouts

Enabling this setting allows users to establish custom timeout error handling for that specific module.
It will override the default global webservice timeouts in Application Settings > Connection Settings.

Enabling this presents users with two new forms in the module: Connect Timeout and Maximum Timeout.

The default durations are:
Connect Timeout: 30 seconds
Maximum Timeout: 0 (unlimited)
Notes

The 'Show Custom Timeouts' setting is unique to the Transfer ( ) module.


Show Events

Enabling it generates a field in the module that allows users to enter a custom event name for subdialogs.
To branch the call off an event, use the node to the side of the event ( )

In the VoiceXML subdialog, an event can be set by using
<return event="event_name"/>


For example, for a VoiceXML that returns a region event based on a zip code entry, events can be used to return any invalid zip, or perhaps it is a valid zip, but one that does not belong to a specific market region.

See the following:


The above scenario would have a corresponding VoiceXML that would have the following events in the code.

<return event="invalid_zip"/>
<return event="not_in_region"/>
Notes

The 'Show Events' setting is unique to the Subdialog ( ) call-flow module.


Show Headers

Enabling it generates a field in the module that allows users to enter custom headers for REST webservice requests.
Each header should be on a separate line with the header name and associated value separated by a colon.
Notes

The 'Show Headers' setting is unique to the REST ( ) data module.


Timeout Length

This allows users to set the maximum time, in seconds, that elapse before returning a timeout error. This applies modules that fetch outside scripts, like the SOAP, REST, or subdialog modules.

The default value for Timeout Length is 30 seconds.
Acceptable number values range from 1 to 120.
modules/module-settings.txt · Last modified: 2018/12/11 17:54 by admin