Set Cursor
Sets the mouse cursor on the terminal at a specified point.
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.
terminalSetCursor [--column(Numeric)] [--line(Numeric)] (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 |
|---|---|---|---|---|
| Column | column |
Optional |
Number |
Column position at the terminal to set the cursor at. |
| Row | line |
Optional |
Number |
Position of the line at the terminal to set the cursor at. |
Output parameters
| Designer mode label | Script mode name | Accepted variable types | Description |
|---|---|---|---|
| Success | value | Boolean |
Returns True if the cursor was setted at the entered position, or False if it was not positioned. |
Example
Sets the cursor on Column 1 and Row 1 on the terminal.
defVar --name name --type String --value Terminal
defVar --name serverName --type String --value "www.example.com"
defVar --name port --type Numeric --value 60
defVar --name success --type Boolean
defVar --name terminalConnection --type Boolean
terminalConnect --name "${name}" --hostname "${serverName}" --port ${port} terminalConnection=value
terminalSetCursor --column 1 --line 1 success=value
terminalDisconnect --name "${name}"
// Result: `True`
Remember:Use a valid connection to connect to the server.