Glossary
Short definitions of the terms used across VeloPhex and these docs.
Terms are listed alphabetically. Where a term has its own page, the definition links to it.
A#
- Activity: One step in a workflow, such as Log Message or Read Range. Activities come from activity packages. See Activities overview.
- Activity package (pack): A NuGet package that ships activities, with a manifest describing each activity and the SHA-512 of every file.
- Asset: A named value stored in a workspace: text, integer, Boolean, secret or credential. See Credentials and assets.
- Assistant: The Windows desktop app for attended use. It shows the Robot's status, connects the machine to an Orchestrator, and lists the automations you may start. See Assistant.
- Attempt: One execution of a job on one Robot. A retried job has several attempts.
- Attended: A person starts the automation on their own desktop, usually through the Assistant.
- Audit log: The append-only record of changes and security events in a tenant. See Audit log.
B#
- Browser Host: The native-messaging host that connects the VeloPhex extension in Chrome and Edge to UI automation.
- Business error: A failure caused by the business rules (for example, a rejected invoice). Final and never retried.
C#
- Cell: One Orchestrator deployment: its database, API, gateway and worker.
- Command channel (gateway): The optional outbound WebSocket a Robot keeps open to receive pushed commands. The default channel is HTTPS polling.
- Credential: An asset holding a user name and a password.
- Credential lease: A one-time, purpose-bound redemption of a secret by a Robot just before a job starts.
- Credential store: The vault that holds secret values for a tenant. Every tenant has a built-in store named "Orchestrator".
E#
- Enrollment key (machine key): A single-use key (
vpx_ek_...) that lets one machine register with a tenant. The web app and Setup call it the machine key. It is bound to the first host that uses it and expires. - Entry point: A workflow or Python function that a job can start, with a JSON Schema for its inputs and outputs.
- Execution token: A short-lived token (
vpx_rt_...) that a running attempt uses to call the Runtime API. It is valid only while that attempt runs.
J#
- Job: A request to run a process with specific inputs. See Jobs.
L#
- Library: A package with
outputType: library. Its public workflows become activities in the projects that install it. A library cannot run as a job.
M#
- Machine: A Windows host enrolled in a tenant, with its own key-pair identity. One machine hosts one Robot.
- Machine Service: The Robot's Windows service,
VeloPhexRobot.
O#
- Orchestrator: The server-side control plane. See Orchestrator overview.
P#
- Package: A published, versioned
.nupkgof a project, stored in the tenant's package feed. - PAT (personal access token): A token (
vpx_pat_...) for CI, the SDK and API clients, limited to one tenant and a subset of your permissions. Shown once. - Personal machine: A machine a person connected with their own sign-in in the Assistant. It runs only the automations that person starts, as that person.
- Process: A published automation package configured to run in a workspace.
- Profile: The kind of machine chosen in VeloPhex Setup: Developer, Attended or Unattended.
Q#
- Queue: A list of work items that Robots process. See Queues and SLAs.
- Queue item: One unit of work in a queue, with a payload, priority, optional deadline and status.
R#
- Robot: The machine agent that runs automations: the Machine Service plus, on desktops, the Assistant and the User Host.
- Robot account: The Windows user an unattended job runs as. It is assigned to workspaces; its password reaches a Robot only through a credential lease.
- Runtime: What executes a package: the VeloPhex workflow runtime (
velophex-workflow) or the Python runtime (python). Each Robot reports the runtimes it has.
S#
- Studio: The desktop IDE for building workflows. See Studio overview.
T#
- Tenant: The organization boundary in an Orchestrator.
- Trigger: A rule that starts jobs automatically, on a cron schedule (time trigger) or when a queue has pending items (queue trigger).
U#
- Unattended: The Orchestrator starts jobs on a machine with no one present.
- User Host: The per-session process that starts executors on a signed-in user's desktop.
V#
- VeloPhex XAML: The file format of VeloPhex workflows.
W#
- Workflow Executor: The process that runs one workflow attempt, inside a Windows Job Object.
- Workspace: The unit of access inside a tenant. Processes, jobs, queues, triggers and assets live in a workspace.
Next steps#
- See how the terms fit together in Core concepts.
- Start building with the Quickstart.
A
B
C
E
J
L
M
O
P
Q
R
S
T
U
V
W
Next steps