Tools Actions
The Tools group holds the workhorses that do not belong to a single input device — reading values off the screen, creating variables, running SQL or Python, opening URLs.
Tools replaces the old Other and Input Actions groups. Get moved here from Input, Create variable from Flow, and Execute SQL and Python Code from Other. The Constant action is deprecated — use Create variable instead.
Get
Reads a value from the controlled screen into a variable. Pinned action, shortcut Ctrl+Shift+G.
/img/editor/actions/tools/get.pngCapture: the Get form with a positional search object set and
Advanced options expanded so Timeout, Result type and
Result is secret are visible.
Note: the old image is actions/input/get.png — the action moved group, and
Timeout is new.
| Parameter | Description |
|---|---|
| Search object | What to read. |
| Variable name | Variable that receives the result. |
| Required success | Stop the scenario if the value cannot be read. |
| Timeout | Maximum time to search for the element, in seconds. Default 60. (Advanced options) |
| Result type | What to store — see the table below. Default text. (Advanced options) |
| Result is secret | Masks the value in logs and screenshots. Default off. (Advanced options) |
| Result type | Stores |
|---|---|
| text | The recognized text. |
| regex | The part of the text captured by the search object's regular expression. |
| is_visible | True/False — whether the element was found at all. Nothing is read. |
| raw | The raw element data, for advanced use in Python Code. |
is_visible turns Get into a screen test: read it into a variable and branch on it with Condition, instead of relying on a failing action.
Create variable
Creates a variable, or reassigns one, from an expression. Shortcut Ctrl+Shift+V.
/img/editor/actions/tools/create_var.pngCapture: the Create variable form showing the Assignment row — the name
field, the expression field and the VAR button — with an f-string expression filled in.
Note: the old image is actions/flow/create_var.png.
| Parameter | Description |
|---|---|
| Assignment | The variable name plus the Python expression assigned to it. |
Expressions are Python, so you can combine variables, the built-in CONSTANTS, and
string formatting:
f"Rate_{CONSTANTS['FULL_DATE'].strftime(r'%d-%m-%Y')}.txt"
See References & Resources for the full
list of CONSTANTS.
Python Code
Runs an embedded Python block. Variables from the scenario are available inside it, and anything the block assigns comes back out.
/img/editor/actions/tools/python_code.pngCapture: the Python Code form with the code editor showing a few lines of real
code and syntax highlighting.
Note: the old image is actions/other/python_code.png.
| Parameter | Description |
|---|---|
| Comment | Short label shown on the action in the tree, so the block is identifiable without opening it. Default Python Code Block. |
| Code | The Python source to execute. |
Execute SQL
Runs an SQL query through the system ODBC driver. Available on Desktop and RDP robots.
/img/editor/actions/tools/sql_query.pngCapture: the Execute SQL form with the SQL Driver dropdown open.
Mask: blur the server name and username.
Note: the old image is actions/other/sql_query.png.
| Parameter | Description |
|---|---|
| SQL Driver | ODBC driver to use, picked from the drivers installed on the machine. |
| Server | Hostname or IP of the database server. |
| Port | Listening port. Default 1433. |
| Database | Target database name. |
| Username / Password | Login credentials. Reference the password from the Vault rather than typing it in. |
| SQL Query | The statement to run. |
| Save to variable | Variable that receives the result set. |
| Encrypt | Enables TLS for the connection. Optional. |
| Trust Server Certificate | Accepts self-signed or otherwise untrusted certificates. Optional. |
| Trusted Connection | Uses Windows authentication instead of username and password. Optional. |
| Additional Parameters | Extra connection-string options, as param1=a; param2=b. Optional. |
The ODBC driver must already be installed and configured on the machine that runs the robot — the Editor does not ship one. See System Requirements.
Open URL
Navigates the browser. Open URL is the Web-robot version; [RDP] Open URL starts the default browser inside the remote session.
/img/editor/actions/tools/open_url.pngCapture: the [RDP] Open URL form with Advanced options expanded. Why it is needed: neither variant has a screenshot today.
Open URL (Web)
| Parameter | Description |
|---|---|
| URL | Address to open. Accepts variables. Default https://www.google.com. |
[RDP] Open URL
| Parameter | Description |
|---|---|
| URL | Address to open. Default https://www.google.com. |
| As Admin | Starts the browser elevated. (Advanced options) |
| Sensitive Data | Keeps the URL out of the logs — use it when the URL contains a token. (Advanced options) |
| Timeout | How long to wait for the browser to start, in seconds. Default 15. (Advanced options) |
| Sleep Time | Pause after the browser starts, in seconds. Default 1. (Advanced options) |