Soundex

Verb: soundex

Available from: <Enterprise>

Converts text to code using the selected Soundex algorithm.

The Soundex algorithms convert an alphanumeric character string into code. These characters are based on their own phonetics, that is, on the way they are spoken, rather than written.

Syntax

soundex --culture(Culture) --text(String) --algorithm(SoundExAlgorithms) (String)=value

Inputs

Script Designer Required AcceptedTypes Description
--culture Language Required Culture Language in which the text is written. Options:
  • en-US
  • pt-BR
  • pt-PT
    		•
    --text Text Required Text Text that should be converted according to the defined algorithm.
    --algorithm Algorithm Required SoundExAlgorithms Algorithm that is used to convert the text. Options:
  • Fonetico
  • KnuthEd2
  • Metaphone
  • Miracode
  • Simplified
  • SQLServer
    		•

    Outputs

    Script Designer AcceptedTypes Description
    value Value Text Returns the text converted by the selected Soundex algorithm.

    Example

    The command is used to convert the text "hotel" with Metaphone Algorithm.

    defVar --name convertedText --type String
soundex --culture en-US --text hotel --algorithm "Metaphone" convertedText=value
logMessage --message "${convertedText}" --type "Info"
// Result: HTL

    See Also

  • Approximately Equal
  • Text Lookup