Skip to main content
Version: 0.24.0

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 new Log action lives here too.

One way to create a variable

Up to 0.23.x there were three overlapping ways to make a variable: the Constant action, the Create variable action, and a Prompt input hidden in the Variables panel. Since 0.24.0 there is one — Create variable — and it handles everything from a fixed value to a computed expression.

Constant is gone from the actions menu and the Prompt button has been removed from the Variables panel. Existing scenarios convert automatically when opened; there is nothing to migrate by hand.

Get

Reads a value from the controlled screen into a variable. Pinned action, shortcut Ctrl+Shift+G.

The Get form with a positional search object

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 value field and the VAR button. Note: the old image is actions/flow/create_var.png.

ParameterDescription
AssignmentThe variable name plus the value assigned to it.

Write the value as ordinary text and mark variables and constants with $:

Rate_$CONSTANTS['FULL_DATE'].txt

Python f-strings are no longer needed — the field understands plain sentences with variables in them. Full rules are on Values & Expressions; the list of CONSTANTS is in References & Resources.

Log

Writes your own message into the run log at any point in the scenario. New in 0.24.0.

The Log form with a message using a CONSTANTS expression and Level set to INFO

ParameterDescription
TextThe message to write. Accepts variables.
LevelSeverity: Debug, Info, Warning or Error.

The entry shows up in the run's Logs tab alongside the Editor's own messages, and the level feeds the log-level filter there — see Runs panel.

tip

Log and Add Message look similar but serve different readers. Log writes for you, into the technical run log you read while debugging. Add Message (Notification) writes for the business, into the e-mail report someone reads over coffee.

Python Code

Runs an embedded Python block. Variables from the scenario are available inside it, and anything the block assigns comes back out.

The Python Code form with the code editor showing a few lines of real code and syntax highlighting

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.

The Execute SQL form with the SQL Driver dropdown open

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.

The RDP Open URL form with Advanced options expanded

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)