modules:compare-variable

Compare Variable

Function

This module provides a way to compare variables and to re-direct end-users to a different area of the call-flow based on the value of a variable.
Additional comparison conditions can be added / removed from the module by pressing the add and remove ( ) buttons.

If a comparison condition is true, the call will be directed to the node to the side of that condition ( ).
If none of the conditions are true, the call will go through the node at the bottom of the module ( ) .


Depending on the value and variable in the comparison, the correct type should be used to avoid any unexpected results. For more information, please refer to the compare types section under settings.


This module is commonly used with end-user input, or when getting results from a webservice for branching into different parts of the call flow based on the result.

Note: For a simpler increment counter, the Counter ( ) can be used instead of the comparison as it has a built in increment logic for the counting variable.


Comparisons

The following comparison operators can be selected in the drop down

  • Equals to ( = )
  • Greater than ( > )
  • Lesser than ( < )
  • Greater than or equals to ( ≥ )
  • Lesser than or equals to ( ≤ )
  • Not equals to ( ≠ )

It is recommended to only use the equals ( = ) and not equals to ( ≠ ) operators for string and boolean types.


Module Settings

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.

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.

modules/compare-variable.txt · Last modified: 2018/08/28 15:16 by admin