Revit
Your first Revit result
Review one supported instance Comments change in a local practice project, then confirm the committed value.
Before you begin
- The exact supported Revit/Vector OS/plugin/runtime lane and a fresh selected-document connection.
- A disposable local, non-workshared project; linked, read-only, cloud, workshared and family documents are excluded.
- One practice element that exposes an eligible writable instance Comments string parameter.
Follow the steps
Inspect the selected project
Confirm the Revit process and document in Connect. Read its local/project/workshared/read-only flags and current identity.
Checkpoint: The selected document is an eligible local practice project; do not detach or synchronize another project to force eligibility.
Select and inspect one element
Select a practice element in Revit and use read-only context to inspect its stable identity and allowed parameter descriptors.
Checkpoint: The result identifies that exact element and a writable instance Comments string parameter. Missing/unsupported fields remain unavailable.
Plan a short Comments change
Choose Plan and request a plain practice comment on that one element, using the resolved allowed parameter. Read the old/new value and element identity.
Checkpoint: The plan proposes one eligible instance-string change and commits no transaction. A display name is not permission to substitute a different parameter.
Approve the exact current plan
Check document, element, parameter, typed value, warnings and expiry. Approve once only if these match. Reject and refresh after any manual edit.
Checkpoint: The immutable approval is current for the intended practice element.
Verify the committed result
Read the actual transaction outcome and native parameter readback, then inspect Comments on the same element in Revit.
Checkpoint: A known successful commit plus matching canonical string value establishes the change. Pending or failed verification requires reconciliation.
Treat Save As as a separate operation
If an eligible Save As capability is used, grant a new local .rvt destination and review that it changes the active document path.
Checkpoint: The output and new active path are verified; old document approvals are invalidated and the original source file is untouched.
Check the result
- The intended element's allowed Comments parameter has the exact approved string with a verified committed native receipt.
- No family editing, shared model operation or engineering certification follows from this practice change.
If something goes wrong
The element lacks a writable allowed Comments parameter.
Choose another eligible practice element or stop. Do not substitute a type/formula parameter, create a shared parameter or use a fuzzy name fallback.
Resume from: Verified allowed parameter descriptor.
Revit cannot accept the operation in its current API context.
Read the busy/unavailable result and restore a safe host state. Do not force a transaction or repeatedly send the same instruction.
Resume from: Known pre-effect status and fresh admission.
Commit is Pending, the host closes or readback fails.
Keep the original operation reference. Inspect the native journal and element before any new transaction; timeout is not rollback.
Resume from: Proven original transaction outcome.
Save As loses its response.
Inspect the actual active document path and artifact before retrying. Do not write a second copy into an uncertain destination.
Resume from: Known Save As outcome and refreshed document binding.
Need help?
Include your step and this reference.
Vector OS guide: /tutorials/first-revit-result
Guide updates
Your first Revit result
Revision d09858679e1da9bb725448ec93ffd3b0294e57d2938acea5b38b67e7025134fc ·