Extract Monetary Value

Description

This command extracts monetary values from text using natural language processing.

The results that this command returns might vary according to the selected NLP provider. For more information, see Setting an NLP provider.

Script syntax

IBM RPA's proprietary script language has a syntax similar to other programming languages. The script syntax defines the command's syntax in the script file. You can work with this syntax in IBM RPA Studio's Script mode.

extractCurrency --culture(Culture) [--numberascurrency(Boolean)] [--minimumvalue(Numeric)] --text(String) (List<Money>)=values (Money)=first (DataTable)=valuesmapping (Boolean)=success

Input parameter

The following table displays the list of input parameters available in this command. In the table, you can see the parameter name when working in IBM RPA Studio's Script mode and its Designer mode equivalent label.

Output parameter

Example

Example 1: The following example defines English as the language to extract monetary values ​​from text with Minimum value 10. The first value is not extracted properly due to the bad format of the monetary value. On the other side, the command extracts the second value properly because the monetary value is formatted according to the selected language.

defVar --name extractText --type String
defVar --name extractedValues --type List --innertype Money
defVar --name firstValue --type Money
defVar --name success --type Boolean
setVar --name "${extractText}" --value "I would like to bid $ 15,000 and thirty-seven cents. My friend will bid 11,000 dollars and 70 cents."
extractCurrency --culture en-US --minimumvalue 10 --text "${extractText}" extractedValues=values firstValue=first success=success
logMessage --message "Extracted values: ${extractedValues}\r\nFirst value found: ${firstValue}\r\nSuccess: ${success}\r\n\r\n" --type "Info"
// Result:
// Extracted values: [15000,11000.7]
// First value found: 15000
// Success: True

Example 2: The command extracts two monetary values from a text. In both cases the values are extracted in English, but each value is formatted in a unique way.

defVar --name extractText --type String
defVar --name extractedValues --type List --innertype Money
defVar --name firstValue --type Money
defVar --name success --type Boolean
setVar --name "${extractText}" --value "I want to donate a 1,000 dollars and fifty five cents, and my brother wants to donate $5,000."
// The first value is formatted with the currency written after the numeric value, and the second value uses the currency symbol to format it.
extractCurrency --culture "en-US" --text "${extractText}" extractedValues=values firstValue=first success=success
logMessage --message "Extracted values: ${extractedValues}\r\nFirst value found: ${firstValue}\r\nSuccess: ${success}\r\n\r\n" --type "Info"
// Result:
// Extracted values: [1000.55,5000]
// First value found: 1000.55
// Success: True

Limitations

• The monetary or numeric values entered in Text must be properly spelled or formatted according to the selected language, otherwise the extracted values aren't accurate.
• Monetary values can only be in US dollars. Other currencies are not supported yet.

Related links

• Answer Question
• Boolean Extract
• Classify Text
• Extract Address
• Extract CNPJ
• Extract CPF
• Extract Date
• Extra Email Address
• Extract Intent
• Extract Named Entities
• Extract Numbers
• Extract Phone Number
• Extract Quantity
• Extract Time Span
• Parse Sentences
• Spell Checker
• Summarize Text
• Synonyms