modules:number

This is an old revision of the document!


Number

Function

This module collects numeric data. Numbers can be any whole or decimal value. When entering a decimal value the star key (*) functions as the decimal.

Note: For simple digits only input such as account number, credit card number, date of birth, please use the Digits ( ) module. The digits module handles individually spoken digits such as “One Two Nine”, whereas the Number module is designed for spoken numbers such as “one hundred twenty-nine”.


For currency input, please use the Format as Currency setting. This not only changes the way the Automated Speech Recognition expects the voice input, it also . For more information, please refer to the setting description below.


If both the minimum and maximum decimal places are set, then any input that does not match will return an error.
For example, if the minimum is set to 2 and the maximum to 4, values like 5.4 or 5.49281 would both be invalid.

If the min and max are set to the same number then the input value must be that exact length.
For example, if the min and max are both set to 2, then 5, 5.4, and 5.492 would all be invalid input, but 5.49 would be valid.


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.

Note: This setting is enabled by default.


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.

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.

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

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.

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.

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/number.1535483884.txt.gz · Last modified: 2018/08/28 19:18 by admin