Module Settings

Users have access to settings that can alter the functionality of a specific module.

Not every setting is available in every module.

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

Compare Types

There are 3 different types of comparisons 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.

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

Notes

Enable Speech Input (Menu)

Enable Speech Input (Dynamic Menu)

[{ "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

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

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.

Interdigit Timeout

This allows users to set the maximum time, in seconds, that elapse between inputting digits before returning a timeout error. This applies to all input modules that accept multiple digits, like Date/Time, Number, and Digits.

The default value is 1 second. Acceptable number values range from 1 to 60.

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

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

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

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

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

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

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

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)

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 (SMS)

When enabled, this setting adds an Error transmitter to the module. As shown in the following image, this can be used to set an alternate call flow if an error is returned.

  • Note: For sample errors returned on failure, see the SMS API page for DEV.

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

Show Events

<return event="invalid_zip"/>

<return event="not_in_region"/>

Notes

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

Submit on Max

The 'Submit on Max' setting only appears when a value is entered in the 'Max Digits' option field. When enabled, the 'Submit on Max' option forces the call to the next module in the call-flow immediately upon reaching the indicated Max Digits. By default, the call-flow pauses momentarily between the end of end-user data input and call-flow progression. This option eliminates that pause.

Notes

Timeout Length

This allows users to set the maximum time, in seconds, that elapse before returning a timeout error. This applies to 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.

Last updated