Tasks
Virtual Worker Task
Executes a set of virtual browser worker commands to perform automated actions
See virtual-worker concept for more details.
Basic usage
Run a virtual worker that navigates to a website and types text into a field.
Parameters
worker Object required
Defines the execution settings and commands for the virtual worker.
Show child attributes
group string optional
Optional group (classification) of virtual worker to use.
This can be used to reuse a specific virtual worker for multiple tasks and across stubs.
timeout Object
Show child attributes
seconds Number optional
Maximum time in seconds to allow the worker to run before terminating it.
Default: 60
commands Object required
A set of commands to execute by the virtual worker.
Each command is defined as a key-value pair, where the key is a unique identifier for the command, and the value is an object defining the command type and its parameters. See more below.
Supported Command Types
Browser Write text
Will write the specified text into the element located by the locator.
Browser Navigate
Will navigate the browser to the specified URL.
Browser Click
Will click on the element located by the locator.
Browser Press Key
Will press the specified key in the focused element.
Browser Get Local Storage
Will retrieve the entire local storage of the browser. Depends on the website what data is stored there.
Browser Extract Data
Will extract data from the page using the specified locators.
Converts HTML elements into structured JSON data.
Specifying a string as the value of a locator will extract the text content of the element.
Specifying an object as the value of a locator allows for more complex extraction, including lists and attributes.
To extract a list of elements, use the special key _list with a locator string that will match multiple elements.
To extract properties of each list item, use the special key _list_item_properties with an object defining the properties to extract.
To extract an attribute of an element, use the special keys _locator and _target within a locator object.
Download Files
Integrates with the Stubber file storage system to download files by their UUIDs.
Specify either an array of strings (fileuuids) or an array of objects with a fileuuid property.
Files are downloaded to the default tmp directory on the virtual worker machine.
Upload Files
Uploads files from the virtual worker machine to the Stubber file storage system.
Specify an array of file paths to be uploaded.
Resulting fileuuids are available in the command payload if successful.