Send Text to Terminal
Sends text to a specified terminal.
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.
terminalSendText --text(String) [--timeout(TimeSpan)] (Boolean)=value
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 |
|---|---|---|---|---|
| Text | text |
Required |
Text |
Text that should be sent to the terminal. |
| Timeout | timeout |
Optional |
Time Span, Number, Text |
Maximum wait time for execution. Note:In case no value is defined for the
Timeout parameter, the execution uses the context timeout defined by the Set Timeout command. If that command is not used on the script, the default timeout is 5 seconds. |
Output parameters
| Designer mode label | Script mode name | Accepted variable types | Description |
|---|---|---|---|
| Success | value | Boolean |
Returns True if the text was successfully sent to the terminal server, or False otherwise. |
Example
The command sends the text "Test" to the specified terminal server.
defVar --name success --type Boolean
defVar --name terminalConnection --type Boolean
terminalConnect --name terminal --hostname "example.com" --port 23 --timeout 00:01:00 terminalConnection=value
terminalSendText --text Test --timeout 00:01:00 success=value
terminalDisconnect --name terminal
logMessage --message "${success}\r\n" --type "Info"
// `True`.
Remember:Use a valid connection to connect to the server.