Refresh Terminal
Refreshes a terminal screen.
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.
terminalRefresh [--wait(Boolean)] [--timeout(TimeSpan)] (Boolean)=value
Dependencies
Use one of the following commands to connect to a Terminal:
- Connect to Terminal (
terminalConnect) - Connect to Terminal via Telnet (
terminalTelnetConnect) - Connect to Terminal via SSH (
terminalSshConnect)
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 |
|---|---|---|---|---|
| Wait | wait |
Optional |
Boolean |
When enabled, uses the timeout to validate the terminal screen. |
| Timeout | timeout |
Optional |
Time Span, Number, Text |
Maximum wait time to refresh terminal screen. Note:If no value is defined for the
Timeout parameter, the bot uses the context timeout defined by the Set Timeout (setTimeout)
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 update was successful, or False otherwise. |
Example
Validates and refreshes the terminal screen, displaying the result in the IBM RPA Studio console.
defVar --name hostName --type String --value "example.com"
defVar --name validatedScreen --type Boolean
defVar --name conected --type Boolean
defVar --name success --type Boolean
// Connects to the terminal.
terminalConnect --name example --hostname "example.com" --port 23 conected=value
terminalValidateScreen --keywords "${hostName}" --label example validatedScreen=value
// After waiting for a valid screen, update the terminal screen.
terminalRefresh --wait--timeout 00:00:05 success=value
// The result of the action is displayed in the console.
logMessage --message "Terminal screen update result: ${success}" --type "Info"
delay --timeout 00:00:05
terminalDisconnect --name example
Remember:Use a valid connection to connect to the server.