Orchestrator overview

What the VeloPhex Orchestrator does, how its web app is organized, and which page covers each task.

The Orchestrator is the VeloPhex control plane. It stores your automation packages, decides which Robot runs which job, holds the configuration and secrets your automations need, and records what happens. You use it through a web app, a REST API and a NuGet package feed.

What you can do in the Orchestrator#

Area Where to read more
Sign in, passkeys, two-step sign-in, access tokens Sign in and secure your account
Tenants, workspaces and who can use them Workspaces and tenants
Machines, Robots and robot accounts Machines and robots
Packages and the processes that run them Packages and processes
Starting, stopping and reading jobs Jobs
Schedules and other triggers Triggers and schedules
Work queues, items and SLAs Queues and SLAs
Assets, credentials and credential stores Credentials and assets
Files for automations Storage buckets
DMN decision tables Business rules
Users, groups, roles Manage access
Audit log and outgoing webhooks Audit log and webhooks
Tenant settings (feeds, Robots, retention, alerts, calendars and more) Tenant settings
Dashboards, health checks and logs Monitoring and health
Tenants and platform-wide settings Platform administration
Running your own Orchestrator Deployment options

Find your way around the web app#

The web app has a top bar and a sidebar.

  • Top bar: the app launcher (grid icon, top left), Search or jump to… (Ctrl+K), notifications, and your avatar menu with My account, Security, the theme and Sign out.
  • Sidebar, top: the workspace switcher. Pick the workspace you want to work in.
  • Sidebar, Workspace / Tenant switch: chooses which menu the sidebar shows.
Sidebar Items
Workspace Home, Automations (tabs Processes, Jobs, Triggers, Logs), Queues, Assets, Business rules, Storage buckets, and Settings (tabs Users, Machines)
Tenant Monitoring, Workspaces, Machines, Robots, Packages, Credential stores, and under Govern: Manage access, Audit, Webhooks, Settings

You only see the items your roles allow. Webhooks and Settings need permission to view tenant settings. Platform administrators also reach Platform administration from the app launcher (Admin). See Platform administration.

A workspace's Home page summarizes its processes, assets, queues, triggers, access and machines, with live charts for machines and robots, job status and job history. Pick a time range (such as Last day) at the top right.

Pages update live: job states, Robot presence and queue counts change without a refresh.

Jump to a page or action#

  1. Press Ctrl+K, or select Search or jump to… in the top bar.
  2. Type part of a page name or an action, such as start or queues.
  3. Use the arrow keys and press Enter to open it.

The palette lists the pages of the current workspace and tenant, and actions such as Start a job and Add a process.

How the pieces work together#

  1. You build a project in Studio or with the Python SDK and publish it. The package lands in the tenant's package feed.
  2. In a workspace, you create a process that points at a package version and an entry point.
  3. You add a machine, enrol a Robot on it, assign the machine to the workspace, and give the workspace a robot account for unattended jobs.
  4. A person, a trigger or the API starts a job. The Orchestrator checks the inputs against the entry point's input schema.
  5. A Robot whose machine serves the workspace, and which has the runtime the package needs, claims the job and runs it.
  6. The Robot sends logs and the result. You see them in the web app, the audit log records the actions, and webhooks notify your own systems.

What it is built from#

The Orchestrator ships as one Docker image that contains the API and the web app. It needs PostgreSQL 18 (with pg_trgm), blob storage for package files (a local volume, an S3-compatible bucket or Azure Blob Storage) and a TLS front door. The supported Docker Compose stack runs Caddy, the Orchestrator, PostgreSQL and Redis on one Linux host, with all background work in the one Orchestrator process. See Install on-premises and Architecture for scale.

Client How it connects
People The web app over HTTPS
Studio and the Assistant A browser sign-in approved in the web app
Python SDK and CI A personal access token (vpx_pat_…) against the REST API and the package feed
Other applications An external application's client ID and secret (client credentials)
Robots Outbound HTTPS (and optionally WebSocket), authenticated with the machine's own key pair

Robots never need inbound ports.

Next steps#

What you can do in the Orchestrator

Find your way around the web app

Jump to a page or action

How the pieces work together

What it is built from

Next steps