Introduction
What VeloPhex is, who these docs are for and where to start reading.
VeloPhex is a platform for building, running and governing software automations. You design automations on a Windows desktop in Studio (or write them in Python with the Python SDK), publish them as signed packages to the Orchestrator, and run them on Windows machines where the Robot is installed. The Orchestrator decides which Robot runs which job, keeps credentials out of your automation code, and records what happened.
These docs cover the whole platform: installing it, building automations, operating the Orchestrator and the Robot fleet, securing it, and automating it through the API.
Who these docs are for#
| You are... | Start with |
|---|---|
| An automation developer building workflows | Quickstart, then Studio overview |
| A Python developer | Python SDK overview |
| An administrator installing the platform | Deployment options, then Install on-premises |
| Responsible for Robot machines | Robot overview and Install the Robot on Windows |
| Reviewing security | Security model overview |
| Integrating another system | API overview and Webhooks |
What you can build#
A VeloPhex automation can:
- Drive desktop applications and web pages in Chrome or Edge through UI automation.
- Read and write Excel workbooks and CSV files without Excel installed.
- Work with files, folders, data tables, processes, the clipboard and PowerShell.
- Read assets and credentials from the Orchestrator, add work to queues and start other automations.
- Invoke another published automation, including a Python automation, as a step of the same job.
Every automation, whether it is a workflow or Python, becomes the same kind of package: a .nupkg file with a manifest that lists the SHA-512 hash of every file in it. The Orchestrator stores it in a per-tenant package feed and hands it only to Robots that have the runtime it needs.
How the docs are organized#
Each tab in the top bar is a section:
- Getting started: concepts, requirements and a first end-to-end automation.
- Studio: the desktop IDE.
- Robot: the Windows agent.
- Orchestrator: deployment and day-to-day operation of the control plane.
- Python SDK: Python automations.
- Activities: the building blocks of workflows, and how to build your own.
- Security, Scaling and Administration: running VeloPhex responsibly at size.
- API: REST endpoints, authentication and webhooks.
- Troubleshooting and support: fixes for common problems and how to get help.
Search anywhere
Press Ctrl + K (or /) to search every page.
Conventions used in these docs#
- Commands for Windows machines use PowerShell. Commands for the Orchestrator host use
bash. - Values in angle brackets, such as
<version>or<tenantId>, are placeholders you replace. orchestrator.example.comstands for the address of your Orchestrator.- Callouts marked Warning or Danger describe steps that can lose data or lock you out. Read them before you continue.
Next steps#
- Read the Platform overview to see how the components fit together.
- Learn the vocabulary in Core concepts.
- Build and run something in the Quickstart.
Who these docs are for
What you can build
How the docs are organized
Conventions used in these docs
Next steps