Skip to main content
Version: 0.23.1

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.

note

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.

📸 Screenshot needed — /img/editor/actions/tools/get.png

Capture: 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.

ParameterDescription
Search objectWhat to read.
Variable nameVariable that receives the result.
Required successStop the scenario if the value cannot be read.
TimeoutMaximum time to search for the element, in seconds. Default 60. (Advanced options)
Result typeWhat to store — see the table below. Default text. (Advanced options)
Result is secretMasks the value in logs and screenshots. Default off. (Advanced options)
Result typeStores
textThe recognized text.
regexThe part of the text captured by the search object's regular expression.
is_visibleTrue/False — whether the element was found at all. Nothing is read.
rawThe raw element data, for advanced use in Python Code.
tip

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.

📸 Screenshot needed — /img/editor/actions/tools/create_var.png

Capture: 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.

ParameterDescription
AssignmentThe 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.

📸 Screenshot needed — /img/editor/actions/tools/python_code.png

Capture: 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.

ParameterDescription
CommentShort label shown on the action in the tree, so the block is identifiable without opening it. Default Python Code Block.
CodeThe Python source to execute.

Execute SQL

Runs an SQL query through the system ODBC driver. Available on Desktop and RDP robots.

📸 Screenshot needed — /img/editor/actions/tools/sql_query.png

Capture: 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.

ParameterDescription
SQL DriverODBC driver to use, picked from the drivers installed on the machine.
ServerHostname or IP of the database server.
PortListening port. Default 1433.
DatabaseTarget database name.
Username / PasswordLogin credentials. Reference the password from the Vault rather than typing it in.
SQL QueryThe statement to run.
Save to variableVariable that receives the result set.
EncryptEnables TLS for the connection. Optional.
Trust Server CertificateAccepts self-signed or otherwise untrusted certificates. Optional.
Trusted ConnectionUses Windows authentication instead of username and password. Optional.
Additional ParametersExtra connection-string options, as param1=a; param2=b. Optional.
warning

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.

📸 Screenshot needed — /img/editor/actions/tools/open_url.png

Capture: the [RDP] Open URL form with Advanced options expanded. Why it is needed: neither variant has a screenshot today.

Open URL (Web)

ParameterDescription
URLAddress to open. Accepts variables. Default https://www.google.com.

[RDP] Open URL

ParameterDescription
URLAddress to open. Default https://www.google.com.
As AdminStarts the browser elevated. (Advanced options)
Sensitive DataKeeps the URL out of the logs — use it when the URL contains a token. (Advanced options)
TimeoutHow long to wait for the browser to start, in seconds. Default 15. (Advanced options)
Sleep TimePause after the browser starts, in seconds. Default 1. (Advanced options)