Packages and processes

Publish or upload automation packages to the tenant feed, manage their versions, and create the processes that run them in a workspace.

A package is a versioned .nupkg file with an automation in it: a Studio workflow project or a Python project. Packages belong to the tenant. A process is what you run: it lives in a workspace and points at one package version and one entry point, with its own defaults.

Get a package into the Orchestrator#

From How
Studio Publish to the Orchestrator. See Publish to Orchestrator.
Python SDK velophex publish. See Packaging and publishing.
Web app Upload the .nupkg on the Packages page (below).
CI or any NuGet client dotnet nuget push to the tenant feed with a personal access token.

Publishing needs the packages.create permission (the Automation Developer role has it). Uploads up to 512 MB are accepted.

Upload a package in the web app#

  1. In the sidebar, switch to Tenant and select Packages.
  2. Select Upload package.
  3. Under Package files, choose one or more .nupkg files.
  4. Select Upload package.

Publish from CI#

Publish from CIPowerShellCopy
dotnet nuget add source "https://orchestrator.example.com/api/v1/tenants/<tenantId>/feed/v3/index.json" `
  --name velophex --username ci --password $env:VELOPHEX_TOKEN --store-password-in-clear-text
dotnet nuget push .\Invoices.1.2.0.nupkg --source velophex --api-key $env:VELOPHEX_TOKEN

Keep the token in your CI system's secret store, never in the script.

What the Orchestrator checks#

  • The package manifest and the hash of every file it lists. A Python package must include its uv.lock.
  • Archive limits that refuse malformed or oversized archives.
  • A signed package's signature is always verified; a broken signature is refused. Packages named VeloPhex.* must carry the VeloPhex signature.
  • A version that already exists is refused with 409. Publish a new version instead.

Unsigned packages are accepted unless your tenant or deployment requires signatures. See Tenant settings and Package signing and supply chain.

Manage package versions#

Tenant ▸ Packages has two tabs: Processes (packages you can run) and Libraries (packages other projects use as dependencies; they cannot be started).

  1. Select View versions on a package.
  2. The list shows each version's Runtime, Entry points, Signed by and Status.
  3. From a version's ⋮ menu, select Download to get the .nupkg, or Delete to remove that version for good. For a library, Activities lists the activities it provides.

Create a process#

You need the processes.edit permission in the workspace (for example Workspace Administrator).

  1. Open the workspace and select Automations ▸ Processes.
  2. Select New process.
  3. Under Basics, enter a Name and an optional Description.
  4. Under Package, choose the Package, the Version and the Entry point. The version's default entry point is preselected.

  1. Under Execution, choose how the process may run: Attended (Assistant), Unattended (triggers and queues), or both.
  2. Under Defaults, optionally turn on Always run the latest version, and set a Default priority (0 to 100), Max running jobs and Default inputs (a JSON object).
  3. Under Advanced, optionally set resource limits for each run: Memory (MB), CPU rate (%), Handles, Run time (seconds) and CPU time (seconds).
  4. Select Create process.

The process appears in the list with its runtime, how it runs, its version and entry point.

Work with a process#

Each process's ⋮ menu has:

Action Use it to
Start job Run the process now. See Jobs.
Edit Change its settings or pin another version.
Upgrade to latest version Point the process at the newest package version. Jobs already running keep their version.
Add trigger Schedule it or start it from a queue. See Triggers and schedules.
View jobs, View logs Jump to its jobs or log lines.
Link to workspace, Move to workspace Share it with or move it to another workspace.
Delete Remove it. It can no longer be started or scheduled.

Retry policy and time limit#

Without a retry policy, failed jobs are not retried. Without a time limit, the tenant's default job execution timeout applies. Both are set on the process through the API (retryPolicy and executionTimeoutSeconds on POST or PUT …/workspaces/{workspaceId}/automations). In the API a process is called an automation. See Jobs.

Runtimes and placement#

A package lists the runtimes it needs. Robots report the runtimes they have, and a job is only offered to a robot that has them all. If no robot that serves the workspace can run the process, starting a job is refused with 409 no_capable_runner. Install the runtime on a machine assigned to the workspace, or assign such a machine. See Machines and robots.

Next steps#

Get a package into the Orchestrator

Upload a package in the web app

Publish from CI

What the Orchestrator checks

Manage package versions

Create a process

Work with a process

Retry policy and time limit

Runtimes and placement

Next steps