> ## Documentation Index
> Fetch the complete documentation index at: https://docs.speckle.systems/llms.txt
> Use this file to discover all available pages before exploring further.

# Revit Parameter Updater

> Review and batch-edit Revit parameters from a Speckle dashboard, then apply the changes back to your model via Issues.

<Warning>
  Revit Parameter Updater is in **beta** and available only on workspaces where
  it has been explicitly enabled. The feature is limited to **Revit** at this
  stage.

  If you do not yet have access and would like to join the beta, fill out the
  registration form: [Request access to Revit Parameter Updater](https://share-eu1.hsforms.com/2Jy0rZrUfQpKkbvtomaxXMA2fs1ws).
</Warning>

Revit Parameter Updater lets you review and batch-edit Revit element parameters
from a Speckle dashboard, then apply those changes back to the Revit model. Each
batch of edits is logged as an Issue so you can track what changed and why.

\[\[PLACEHOLDER - Revit connector (DUI) on the left publishing a model, Speckle dashboard with the Parameter Updater widget on the right]]

## Prerequisites

Before you begin, confirm you have:

* A workspace where Revit Parameter Updater has been **enabled** by the Speckle
  team.
* The **Speckle Revit connector** installed and signed in.
* A Revit model that has been **published** to a Speckle project at least once.

## Where to find Revit Parameter Updater

In any dashboard, open the widget sidebar and scroll to the **Data Conditioning**
category at the bottom. Drag the **Parameter Updater** widget onto the canvas.

If you do not see the **Updater** category, Revit Parameter Updater has not
been enabled for your workspace.

## End-to-end workflow

<Steps>
  <Step title="Publish a model from Revit">
    Open your Revit project and use the Speckle Revit connector to publish it to your target project and model. Wait for the publish to complete so you have at least one Revit model version available as a dashboard data source.

    <Tip>
      If you want to edit or populate empty parameters, make sure to enable
      **Send null/empty parameters** in the connector settings before sending
      your model to Speckle.
    </Tip>
  </Step>

  <Step title="Create a dashboard with that model">
    In the Speckle web app, go to your workspace **Dashboards**, create or open a dashboard, and add a **Model Viewer** widget that points at the published Revit model and version. You should see the model rendered so the dashboard can read elements and parameters.
  </Step>

  <Step title="Configure the Parameter Updater widget">
    Add the **Parameter Updater** widget from the **Data Conditioning** category and configure its settings. Pick one or more Revit model versions as data sources, choose editable and read-only columns (fields under `properties` are editable), and optionally group rows by a property such as level or type so you see a grouped table of Revit elements.
    \[\[PLACEHOLDER - Widget configuration sidebar showing data sources, Columns, and Group by]]
  </Step>

  <Step title="Review and edit Revit parameters">
    In the table, edit parameters directly in cells, set values for an entire group from the group header, or update only selected elements using the selection row; cells may be editable, read-only, or marked as “Missing parameter” when the element does not have that field. When you have unsaved edits, a footer bar appears at the bottom of the widget showing the number of pending changes with **Discard** and **Submit change requests** actions.
    \[\[PLACEHOLDER - Parameter Updater table with editable, read-only, and missing parameter cells plus footer bar]]
  </Step>

  <Step title="Submit a change request as an Issue">
    Click **Submit change requests** in the footer bar and fill in the dialog with a title, status, optional tracking fields, and a description that summarises the changes. When you submit, Speckle creates an **Issue** with a screenshot, viewer state, and the parameter changes stored as `objectDeltas` so you can track what changed and why.
  </Step>

  <Step title="Apply the approved changes in Revit">
    In Revit, open the same project, find the published model card in the Speckle connector, and open the related Issue via the **Issues** icon. Use the **Apply changes** action so the connector sends the batch of parameter updates, validates each one, and applies them in a single transaction, showing a toast that reports whether all, some, or none of the parameters were updated.
    \[\[PLACEHOLDER - Revit connector Issue panel with Apply changes action and success toast]]
  </Step>
</Steps>

## What you can and cannot edit

### Editable

* Instance, Type, and System Type parameters exposed under `properties` in the
  Revit object tree.
* Text, numeric, boolean (Yes/No), and some ElementId-backed parameters (for
  example materials and levels that can be resolved by name).

### Not editable

* **Read-only parameters** – system-controlled values that the Revit API does
  not allow you to change.
* **Missing parameters** – elements that do not have the selected parameter. The
  widget shows “Missing parameter” and skips these during bulk edits.
* **Linked model elements** – elements from linked Revit models are blocked. The
  connector reports “Cannot modify elements from a linked model”.
* **Parameters not published** – parameters that were not included when the
  model was published will not appear in the widget.
  \[\[PLACEHOLDER - Full Parameter Updater widget: table with editable, read-only, and missing parameter cells highlighted, footer bar with pending changes and Submit button]]

## Known limitations

| Limitation                 | Detail                                                                                                                                                               |
| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Revit only                 | Revit Parameter Updater currently works with Revit models only.                                                                                                      |
| Linked models              | Elements from linked models cannot be updated. Requests targeting linked elements are skipped with an error.                                                         |
| Path format                | The parameter path must resolve to three segments (scope, group, name) after stripping prefixes. If the path structure does not match, the update is rejected.       |
| Renamed or removed params  | If a parameter no longer exists or has been renamed since the model was published, the connector reports “Parameter not found”.                                      |
| Read-only enforcement      | Some parameters appear editable in the dashboard but are marked read-only in Revit. The connector rejects these at apply time.                                       |
| Unit handling              | Numeric values are scaled to Revit internal units. Extreme values or unit mismatches can produce failures.                                                           |
| ElementId parameters       | Setting ElementId values by raw ID is not yet supported. The connector attempts to resolve by element name (materials, levels, phases). Other types may not resolve. |
| No automatic Issue polling | The connector does not automatically poll for Issues. You must open the UI and trigger the apply action.                                                             |

## What to test

For beta testing, focus on:

* **Happy path** – update a small set of parameters (for example door marks or
  wall types) and confirm they update correctly in Revit.
* **Mixed results** – include parameters that should fail (read-only, missing,
  linked elements) alongside valid edits. Confirm the widget flags uneditable
  cells and Revit reports partial success with grouped errors.
* **Scale** – try batches of tens to low hundreds of elements and check that the
  experience remains usable and messaging is clear.
* **Issue traceability** – confirm each submission creates a single Issue with a
  useful screenshot, viewer state, and description so you can audit what was
  changed later.

\[\[PLACEHOLDER - Scenario montage: Several dashboards and Issues for different Revit models]]

## Feedback and next steps

* If something behaves unexpectedly, note:
  * The parameter path and element type.
  * The exact error text from the Revit toast.
  * The Issue link from the Speckle web app.
* Share those details when reporting bugs so we can reproduce them quickly.
* If you want a walkthrough:
  * Book a short session for a live demo and onboarding.

<CardGroup cols={2}>
  <Card title="Book a Revit Parameter Updater session" href="https://calendar.app.google/rtn2HBFZwXSZY7Br5">
    Provide feedback on Revit Parameter Updater currently released in Beta.
  </Card>
</CardGroup>