Bot Asks CNPJ
The bot asks for a CPNJ (Brazilian legal entity identification number) number, recognizing it in the text provided by the user.
Starting from IBM RPA 23.0.3, support for Interactive Voice Response (IVR) is removed from this command due to the removal of IVR. For more information, see Removed.
Command availability: IBM RPA SaaS and IBM RPA on premises
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.
botAskCnpj [--retry(Boolean)] [--attempts(Numeric)] [--retrytext(String)] [--timeoutsub(String)] [--recognitionTimeout(TimeSpan)] [--speechCompleteTimeout(TimeSpan)] [--noInputTimeout(TimeSpan)] [--speechIncompleteTimeout(TimeSpan)] [--confidenceThreshold(Numeric)] [--beep(Boolean)] [--language(Language)] --text(String) [--textformat(String)] [--timeout(TimeSpan)] (String)=utterance (Boolean)=timedout (String)=botHistoryMessageId (List<String>)=values (String)=first (DataTable)=valuesmapping (Boolean)=success
Dependencies
- You must start a Chatbot or IVR instance by using the Connect to Chatbot (
botConnect) command. - This command must be in the Connect to Chatbot scope.
Input parameters
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.
| Designer mode label | Script mode name | Required | Accepted variable types | Description |
|---|---|---|---|---|
| Retry | retry |
Optional |
Boolean |
Enable to allow the bot to ask a new question if there is no answer on the first try. |
| Attempts | attempts |
Optional |
Number |
Number of times the question is asked again. |
| Alternatives texts | retrytext |
Optional |
Text |
Alternative question that is asked to the user if there is no answer on the first attempt. |
| Time out sub | timeoutsub |
Optional |
Text |
Subroutine that runs if user response time runs out. |
| Recognition timeout | recognitionTimeout |
Optional |
Time Span |
Timeout to acknowledge the user's response. |
| Speech complete timeout | speechCompleteTimeout |
Optional |
Time Span |
Maximum time allowed without interaction with the bot after its last speech. Starting from IBM RPA 23.0.3, this parameter is removed. |
| No input timeout | noInputTimeout |
Optional |
Time Span |
Timeout for the user to start the conversation. Starting from IBM RPA 23.0.3, this parameter is removed. |
| Speech incomplete timeout | speechIncompleteTimeout |
Optional |
Time Span |
Maximum amount of time to wait for the user to complete the speech. Starting from IBM RPA 23.0.3, this parameter is removed. |
| Confidence threshold | confidenceThreshold |
Optional |
Number |
Numeric expression that indicates the confidence level for recognizing user response. Confidence rate is in the range 1 - 100. If the obtained value is lower than the specified range, it returns null. Starting from IBM RPA 23.0.3, this parameter is removed. |
| Beep | beep |
Optional |
Boolean |
Enable to play a beep each time that the bot speaks. Starting from IBM RPA 23.0.3, this parameter is removed. |
| Language | language |
Optional |
Language |
Language used for bot communication. Use the Create a Language (createLanguage) command to get the language variable. |
| Text | text |
Required |
Text |
First question that is asked to obtain the CNPJ. |
| Text Format | textformat |
Optional |
Text, BotTextFormat |
Specifies the text format to send to the chat, either Plain Text or Markdown (default). |
| Timeout | timeout |
Optional |
Time Span, Number, Text |
Timeout for waiting for user response. |
Output parameters
| Designer mode label | Script mode name | Accepted variable types | Description |
|---|---|---|---|
| Utterance | utterance |
Text |
Returns the text provided by the user. |
| Timed out | timedout |
Boolean |
Returns True if the time has run out, otherwise returns False. |
| History Message | botHistoryMessageId |
Text |
Identifier for other commands to save their history along with the history of this command. This field returns the identity value of the saved history if one has been set to the Storage Adapter parameter of the
Connect to Chatbot (botConnect) command. To use it, simply add this output to the command specific input parameter of which the history you want to link to this command's history. |
| Values | values |
List<Text> |
List of recognized CNPJs in user entered text. |
| First | first |
Text |
First CNPJ recognized in the text. |
| Values mapping | valuesmapping |
Data Table |
Data table that returns the position of the CNPJ in the entered text, its size, and the text itself. |
| Success | success |
Boolean |
Returns True if the script executes successfully; if not, returns False. |
Example
The bot recognizes the numbers that correspond to a CNPJ in the sentence that is entered by the user.
defVar --name botLanguage --type Language
defVar --name chatConnection --type ChatData
defVar --name statementObtained --type String
defVar --name cnpjObtained --type List --innertype String
defVar --name firstCnpjObtained --type String
defVar --name mappedCnpj --type DataTable
createLanguage --culture "enUS" botLanguage=value
botConnect --type "Chat" --language ${botLanguage} --timeout 00:01:40 chatConnection=chat
botSay --language ${botLanguage} --text "Hi! I\'m a Chatbot."
botAskCnpj --beep--language ${botLanguage} --text "Enter the CNPJ!" --timeout 00:01:00 statementObtained=utterance cnpjObtained=values firstCnpjObtained=first mappedCnpj=valuesmapping
logMessage --message "Values: ${cnpjObtained}\r\nStatement: ${statementObtained}\r\nFirst: ${firstCnpjObtained}\r\nMapped Values: ${mappedCnpj}\r\n" --type "Info"
// The example has the following returns:
// Values: Displays a list of found CNPJs
// Statement: Displays the sentence that was written by the user.
// First: Displays the first CNPJ found
// Mapped Values: Displays hit number, index character, number of characters, and CNPJ number
botDisconnect
Limitations
-
If the time on the Recognition timeout, No input timeout, Speech complete timeout, Speech incomplete timeout and Timeout parameters runs out, the interaction is forwarded to a subroutine specified in the Time out sub parameter.
-
The Recognition timeout, No input timeout, Speech complete timeout, Speech incomplete timeout, and Beep parameters are specific for IVR communication.
-
If no value is defined for the timeout parameters, the default timeout is 5 seconds. You can change the default timeout by using the Set Timeout (
setTimeout) command.