Skip to main content
Version: 0.25.0

Files Actions

The Files group and its three sub-groups — Excel, PDF and RDP.

note

The file-system actions moved here from Other → Start Process, and Aiviro PDF Reader was renamed to Process Invoice and moved to the AI group. The Excel and RDP sub-groups are new.

Files​

Available on Desktop and RDP robots — they act on the file system of the controlled machine.

Copy File​

The Copy File form with source and destination paths filled in

ParameterDescription
Source fileFile or directory to copy.
Destination directoryTarget folder.
RecursiveCopies sub-folders and their contents. Default off.
ForceOverwrites existing files without asking. Default off.
Capture outputFails the step when the underlying shell command returns a non-zero exit code, instead of failing silently. Default on. (Advanced options)
Save result to variableVariable for the command's result, the same dictionary as on Custom Command. Optional; shown only while Capture output is on. (Advanced options)

Move File​

ParameterDescription
Source fileFile or directory to move.
Destination directoryTarget folder.
Capture outputFails the step when the underlying shell command returns a non-zero exit code, instead of failing silently. Default on. (Advanced options)
Save result to variableVariable for the command's result, the same dictionary as on Custom Command. Optional; shown only while Capture output is on. (Advanced options)

Remove File​

ParameterDescription
Path to fileFile or directory to delete.
RecursiveDeletes the contents of a directory as well. Default off.
Capture outputFails the step when the underlying shell command returns a non-zero exit code, instead of failing silently. Default on. (Advanced options)
Save result to variableVariable for the command's result, the same dictionary as on Custom Command. Optional; shown only while Capture output is on. (Advanced options)
warning

Remove File deletes without a recycle bin. Test the path on a scratch folder before pointing it at anything you care about, and prefer Move File into an archive folder when you might need the data back.

Create Directory​

ParameterDescription
Path to directoryFolder to create. Missing parent folders are created too.
Capture outputFails the step when the underlying shell command returns a non-zero exit code, instead of failing silently. Default on. (Advanced options)
Save result to variableVariable for the command's result, the same dictionary as on Custom Command. Optional; shown only while Capture output is on. (Advanced options)

Open Folder​

ParameterDescription
Path to directoryFolder to open in File Explorer.
Capture outputFails the step when the underlying shell command returns a non-zero exit code, instead of failing silently. Default off — opening a folder is not an operation that is expected to finish. (Advanced options)
Save result to variableVariable for the command's result, the same dictionary as on Custom Command. Optional; shown only while Capture output is on. (Advanced options)
Upgrading from 0.24.x

Capture output is new in 0.25.0. Without it a file operation that failed — a missing source file, a destination you cannot write to — let the run carry on, and the damage showed up in a later, unrelated step.

It is on for file actions you add from 0.25.0 onwards, so the run stops at the step that actually failed. Actions in scenarios saved by an earlier version keep the old silent behaviour until you tick the option yourself; upgrading never changes how an existing scenario runs.


Files → Excel​

Load CSV File​

Loads a CSV so the scenario can iterate over it — typically feeding a Repeat for each item in loop.

The Load CSV File form with Show additional settings switched on, so Delimiter, Encoding, Decimal and Line Terminator are visible

ParameterDescription
File PathPath to the CSV file.
Result typelist_of_dict (default) gives one dictionary per row, keyed by column name — the form to use with a loop. pandas_dataframe gives a DataFrame for processing in Python Code.
Save to variableVariable that receives the loaded data.
DelimiterColumn separator. Left empty, it is detected automatically. (Advanced options)
EncodingFile encoding. Default utf-8. (Advanced options)
DecimalDecimal separator used inside the file. Default .. (Advanced options)
Line TerminatorRow separator. Detected automatically when empty. (Advanced options)
tip

Set Decimal to , for CSVs exported from Czech or German locales, otherwise numbers such as 1,50 are read as text and arithmetic on them fails later in the run.


Files → PDF​

Extract PDF custom​

Pulls specific values out of a PDF using positional rules — for example "to the left of the text Order Number, match OBJ\d+". The rules are the same search objects you use on screen.

The Extract PDF custom form with Search Elements expanded: one Key → Element row, its Element list open with the search-object types

ParameterDescription
PDF File PathPDF to parse.
Search ElementsList of Key → Element pairs. Each key becomes a field in the result.
Save to variableVariable that receives the extracted data.

Add Image​

Inserts an image into a PDF — a signature, a stamp, a logo.

The Add Image form with all coordinate fields filled in

ParameterDescription
PDF File Path (input)Source PDF.
PDF File Path (output)Where the modified PDF is written.
Image File PathImage to insert.
X / YPosition in points, measured from the bottom-left corner. Default 0.
Width / HeightTarget size. Leave empty to keep the original size.
Preserve RatioKeeps the image's aspect ratio. Default on.
warning

PDF handling needs the Poppler library. It ships with the Windows installer; on Linux and macOS you install it yourself — see System Requirements.


Files → RDP​

Moving files between your machine and the remote session. RDP robot only.

Transfer File To Remote Machine​

The Transfer File To Remote Machine form with the Transfer Type dropdown open showing all three options

ParameterDescription
Local File PathFile on your machine.
Remote Destination PathWhere to put it in the remote session.
Transfer TypeShared Folder copies through the RDP shared folder. Clipboard sends the file over the RDP clipboard channel. Clipboard-Only forces the clipboard route even when a shared folder is configured.

Get File From Remote Machine​

The Get File From Remote Machine form

ParameterDescription
Remote File PathFile inside the remote session.
Local Destination PathWhere to save it on your machine.
tip

Both folders are visible in the Files panel as Shared folder (RDP) and Temp (this session), so you can check what actually arrived without leaving the Editor.