Skip to main content
Version: 0.23.1

Quick Start

Estimated time: 30 minutes Follow this end-to-end walkthrough to go from a fresh installation of Aiviro Editor to a robot that runs by itself on a schedule.


1. Activate your licence

  1. Launch Aiviro Editor.
  2. Open Settings → Edit Configuration → Aiviro.
  3. Paste your Client ID and API Key, then click Test Credentials.
  4. Wait for the success message, then save and restart the Editor.
📸 Screenshot needed — /img/editor/quick-start/license.png

Capture: Settings → Edit Configuration → Aiviro with a successful Test Credentials result. Mask: blur the Client ID and API Key. Why it must be retaken: licence entry moved into the categorized settings dialog — there is no separate licence prompt any more.


2. Connect a robot

Click Connect (Shift+R) and pick a robot type:

  • Desktop — runs on your local PC. Requires two monitors.
  • RDP — connects to a remote Windows session. Recommended for production.
  • Web — automates Google Chrome through ChromeDriver.

Give the configuration a Profile Name, fill in the connection details, save the profile, and click Connect. Details of every field are in Robot Types & Configuration.


3. Create a project

  1. File → New Project (Ctrl+N).
  2. File → Save Project (Ctrl+S), choose a folder and name it DemoQuickStart.

The project opens with an empty scenario.


4. Build the scenario

You will build a flow that:

  1. Opens a page showing the USD → EUR exchange rate.
  2. Reads the current rate into a variable.
  3. Closes the browser.
  4. Opens Notepad, waits until it is ready, and writes two lines mixing the date, plain text and the rate.
  5. Saves the note under a filename containing today's date, and exits.
📸 Screenshot needed — /img/editor/quick-start/action-tree.png

Capture: the finished Commands tree for this scenario, with the section collapsed/expanded so all ~17 actions are visible. Why it must be retaken: the tree styling changed and the state column now shows the Run Action icons.

Read the rate

#ActionMenu pathParameters
1[RDP] Open URLToolshttps://dollarstoeuro.com/usd-to-euro
2Teach robotShift+E in the live view, so the page's elements are detected
3GetTools — or Ctrl+Shift+GRight-click the rate value. Object type On the right; Reference → Label 1 USD; Query → Label \b\d{1}[,.]\d{2}\b with Find method REGEX; Variable name current_rate
4Key ShortcutKeyboardAlt + F4 to close the browser
📸 Screenshot needed — /img/editor/quick-start/example_get_rate.png

Capture: the Get form for step 3 — the On the right search object with Reference and Query filled in and Find method REGEX selected. Why it must be retaken: Get moved to the Tools group and the search-object editor was redesigned.

Why a reference?

Anchoring the search to the fixed label 1 USD makes the automation immune to layout shifts. The regular expression then picks only the numeric part, ignoring the trailing currency name. See Positional Search.

Open Notepad and wait for it

#ActionMenu pathParameters
5[RDP] Custom CommandStart Processnotepad
6Wait ForWaitText UTF-8 — always present in Notepad's status bar

Wait For guarantees typing only starts once Notepad is really on screen.

Build the text

Add three Create variable actions (Tools, or Ctrl+Shift+V):

#VariableExpression
7first_linef"Exchange rate for {CONSTANTS['DAY_OF_WEEK_NAME']}, {CONSTANTS['DAY']}/{CONSTANTS['MONTH']}/{CONSTANTS['YEAR']}"
8second_linef"1 USD = {current_rate} EUR"
9filenamef"Rate_{CONSTANTS['FULL_DATE'].strftime(r'%d-%m-%Y')}.txt"

Type, save and exit

#ActionMenu pathParameters
10Type TextKeyboardfirst_line, Key after typing Enter
11Type TextKeyboardsecond_line
12Key ShortcutKeyboardCtrl + S
13Wait ForWaitText *.txt — confirms the Save dialog is up
14Type TextKeyboardfilename, Key after typing Enter
15Key ShortcutKeyboardAlt + F4
16Wait Until DisappearWaitthe Notepad window title
tip

Key after typing replaces the separate Enter steps the old version of this walkthrough needed — two fewer actions to maintain.

What you have learned

  • [RDP] Custom Command launches any executable with parameters.
  • Get with a positional object and a regex pulls one value off a page without code.
  • Create variable builds strings that mix CONSTANTS and captured values.
  • Wait For / Wait Until Disappear keep the flow stable without fixed sleeps.
  • Key Shortcut, Type Text and Click cover most desktop interaction.

5. Test it

  1. Click Run all in the Commands panel header.
  2. Watch the robot execute the actions step by step.
  3. Open the Runs panel and confirm a green Success status.
📸 Screenshot needed — /img/editor/quick-start/run_success.png

Capture: the Runs panel with a successful run selected and its detail visible. Why it must be retaken: the panel is now called Runs and the log viewer was rebuilt in 0.23.

If it failed, use the log and screenshots in the run detail to find the step that broke — see Recent Runs.

TODO — ready-made scenario JSON

The 0.14.2 version of this page ended with a copy-paste-ready scenario JSON. It was removed because it serializes class paths from the old src.actions.* / src.parameters.* layout and uses actions that are now deprecated (Constant, the old e-mail actions), so pasting it into 0.23.1 would not reproduce the walkthrough.

To restore it: build this scenario in the current Editor, then export it and paste the JSON back into a collapsible <details> block here.


6. Move credentials into the Vault

Before scheduling anything, take any password out of the actions:

  1. Click Vault in the toolbar.
  2. Add a Password entry, for example RDP_PASSWORD.
  3. Replace the plain-text value in the action with {{SECRET:RDP_PASSWORD}}.

This scenario has no password, but every real one will — see Secure Vault.


7. Schedule it

  1. Click Settings in the Commands panel header to open Scenario Settings.
  2. Tick Active.
  3. Set Schedule type to Daily and choose 09:00.
  4. Pick the robot Profile the scheduled run should use.
  5. Confirm the Time zone, and save.
📸 Screenshot needed — /img/editor/quick-start/schedule.png

Capture: Scenario Settings with Active ticked, Schedule type: Daily, a time set, and the human-readable schedule description visible below. Why it must be retaken: the dialog gained the Localization section and a plain-language schedule summary.


8. Turn on Auto Mode

Flip Auto Mode in the main toolbar to On and leave Aiviro Editor running. The Orchestrator now executes the scenario every day at 09:00.

📸 Screenshot needed — /img/editor/quick-start/auto_mode.png

Capture: the main toolbar with Auto Mode switched on, and the Scheduled panel showing the next planned run.

Return to the Runs panel after 09:00 — a new entry should be there with today's date.


Next steps

Need help? Check the sidebar or reach out to Aiviro Support.