Proactive Worksets User Guide
Proactive is a BIM governance app for Autodesk Revit. Proactive Worksets is the feature that checks eligible elements against a shared set of rules and moves them to the intended workset while you model.
Contents
This guide covers everyday use in Revit and configuration management for BIM coordinators.
Before you begin
Proactive requires:
- Windows 10 or Windows 11, 64-bit.
- Autodesk Revit 2025, 2026, or 2027.
- A workshared Revit model. Proactive remains inactive in a non-workshared model.
- A published Proactive JSON configuration linked to the model.
- The target worksets named by that configuration to exist in the model.
The standalone Proactive Config Manager requires the .NET 8 Desktop Runtime. The Revit add-in uses Revit's installed runtime and does not need a separate runtime installation.
Install Proactive
- Close Revit.
- Run
ProactiveSetup.exe. - Select the installed Revit versions that should receive the add-in.
- Include Proactive Config Manager if you create or maintain configurations.
- Start Revit and confirm that the Proactive tab appears.
The standard installer is per-user and does not require administrator rights. To upgrade, run the newer installer over the existing installation. To uninstall, use Windows Settings > Apps > Installed apps.
Quick start for Revit users
- Open a workshared Revit model.
- Look at the floating Proactive Command Panel. If it reports a configuration error, ask your BIM coordinator which configuration the model should use.
- If you are responsible for linking the model, select Proactive > Workset > Load Configuration…, choose the published
workset-gatekeeper.json, and confirm. The link is saved in the model and therefore affects other users of that model. - Wait for Proactive to validate and activate the configuration. A green status dot means it is operating normally.
- Model as usual. Proactive processes eligible changes during safe idle moments.
- If the Command Panel reports held elements, open Control Centre to see the cause and take the appropriate action.
Use Workset > Show Current Configuration whenever you need to confirm which configuration the active model is using.
Understand the status displays
The floating Command Panel shows the active model's state. Click the purple P to collapse or expand it; drag the P to reposition it. Select Control Centre to open the detailed panel.
| Dot | Meaning | What to do |
|---|---|---|
| Green | Proactive is active. It may be clear or processing issues normally. | Continue working; open Control Centre if a holding count is shown. |
| Amber | Proactive is starting, paused, or needs attention. | Read the status text. Resume from the Workset menu if paused. |
| Red | The configuration is missing or invalid. | Open Control Centre, check the current configuration, or contact a coordinator. |
| Grey | The active model is not workshared. | Enable worksharing or use a workshared model. |
The Command Panel also provides:
- Ignore Selected: Make the current Revit selection an intentional exception.
- Ignored: Review elements currently excluded from governance.
- Control Centre: Open or close the detailed status and controls.
Control Centre
Control Centre contains:
- Current engine and configuration status.
- Catch-up progress when a model-wide scan is running.
- Needs Attention counts for rule conflicts, missing target worksets, and access restrictions.
- The ignored-elements list, including restore actions.
- Recent activity and a link to the full activity log.
- The Undo reprocess delay preference.
- Shortcuts to Load Config and Open Config Manager.
Resolve elements that need attention
Proactive uses three system holding worksets so unresolved elements stay visible and recoverable.
| Status | Cause | Resolution |
|---|---|---|
| Rule Conflicts | More than one rule matched and the configuration could not select one result safely. | Review the overlapping rules. Make the conditions exclusive, enable priority resolution for that rule set, or ignore the element if the exception is intentional. Publish the fix and run Rescan Model Now. |
| No Target Workset | A matching rule named a target workset that does not exist in the model. | Create the missing workset or change the rule's target, publish the configuration, then run Rescan Model Now. |
| Waiting Access | Revit ownership, workset editability, or another access restriction prevented the move. | Obtain access, relinquish or synchronize as appropriate, then allow Proactive to retry or run a rescan. |
Expand an attention card to inspect the affected elements. You can select an element in Revit from the list or ignore selected exceptions.
If an element matches no rule and its category has no fallback rule, Proactive leaves it in place and records the outcome. Add a rule or category fallback if that element should be governed.
Use the Revit ribbon commands
Open the Proactive tab in Revit.
Workset menu
| Command | Purpose |
|---|---|
| Pause Proactive Workset / Resume Proactive Workset | Pauses or resumes automatic assignment for the current Revit session. Queued and held work is preserved while paused. |
| Rescan Model Now | Schedules a full model pass and reapplies the active rules to eligible existing elements. The scan runs in slices during Revit idle time. |
| Catch Up Now | Drains the active model's outstanding backlog without waiting for the normal idle pacing. Select it again to cancel. Safety guards and pause state still apply. |
| Ignore Selected | Excludes the current Revit selection from Proactive processing. |
| Rules… | Opens Proactive Config Manager. |
| Settings… | Opens Control Centre at Preferences & Controls. |
| Load Configuration… | Links or relinks the active model to a Proactive JSON configuration. |
| Show Current Configuration | Shows the stored reference, its resolved location, project identity, and runtime state without changing anything. |
| Unload Configuration | Removes the model's configuration link. It does not delete the configuration, but the model remains ungoverned until another configuration is linked. |
| View Activity Log | Opens the current session's assignment, holding, and refusal history. |
When moving a model to another configuration, use Load Configuration… directly. Do not unload first. Proactive presents a stronger confirmation when the new configuration belongs to a different project.
Utilities
- Create Worksets: Preview and create several worksets from a pasted list or from the linked configuration.
- Workset Auditor: Review current element-to-workset assignments and optionally move selected groups.
About
Use About Proactive… to see the installed version. The About menu also lets you replay the Command Panel and Workset menu tutorials.
Ignore an intentional exception
Ignoring is appropriate when a deliberate project decision should override the normal workset rules.
- Select one or more elements in Revit.
- Select Ignore Selected on the Command Panel, in Control Centre, or in the Workset ribbon menu.
- Confirm that the ignored count has increased.
Proactive sets the instance parameter Proactive Workset - Ignore. While the value is enabled, the element is not assigned, held, deferred, or retried.
To return an element to governance:
- Open Ignored or the ignored-elements section in Control Centre.
- Find the element by category, family, workset, or element ID.
- Select Restore, or use Restore all for the complete list.
- Run Rescan Model Now if you want the restored elements checked immediately.
Moving elements through Workset Auditor records the move as an intentional decision and ignores the moved elements so Proactive does not immediately move them back.
Create and audit worksets
Create Worksets
Use this utility when preparing a new model or when a rule reports a missing target workset.
- Select Proactive > Utilities > Create Worksets.
- Paste one workset name per line, or load the standard list from the linked configuration.
- Review the preview. It separates names that can be created, worksets that already exist, duplicates, and invalid names.
- Confirm the creation count.
The utility never renames or deletes existing worksets and never moves elements. Proactive does not silently create user-defined target worksets simply because a rule names them.
Workset Auditor
Workset Auditor reports what is currently in the model; it does not decide whether an assignment is compliant with the configuration.
- Select Proactive > Utilities > Workset Auditor.
- Choose Worksets, Categories, or Flat list.
- Search or filter by workset, category, family, or type.
- Tick a group or row.
- Select Select in Revit for a read-only review, or choose a destination and select Move elements.
- Review the result summary, including elements Revit could not change.
Set up a configuration
This section is for BIM coordinators and configuration administrators.
Create the first project
- Open Proactive Config Manager from the Start menu or from Workset > Rules… in Revit.
- On first run, choose a shared practice root if the configuration will be used by multiple coordinators.
- Select New Project.
- Enter the project and configuration names, project code if used, and target folder.
- Optionally import an existing JSON configuration as the starting point.
- Open the new configuration.
A project may contain several configurations, for example separate Architecture, Structure, and MEP configurations.
Connect to an existing configuration
Use Connect to Existing Configuration rather than creating a second copy of a colleague's project.
- On the Projects screen, select the connect action.
- Browse to a configuration folder or to a container holding several project configurations.
- Allow Config Manager to validate the identity and add the connections to this computer.
Remove only disconnects the current computer. Delete permanently removes Proactive's shared configuration content and requires an explicit typed-name confirmation. Treat those actions differently.
Config Manager page reference
| Page | Purpose |
|---|---|
| Dashboard | Configuration health, rule and workset counts, source, version, and shortcuts. |
| Rule Sets | Create category sheets, rules, conditions, targets, fallbacks, and overlap behaviour. |
| Publish | Review pending changes, validation results, concurrency state, and publish history. |
| Worksets | Maintain the reusable target-workset vocabulary and copy or paste workset lists. |
| Settings | Set the local Undo grace period and the published outcome-log destination. |
| Backups | Restore or remove automatic configuration backups. |
| Validation | Run a complete configuration check and review errors and warnings. |
| Activity Log | Review configuration editing and publishing activity. |
| Import / Export | Export a JSON copy or validate and import another JSON configuration. |
| About & Diagnostics | View versions, paths, health checks, and copy diagnostics for support. |
| Admin Access | Manage the Windows users and groups allowed to edit the configuration. |
Users without admin access can review a configuration but cannot stage, restore, import, or publish changes.
Build workset rules
Rule evaluation model
Each rule set is a category sheet. A rule contains:
- A stable rule ID and a descriptive name.
- One Revit category.
- A target workset.
- Zero or more match conditions.
- AND or OR condition logic.
- An enabled or disabled state.
- An optional fallback state.
- A priority number when that rule set uses priority resolution.
Only enabled rule sets and enabled rules participate in governance.
Available condition sources
- Type Name
- Family Name
- Instance Name
- Parameter, with a Type or Instance scope
- File Name
- Path
Available text comparisons are equals, not equals, contains, not contains, starts with, and ends with. Matching is case-insensitive unless Aa is enabled for the condition.
AND and OR
- AND means every condition in the rule must match.
- OR means at least one condition must match.
Example: a Walls rule can use Type Name contains External OR Type Name starts with EXT- and target A-External.
Fallback rules
A fallback rule has no conditions and matches elements in its category that were not matched by another rule. Fallback priority is fixed at 99. Use one when every eligible element in a category must have a destination.
Overlapping rules and priority
The safe default is Apply by priority: Off. If two rules in the same category both match, Proactive treats the result as a conflict instead of guessing.
When Apply by priority is on, the matching rule with the lowest priority number wins. An exact tie at the winning priority remains a conflict.
Prefer mutually exclusive conditions where possible. Enable priority only when the ordering is intentional and documented.
Add a rule
- Open Rule Sets and select or add a category sheet.
- Select Add Rule.
- Give the rule a descriptive name.
- Select its target workset. Use Add new workset… if the reusable name is not listed.
- Add conditions and choose AND or OR.
- Mark it as a fallback only if it should catch all otherwise unmatched elements in that category.
- Enable the rule after reviewing it.
- Fix any inline validation errors before saving.
Declaring a workset name in Config Manager does not create that workset in Revit. Use Create Worksets in each model that needs it.
Save, validate, and publish changes
Config Manager separates editing from live runtime use:
- Make changes on Rule Sets, Worksets, Settings, or Admin Access.
- Select Save Changes. This writes the changes to the Draft configuration; it does not change the Published package used by Revit.
- Open Validation and select Validate All, or review validation on the Publish page.
- Resolve every error. Warnings should be reviewed but may not block publishing.
- Open Publish, review the change summary, and select Publish.
- In Revit, confirm the active configuration/version in Control Centre or Show Current Configuration.
- Run Rescan Model Now when the new rules should be applied to existing elements.
Backups are created automatically when the configuration is saved. Restoring a backup first checks that the backup is valid; if validation fails, the current configuration remains unchanged.
If another coordinator changes the configuration after you opened it, publishing is blocked to prevent overwriting their work. Reload the latest configuration, reapply your changes, and publish again.
Share configurations with other coordinators
Use one genuinely shared location that every coordinator can reach:
- A UNC network share, such as
\\server\BIM\Proactive. - A mapped network drive.
- An Autodesk Construction Cloud folder available through Desktop Connector.
One coordinator creates the project. Everyone else connects to that existing project or points Config Manager at the same practice root. Do not independently create projects with the same display name: each creation has a different internal identity.
Folders under a personal Desktop, Documents, OneDrive, or Dropbox path are suitable only for single-machine use. They are not a reliable multi-user configuration store because each user's absolute path differs and file synchronization is not a live shared registry.
When a configuration is under the practice root, Proactive stores a portable or logical reference so different machines can resolve the same configuration even if their mapped drive letters differ.
For additional deployment detail, see Shared multi-user setup.
Troubleshooting
| Symptom | Likely cause | Resolution |
|---|---|---|
| The Proactive tab is missing | The add-in was not installed for this Revit version, or Revit declined to load it. | Rerun the installer for the correct Revit version and accept the add-in prompt on startup. |
| “Open a workshared model to activate Proactive” | The current document is not workshared. | Open a workshared project or enable worksharing. |
| Configuration error / red dot | No configuration is linked, its path cannot be resolved, or validation failed. | Use Show Current Configuration, reconnect the shared practice root if needed, then load or republish a valid configuration. |
| A target workset is missing | A rule names a workset that is absent from the model. | Use Create Worksets, then rescan. |
| Elements remain in Waiting Access | Revit cannot edit the element or destination workset. | Resolve ownership/editability, synchronize or relinquish, and retry. |
| A deliberate manual move is reversed | The element is still governed and matches a different target. | Use Ignore Selected for the approved exception, or change the rule. |
| A colleague's project is not listed | The computers use different practice roots or the shared location is offline. | On the Projects screen, select Change… and choose the same shared root, then retry. |
| Revit asks to move the model to another project | The selected configuration has a different project identity. | Cancel if unintended. Confirm only for a genuine project migration; do not unload first. |
| Processing is safely blocked because document identity is unresolved | Two open documents appear to be copies of the same model and cannot be distinguished safely. | Close one copy, then continue in the intended document. |
| Config Manager will not start | The .NET 8 Desktop Runtime may be missing or the optional app was not installed. | Install the runtime or rerun Proactive Setup with Config Manager selected. |
| Publish is blocked | Validation errors, read-only access, another user's lock, or an external change is present. | Read the Publish message, validate, request admin access, or reload the latest configuration as instructed. |
Logs and diagnostics
For assignment questions, start with Workset > View Activity Log. It records assignments, holding outcomes, refusals, and configuration events for the session.
For configuration or support issues:
- Open About & Diagnostics in Config Manager.
- Review the health checks.
- Select Copy Diagnostics and include the result with the issue report.
- Include the Revit version, model size, affected element IDs, and what you were doing when the issue occurred.
Operational logs are stored under %LOCALAPPDATA%\Proactive\Logs by default. Config Manager's local activity log is stored under %APPDATA%\Proactive\ConfigManager. A coordinator may configure the shared outcome-log destination under Settings as Project Logs, User App Data, or an absolute custom folder.
Frequently asked questions
Does Proactive create every target workset automatically?
No. It automatically manages its three system holding worksets, but user-defined target worksets are created only through an explicit Revit action such as Create Worksets.
Do Draft changes affect Revit users?
No. Revit uses the Published configuration. Draft changes become available only after validation and publishing.
Does unloading a configuration delete it?
No. It removes only the link stored in the Revit model. The shared configuration files remain in place.
Can I manually place an element on another workset?
Yes, but Proactive may move it back if it remains governed. Ignore the element when the manual placement is an approved exception, or update the rule when the change should apply generally.
Can one project have several configurations?
Yes. A project can contain separate configurations for different disciplines, models, or governance needs.
What happens while Proactive is paused?
New elements remain where they are drawn. Queued, held, and deferred work is preserved and resumes normally when Proactive is restarted.
More in this section
-
Proactive Worksets Shared Multi-user Setup
This guide is for coordinators who share Proactive Worksets configurations across more than one machine (for example, two BIM coordinators collaborating on the same workshared Revit models). It…