Karo.ModelGuard handbook.

What it does

Karo.ModelGuard enforces BIM policies while people work in Revit, not after the model is already damaged. When a controlled action happens, the add-in either asks for a written reason (Justify), blocks the action (StrictBlock), or stays silent (Disabled). Every decision is written to one shared team log on your network share.

100% On-Premise & Zero-Cloud. A single configuration folder on your network share serves as the single source of truth for the entire office — project models and governance data never leave your corporate perimeter.

Who does what

First-time setup (BIM manager)

1. Install Karo.ModelGuard on a machine with Revit (Karo.ModelGuard-Setup.msi).
2. Start Revit. If nothing is connected yet and the add-in is licensed, it automatically prompts you to launch Karo.ModelGuard Initial Configuration.
3. Choose Create new configuration.
4. Pick a network folder (UNC path) that all team machines can reach.
5. The app creates the folder structure and makes you the first administrator (current Windows user).
6. Restart Revit. Open the Karo tab → ModelGuard.
   • Tip: To manage, check, or activate your license at any time, hold Shift and click the ModelGuard ribbon button.

Connecting other users

1. Install the same add-in.
2. On first run, choose Connect to existing configuration.
3. Select the same network folder the BIM manager created.
4. Restart Revit. Policies apply automatically — no manual JSON editing.

Typical day for a user

1. Work in Revit as usual.
2. If a policy is in Justify mode (for example Explode CAD), a dialog asks for a short reason before the action continues. Cancel = action does not run.
3. If a policy is in StrictBlock mode, the action is cancelled and a clear message explains why.
4. Open ModelGuard only when you need Overview, How to use, or language (EN / RU).

Typical day for an administrator

1. Open ModelGuard on the Karo ribbon.
2. Rules — set each policy to Disabled / Justify / StrictBlock. Changes save to the shared config and reach connected users without restarting Revit.
3. Log — filter the central CSV event log (who, when, which policy, justification text).
4. Terminal — see who is connected, Revit/plugin versions, last activity (monitor only — no settings here).
5. Administrators — add or remove admin Windows accounts when needed.

Policies included

Important

• Daily admin work happens inside Revit, not in Initial Configuration.
• Initial Configuration is only for create or first connect.
• If the network folder is temporarily unavailable, the add-in can keep working from a local cache; if there is no cache, it enters a safe mode that does not crash Revit.

Safe to install. Karo.ModelGuard is digitally signed by Karo Modum. Windows SmartScreen may show an "Unknown publisher" notice on first download until reputation builds — this is expected for specialized BIM tools. The installer registers the publisher certificate automatically.

Before you start

• Close all running Revit sessions before installing or updating.
• You need Windows administrator rights for installation (places add-in files in ProgramData and registers the publisher certificate once).
• Make sure at least one supported Revit version (2023–2027) is installed.
• Plan a network share for the team configuration (BIM manager). Users need read access to the config folder and write access to the runtime/log folder (IT can set this once).

Step-by-step

1. Download Karo.ModelGuard-Setup.msi from your purchase confirmation or download page.
2. Double-click the downloaded .msi file. Windows Installer will launch and prompt for administrative permissions (UAC) to install per-machine.
3. If Windows SmartScreen shows "Windows protected your PC":
   • Click More info → Run anyway.
4. The installer automatically detects installed Revit versions (2023–2027), ensures Revit is closed, deploys Karo.ModelGuard Initial Configuration, and seamlessly upgrades any previous installations.
5. Click Install and wait for completion.
   • The setup automatically registers the Karo publisher certificate in the Windows trust store for trusted future updates.
6. Start Revit. On the Karo ribbon tab you will see ModelGuard.
7. Complete Create or Connect in Initial Configuration when prompted, then restart Revit.

Silent & enterprise deployment

For automated deployment across corporate networks or workstations, run via command line:

msiexec /i "Karo.ModelGuard-Setup.msi" /qn

Digital signature & security

Karo.ModelGuard is digitally signed with a publisher certificate issued by Karo BIM Solutions.

• Automated setup: The installer deploys add-in files to ProgramData and registers KaroBimSolutionsPublic.cer into Trusted Root Certification Authorities and Trusted Publishers.
• IT-managed environments: If Group Policy restricts automated trust registration, administrators can deploy KaroBimSolutionsPublic.cer via Group Policy.
• Data privacy: All governance policies, local cache, and central event logs reside strictly on your local computer or designated on-premise network share.

License & seat management

• Activation in Revit: To check status, activate a license key, or manage seats, press Shift and click the ModelGuard ribbon button.
• Workstation reassignment: Team seats can be unassigned and reassigned to different workstations or team members at any time.
• Subscription preservation: Reassigning or transferring seats does not reduce, reset, or forfeit active subscription days.

Updating

Run the new .msi installer over the previous version. Local connection and cache are preserved — users do not need to run Initial Configuration again.

Uninstalling

Use Windows Settings → Apps → Installed apps (or Control Panel → Programs and Features), select Karo.ModelGuard, and click Uninstall. Alternatively, right-click the .msi file and select Uninstall, or run msiexec /x "Karo.ModelGuard-Setup.msi" /qn. Network configuration and log files on the share are not deleted.

Compatibility notes

• One installer covers all supported Revit versions; only versions detected on your PC (or manually selected) are installed.
• Revit must be restarted after installation and after first Create/Connect for the connection to load.
• Daily administration is done inside Revit; Initial Configuration is only for creating a new shared config or connecting to an existing one.
• The plugin supports both English and Russian Revit installations.

Tips for best results

• Create once, connect many times. The BIM manager creates the shared folder once; everyone else only connects to that folder.
• Use Justify before StrictBlock. Start with Justify to collect reasons and build team habits, then switch critical rules to StrictBlock.
• Review the Log regularly. The central CSV log shows who triggered a policy, when, and what justification they entered.
• Watch Terminal for rollout. Confirm plugin versions and connection health across the team without changing settings.
• Offline is expected. If the network share is briefly unavailable, the add-in can continue from a local cache. Restore the share so the cache can refresh.
• Language: Toggle EN / RU in the hub; preference follows the product language settings. Initial Configuration stays English.

Known limitations

• File-based configuration — centralized governance via network share without external cloud database dependencies.
• Initial Configuration is not an admin console — change policy modes, administrators, and connection path from inside Revit after the first setup.
• Safe mode — if there is no usable config and no local cache, the add-in enters a safe mode that does not crash Revit; policies may not enforce until configuration is available again.
• Optimistic save conflicts — if two administrators save overlapping changes, the later save may need a reload and retry (no automatic merge).
• IT folder permissions — users need read access to the config folder and write access to the runtime/log folder on the share.

What this tool is designed for

Karo.ModelGuard is built for day-to-day BIM governance: stopping expensive model-quality mistakes as they happen, with a shared audit trail. It is not a full document management system or a post-project model audit suite.

Support

For questions or installation help, contact us at support@karomodum.com.