Bot Ask Date
The bot asks and recognizes dates 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.
botAskDate [--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<DateTime>)=values (DateTime)=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 attempt. |
| Attempts | attempts |
Optional |
Number |
Number of times the question from Alternatives texts is repeated. |
| Alternative texts | retrytext |
Optional |
Text |
Alternative question that is asked to the user if there is no answer on the first attempt. |
| Subroutine | timeoutsub |
Optional |
Text |
Subroutine that runs if user response time runs out. |
| Maximum Recognition Time | recognitionTimeout |
Optional |
Time Span |
Timeout to acknowledge the user's response |
| Maximum silence time after speech | speechCompleteTimeout |
Optional |
Time Span |
Maximum time allowed without interaction with the bot after its speech. Starting from IBM RPA 23.0.3, this parameter is removed. |
| Waiting time | noInputTimeout |
Optional |
Time Span |
Maximum waiting time for the user to start the conversation. Starting from IBM RPA 23.0.3, this parameter is removed. |
| Maximum time of incomplete speech | 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 | 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 get the date. |
| 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 |
Value to link the history of other commands to the history of this command. This field returns the identity value of the saved history if one has been set Storage Adapter at Connect to Chatbot. To use it, simply add this output to the command-specific input parameter from which history you want to link to this command's history. |
| Values | values |
List<Date Time> |
Dates recognized in user-entered text. |
| First | first |
Date Time |
First date recognized in the text. |
| Values mapping | valuesmapping |
Data Table |
Data table that returns the date position in user-entered text, its size, and the date itself. |
| Success | success |
Boolean |
Returns True if the script runs successfully, or False otherwise. |
Example
Analyzes the text provided by the user, returning the dates that were recognized and the text itself.
defVar --name language --type Language
defVar --name insertText --type String
defVar --name recognizedDates --type List --innertype DateTime
defVar --name firstDateRecognized --type DateTime
//
createLanguage --culture "enUS" language=value
botConnect --type "Chat" --language ${language} --timedout TimeOut --autoanswer--timeout 00:05:00
botSay --text "Welcome!"
botAskDate --beep--text "What is the day of your appointment?" --timeout 00:05:00 insertText=utterance recognizedDates=values firstDateRecognized=first
logMessage --message "First Recognized Value: ${firstDateRecognized}\r\nUtterance: ${insertText}\r\nRecognized Values: ${recognizedDates}" --type "Info"
botDisconnect
Limitations
-
If the amount of time specified in the Maximum Recognition Time, Waiting time, Maximum silence time after speech, Maximum time of incomplete speech, and Timeout parameters runs out, the interaction is forwarded to the subroutine specified in the Subroutine parameter.
-
The Maximum Recognition Time, Waiting time, Maximum silence time after speech, Maximum time of incomplete speech, and Beep parameters are specific to the IVR communication type.
-
The Attempts and Alternative texts parameters are available when the Retry parameter is enabled.