Quickstart
Install Studio and the Robot, build a small workflow, publish it, connect the Robot and run it as a job from the Orchestrator.
In this quickstart you go from an empty Windows machine to a finished job: you install Studio and the Robot, build a workflow that writes a greeting to a text file, publish it, connect the machine to the Orchestrator and start the workflow as a job. Each step links to the page with the full detail.
Before you start#
- An Orchestrator you can sign in to, with a tenant and a workspace. If you run your own, follow Install on-premises first.
- A role in that tenant that can add machines and robot accounts, publish packages, create processes and start jobs. Administrator covers all of it. See RBAC and permissions.
- A 64-bit Windows 10 (version 1809 or later) or Windows 11 machine where you are a local administrator, with outbound HTTPS to the Orchestrator.
- A local Windows user account on that machine for unattended jobs to run as. A standard user is enough.
- VeloPhex Setup for your release:
VeloPhex Setup-<version>-win-x64.exe.
Step 1: Install Studio and the Robot#
- Run
VeloPhex Setup-<version>-win-x64.exe. - Choose the Developer profile. It installs Studio, the Robot and the Assistant. Keep VeloPhex workflows selected.
- Accept the license terms and select Install. When Setup finishes, Launch opens Studio.
To install silently from an elevated prompt:
Silent Developer installPowerShellCopy& ".\VeloPhex Setup-<version>-win-x64.exe" /quiet PROFILE=Developer
Details: Install Studio.
Step 2: Create a project#
- In Studio, create a new project from the Blank Automation template and name it
Hello.Quickstart. Studio creates the folder withproject.jsonandMain.xaml, and addsVeloPhex.System.Activitiesfrom the activity feed Setup installed. - Add an argument named
Name, direction In, type String.
Details: Create a project and Variables, arguments and expressions.
Step 3: Add activities and run locally#
-
Add Log Message to the sequence and set Message to:
C#Copy"Hello, " + Name -
Add Write Text File below it. Set Path to
@"C:\Users\Public\Documents\velophex-hello.txt", Content to"Hello, " + Name, and turn Overwrite on. -
Save, then run the workflow. Studio asks for the
Nameinput; enterWorld. -
The Output panel shows
Hello, World, and the file contains the same text.
Details: Run and debug.
Step 4: Connect the machine to the Orchestrator#
-
In the Orchestrator, open Machines and select New machine. Enter a Name such as
dev-laptop, keep the Mode Robot (service), and select Create machine. -
Copy the key under Machine key (it starts with
vpx_ek_). It is shown once and works once. If you lose it, open the machine and select Enrolment ▸ Regenerate key. -
In your workspace, open Settings ▸ Machines and add the machine. A Robot only runs jobs from workspaces its machine serves.
-
On the Windows machine, open VeloPhex Assistant from the Start menu, select Preferences, then under Machine connection select Connect. Enter the Orchestrator address (
https://orchestrator.example.com), paste the key into Enrollment key, select Connect and approve the Windows prompt.Or, from an elevated prompt:
Enrol from the command linePowerShellCopy& "$env:ProgramFiles\VeloPhex\Robot\VeloPhex.Robot.Service.exe" enroll --orchestrator https://orchestrator.example.com --key vpx_ek_... & "$env:ProgramFiles\VeloPhex\Robot\VeloPhex.Robot.Service.exe" status -
statusshowsconnectivity: Connectedand thevelophex-workflowruntime, and the machine's Robot appears on the Robots page within about 30 seconds.
Details: Enroll a Robot and Machines and robots.
Step 5: Add a robot account#
Unattended jobs run as a robot account, never as the Robot service.
- Open Manage access ▸ Robot accounts and select New robot account.
- Enter a Name, the Windows account in Domain\Username (for a local account,
dev-laptop\vpx-robot), its Password and Confirm password, then select Create robot account. - Assign the account to your workspace: Workspaces ▸ your workspace ▸ Assign, with Type set to Robot account.
Without a robot account, starting the job is refused with 409 no_run_as_account. Details: Machines and robots.
Step 6: Publish from Studio#
- In Studio, select Sign in in the status bar (or the account button in the title bar). Your browser opens on Sign in to VeloPhex Desktop; sign in and select Approve. Studio keeps the sign-in in Windows Credential Manager.
- Select Publish, keep the package ID
Hello.Quickstartand version1.0.0, choose Velophex Orchestrator as the destination, and publish.
The Orchestrator's Packages page now lists Hello.Quickstart 1.0.0. Details: Sign in to Orchestrator and Publish to Orchestrator.
Step 7: Create a process and start a job#
-
In the Orchestrator, open your workspace, then Automations ▸ Processes, and select New process.
-
Choose the
Hello.Quickstartpackage. Keep the latest version and the default entry point, and save. -
Select Start job on the process. The form is generated from the entry point's input schema, so it shows a
Namefield. EnterVeloPhexand start the job.
Details: Packages and processes and Jobs.
Verify#
- Automations ▸ Jobs shows the job move from Pending to Running to Completed.
- The job's logs contain
Hello, VeloPhexfrom the Log Message activity. - On the Robot machine,
C:\Users\Public\Documents\velophex-hello.txtcontainsHello, VeloPhex.
A job that stays Pending shows the reason on its row and on the job page, for example that no robot serves the workspace or that every robot account is busy. A start is refused with 409 no_capable_runner when no Robot that serves the workspace has the runtime the package needs. See Common issues.
Next steps#
- Learn the vocabulary behind what you just did in Core concepts.
- Schedule the process with a trigger.
- Store the file path as an asset instead of hard-coding it.
- Write the same automation in Python with Your first Python automation.
Before you start
Step 1: Install Studio and the Robot
Step 2: Create a project
Step 3: Add activities and run locally
Step 4: Connect the machine to the Orchestrator
Step 5: Add a robot account
Step 6: Publish from Studio
Step 7: Create a process and start a job
Verify
Next steps