Platform overview
The components of VeloPhex, what each one does and how they work together.
VeloPhex has four main components and a set of shared contracts that keep them compatible: Studio to build, the Python SDK to write Python automations, the Orchestrator to control, and the Robot to run. Activities, the steps a workflow is made of, reach every component as packages.
The components#
| Component | Runs on | What it does |
|---|---|---|
| Studio | Windows 10 version 1809 or later, Windows 11, Windows Server 2019 or later (x64) | Desktop IDE: visual designer, C# or Visual Basic expressions, debugger, UI element capture, Git, package manager, publish to Orchestrator |
Python SDK (velophex) |
CPython 3.12 | Library and CLI (velophex init, run, pack, publish) to write, run, pack and publish Python automations |
| Orchestrator | Linux x86-64 host with Docker (one container image) | Control plane: tenants and workspaces, access control, machines and Robots, packages, jobs, queues, triggers, assets and credentials, audit log, webhooks |
| Robot | Windows x64 | Agent that runs jobs: a Windows service plus, on desktops, the Assistant app and a per-session User Host |
| Activity packages | Restored into projects and onto Robots | The steps of a workflow. The core packs are System, UI Automation, Excel and Orchestrator (queues, assets, jobs, Action Hub and Data Hub). See Activities overview |
Products in the web app#
Besides the Orchestrator, the web app hosts these products. Open them from the app launcher; see The Home page. They are in beta: a platform administrator enables each one per tenant, and it must be included in the tenant's subscription.
| Product | What it does |
|---|---|
| Launchpad | Collect automation ideas, assess and prioritise them, take them through delivery and measure the benefit. |
| QA Hub | Plan, run and track the testing of your automations, from requirements to defects. |
| Action Hub | Put a person in the loop of an automation with typed approval and review tasks. |
| Flow Studio and Flow Monitor | Model long-running flows that combine robots and people, then watch, fix and migrate their instances. |
| Agents | Build AI agents that use your processes and knowledge, review their tool calls and evaluate them. |
To build your own activities in C#, see the Activity SDK.
Installation#
Studio and the Robot are installed together by one Windows installer, VeloPhex Setup. See Install Studio and Install the Robot on Windows.
How an automation travels#
- Build. You create a project in Studio. A project has a
project.jsonmanifest and one or more VeloPhex XAML workflows. Python projects are created withvelophex initand also have aproject.json. - Package. Publishing builds a
.nupkgautomation package. Itsvelophex/package-manifest.jsonrecords the runtime, the entry points with their input and output JSON Schemas, and the SHA-512 of every content file. You can sign the package. - Publish. The package goes to your tenant's package feed on the Orchestrator (a NuGet v3 feed). The Orchestrator inspects it and refuses anything malformed.
- Configure. In a workspace you create a process from the package, set its retry policy and time limit, and optionally add triggers.
- Run. A job is created manually, by a trigger, through the API, or from another automation. The Orchestrator validates the job inputs against the entry point's schema, then offers the job only to Robots that have the required runtime and serve that workspace. An unattended job also needs a free robot account, the Windows identity it runs as.
- Execute. The Robot claims the job, downloads and verifies the package, redeems any credentials it needs just before launch, and runs the attempt in a separate executor process.
- Report. Logs, the result and the outcome flow back to the Orchestrator. Webhooks can notify other systems.
Inside the Orchestrator#
The Orchestrator is an ASP.NET Core application with a React web interface, delivered as one Docker image. It stores its data in PostgreSQL 18, uses Redis for live updates, and keeps package files in a blob store (a local folder, an S3-compatible bucket, or Azure Blob Storage). If only Redis is down, the platform keeps working in a degraded state.
The image contains three roles:
| Role | Serves |
|---|---|
api |
The REST API and the web interface |
gateway |
The Robot WebSocket command channel |
worker |
Background work: schedulers, lease recovery, retention, partition maintenance, email |
The supported Docker Compose installation runs all three roles in one process on one host. A TLS front door (Caddy) is part of the Compose stack and handles certificates, HTTP/2 and WebSocket upgrades. See Install on-premises and Architecture for scale.
Inside the Robot#
A Robot machine runs:
- The Machine Service (
VeloPhexRobot), a Windows service that holds the machine's identity, talks to the Orchestrator and manages job attempts. - The Workflow Executor, one process per attempt, started inside a Windows Job Object so the whole process tree ends with the attempt.
- The User Host, one per signed-in desktop session, which starts executors on that desktop for UI automation.
- The Assistant, a desktop app that shows the Robot's status, connects the machine to an Orchestrator, and lists the automations you can start.
- The Browser Host, which connects the VeloPhex extension in Chrome and Edge to UI automation.
The Robot only makes outbound connections to the Orchestrator: HTTPS for claims, results and downloads, and optionally one WebSocket for pushed commands. No inbound port is opened on Robot machines.
Runtimes#
A package has exactly one runtime:
velophex-workflow: VeloPhex XAML workflows built in Studio.python: Python automations built with the SDK.
Each Robot reports which runtimes it has installed. The Orchestrator never places a job on a Robot that lacks its runtime. The workflow runtime is part of every Setup; the Python runtime is a separate component offered only by Setup builds that include it. See Python SDK overview.
Installation profiles#
VeloPhex Setup asks what kind of machine it is installing on:
| Profile | Installs | For |
|---|---|---|
| Developer | Studio, the Robot and the Assistant | Someone who builds and runs automations on this machine |
| Attended | The Robot and the Assistant | A person who starts automations on their own desktop |
| Unattended | The Robot; the Assistant is optional | Machines where the Orchestrator starts work with no one present |
In every profile you can also choose the components: the VeloPhex workflow runtime, the Python runtime (only in Setup builds that include it), the Assistant and the browser host. All are selected by default, and at least one runtime is required.
Where to go next#
- Core concepts defines tenants, workspaces, processes, jobs and the rest.
- System requirements lists what each component needs.
- Quickstart takes you from an empty machine to a finished job.
The components
Products in the web app
Installation
How an automation travels
Inside the Orchestrator
Inside the Robot
Runtimes
Installation profiles
Where to go next