modules:address

Address

Function

This module collects address information. Users have the choice between collecting street address, city/state, or state-only information.

An ‘Address’ ( ) module can collect one piece of address information at a time. If a user wants to collect the street address, city, state, and ZIP code, they need to use two separate ‘Address’ ( ) modules and one ‘Digits’ ( ) module.

When collecting all three pieces of address information, the recommended order for collection is:

  • ZIP Code (Use the 'Digits' module for this)
  • City/State
  • Street Address

This is because multiple cities can have streets with the same name.

When the address is read back to the caller, the variable type “address” should be used. See Text-to-speech Variable Types for more information.

Note: Speech recognition is enabled by default for the 'Address' ( ) module. It cannot be turned off. This is indicated by a green microphone icon in the text field.


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.

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.

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: At present, Fuse cannot collect street data for Canadian addresses, only city and/or provinces.


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/address.txt · Last modified: 2018/10/30 13:26 by admin