Run Configuration
Running a customer house configuration locally from the Revit add-in
Run Configuration
The Configure command opens the Run Configuration window, which lets you take a single customer configuration that exists on the Alpha platform and run it locally in Revit — fetching the configuration, applying its option choices to the static model tree, producing a configured Revit document, and (optionally) exporting GLB/PDF/RVT/IFC outputs.
This is how you reproduce a customer's configuration on your own machine — useful when validating that a type's model and rules produce the expected geometry, or when debugging a configuration that failed in production.
Opening the Window
Click Configure in the Configure panel of the Alpha ribbon. The window title is Run Configuration and it opens as a modeless dialog, so you can keep using Revit while it is open.
The header shows the environment URL (dev or prod) the add-in is currently pointing at — confirm this matches the environment the configuration lives on before running. Switch environments via Settings if needed.
Finding a Configuration ID
Every house configuration in Alpha has a stable ID. There are two ways to get it:
From the Alpha web app
- Open the Alpha platform in your browser at alpha.asrr.nl
- Navigate to Configurations under the Construction menu
- Find the configuration you want to run — the ID is shown in the list and in the URL when you open it (
/configurations/<configurationId>)
From the Run Configuration window itself
The window already lists every configuration on the platform with its ID, project, type, status, and created date — you can just browse and pick one without leaving Revit.
Running a Configuration
There are two flows depending on whether you already know the ID.
When you already know the ID
- Paste the ID into the Search configurations… box at the top of the window. The list filters down to that configuration (debounced — give it a moment).
- Click the row to select it. The status message updates to
Selected: <id>and the Type Id field auto-fills from the configuration. - Review the settings row:
- Template — leave Use project template checked to use the template configured on the project, or uncheck and browse to a custom
.rvttemplate. - Resource Folder — where downloaded model files (RVT/GLB inputs) are cached.
- Output Folder — where the configured outputs are written.
- Template — leave Use project template checked to use the template configured on the project, or uncheck and browse to a custom
- Tick the output formats you want: GLB, PDF, RVT, IFC. RVT is on by default.
- Click Configure. Progress and status update in the bar at the bottom of the window.
When it finishes, Open Resources and Open Export buttons appear so you can jump to the cached inputs and the produced outputs on disk.
When you want to browse all configurations
The list in the middle of the window is the same view, just used as a browser:
| Column | What it shows |
|---|---|
| Id | The configuration ID |
| Project | The project the configuration belongs to |
| Type | The product type used |
| Status | REQUEST, IN_PROGRESS, COMPLETED, FAILED, or CANCELLED |
| Created | When the configuration was created |
| Actions | Per-row buttons (see below) |
Use the Search configurations… box to filter by ID, name, or project, and the Previous / Next buttons to page through results. Click the row you want, then click Configure at the bottom right.
If the selected configuration is already COMPLETED, FAILED, or CANCELLED, the bottom button changes to Retry — clicking it resets the configuration to REQUEST and re-runs it.
Per-row actions
| Action | Available when | What it does |
|---|---|---|
| Retry | COMPLETED, FAILED, CANCELLED | Reset to REQUEST and re-run this configuration |
| Open | Outputs exist on disk | Open the export folder for this configuration |
| Skip | REQUEST, IN_PROGRESS | Mark the configuration as skipped without running it |
Tick the checkbox in the leftmost column to select multiple rows; the Retry Selected and Skip Selected bulk actions appear above the settings row.
Auto Queue
Tick Auto Queue in the bottom-left to keep pulling open (REQUEST) configurations and processing them one after another. The window polls every 10 seconds for new jobs and stops when there is nothing left. Untick it to stop the loop.
This is useful when you want to drain a backlog of configurations without manually clicking through each one.
Stopping a Run
While a configuration is running, a Stop button appears next to Configure. Clicking it cancels the current run; any partial outputs already written stay on disk.
Recent Configurations
The add-in remembers the last 5 configurations you ran for quick access — useful when you are iterating on a single configuration and want to re-run it after fixing something upstream.
Queueing for the worker
Running a configuration locally is one of two ways to process it. The other is to queue it on the platform and let the worker daemon handle it on a dedicated worker machine, so nobody has to be in front of Revit clicking buttons.
How it works
A configuration on the platform always has a status:
| Status | Meaning |
|---|---|
REQUEST | Queued — waiting for a worker to claim it |
IN_PROGRESS | A worker has claimed it and Revit is running |
COMPLETED | Done; outputs uploaded |
FAILED | Errored during the run; the run log is uploaded |
CANCELLED | Stopped before completing |
The Alpha worker daemon is a background service installed on a Windows machine alongside Revit and the add-in. It polls the backend every few seconds for the next open job. When it finds one, it:
- Claims the job (status flips to
IN_PROGRESSfor that worker) - Starts the configured Revit version if it is not already running
- Waits for the add-in's named pipe to be ready
- Dispatches the configuration into Revit
- Polls the add-in for progress and reports it back to the platform
- Marks the job
COMPLETED(with outputs uploaded) orFAILED(with the run log) when Revit finishes
The daemon handles three job types — HOUSE (single configurations), BLOCK (whole blocks), and OPTION_SALES (option-sales drawings) — using the same lifecycle.
Queueing a configuration
To queue a configuration for the worker, just create one on the platform — any newly created configuration starts in REQUEST and is picked up by the next available worker. There is no separate "queue" button; status REQUEST is the queue.
To re-queue a configuration that already ran, use the Retry action — either inline on a row in this window, or Bulk Retry on selected rows. Both reset the configuration to REQUEST so the daemon picks it up again. You can do the same from the platform's configuration detail page.
Local vs queued — when to use which
- Local (this window): iterating on a single configuration, debugging a failing run, or validating something before letting the worker chew through a backlog.
- Queued (worker daemon): bulk processing, overnight runs, or any case where you do not want to keep Revit open on your own machine. Auto Queue in this window is essentially the same idea but pinned to your local Revit — handy if no worker is set up.