Model Health Check¶

Check your Revit model for problems and get a detailed report you can share with your team.

What It Does¶

Model Health Check scans your Revit model and creates a report showing any warnings, views, families, and other information. Think of it like a health checkup for your model - it finds issues so you can fix them before they cause bigger problems.

Key Benefits¶

• Find Problems Early: Catch issues before they impact your project
• Get Detailed Reports: Export findings to Excel, JSON, or CSV formats
• Share Results: Easy-to-read reports you can send to team members
• Choose What to Check: Pick exactly what information you need
• Track Over Time: Compare reports to see if things are getting better

How to Use¶

Step 1: Open the Tool¶

1. Open your Revit project
2. Click on Model Health Check in the NeroScale ribbon
3. The scanning window will open

Step 2: Choose What to Check¶

Select what you want to include in your report:

Warnings - All Revit warnings in your model - Error and warning messages - Which elements have problems - Suggestions for fixing them

Views and Sheets - List of all views and sheets - View names and types - Sheet numbers - What's on each sheet

Families - All families in your model - Family names and types - How many of each type - Where they're used

SubCategories - Organization structure - Category setup - Line styles and patterns - How things are organized

Or click "Select All" to include everything

Step 3: Pick Your Report Format¶

Choose how you want the report:

Excel - Best for most people - Easy to read and sort - Open in Microsoft Excel - Share with anyone

JSON - For technical users - Use with other software - Process with scripts

CSV - Simple text format - Open in any spreadsheet program - Easy to email

Step 4: Choose Where to Save¶

1. Click the browse (...) button
2. Pick a folder to save your report
3. The filename is created automatically from your model name

Step 5: Run the Check¶

1. Click "Export" to start
2. Wait while it scans (this may take a minute)
3. Your report will be saved to the location you chose

What You Get¶

Warnings Report¶

Shows all problems found: - What the warning says - Which elements are affected - How serious it is - Ideas for fixing it

Views and Sheets Report¶

Lists all your views and sheets: - View names and numbers - Sheet layouts - What's visible in each view

Families Report¶

Shows all families used: - Family and type names - How many instances - Parameter information

SubCategories Report¶

Documents your organization: - Category names - How they're nested - Visual settings

Tips for Success¶

Before You Run¶

• Save your model first
• Close extra views you don't need
• Make sure you have enough disk space

Running Regular Checks¶

• Check weekly on active projects
• Check before sending to others
• Check after making big changes
• Keep old reports to compare

Reading Reports¶

• Start with warnings - those are most important
• Look for patterns (same issue repeated)
• Share reports in team meetings
• Track which warnings get fixed

Fixing Issues¶

• Fix errors first, then warnings
• Some warnings are okay to ignore
• Document why you're not fixing certain items
• Test after fixing to make sure it worked

Common Uses¶

Project Reviews¶

Before milestones or deliveries: - Run a full health check - Review all warnings - Share report with team lead - Fix critical issues before submitting

Quality Control¶

Regular model maintenance: - Weekly health checks - Track warning trends - Measure model quality over time - Catch problems early

Handoff to Others¶

Prepare models for others: - Check for errors before sharing - Document any known issues - Provide clean data - Show model is ready

Common Questions¶

Do I have to check everything? No, just check what you need. For a quick check, just select Warnings.

How long does it take? Depends on model size. Small models: seconds. Large models: a few minutes.

Can I check linked models? Not automatically. Open each linked model separately to check it.

What if I get errors running the tool? - Make sure you have write permission to the save folder - Try a different folder - Close Excel if you're exporting to Excel - Make sure your model file isn't corrupted

Should I fix all warnings? Not necessarily. Some warnings don't matter. Focus on errors first, then important warnings.

Can I schedule automatic checks? Not built-in, but you can set reminders to run it regularly.

Use With Other Tools¶

• NeroSpec: After checking health, validate your data meets requirements
• RevitExtractor: Get even more detailed data from your model
• CascadingJoin: Fix join-related warnings automatically

Where to Find It¶

1. Open Revit
2. Look for the NeroScale ribbon
3. Click on "Model Health Check"
4. The tool window will open

ModelHealthWarning¶

Scan Revit models to identify health issues, performance bottlenecks, and data quality problems with comprehensive reporting and export capabilities.

Overview¶

ModelHealthWarning provides automated model health assessment by scanning your Revit project for common issues that impact performance, reliability, and data quality. Generate detailed reports in multiple formats (JSON, Excel, CSV) to track, communicate, and resolve model health concerns.

Key Features¶

• Comprehensive Scanning: Extract warnings, views, families, and subcategories
• Multi-Format Export: Generate reports in JSON, Excel, or CSV
• Selective Extraction: Choose which data types to include in your report
• Automated Analysis: Detect common problems and performance issues
• Configurable Options: Customize extraction scope and output format
• Export Management: Save reports to custom locations with organized structure

Extraction Options¶

Warnings¶

Extract all Revit warnings from the model: - Error and warning messages - Affected element IDs - Warning severity levels - Issue descriptions - Resolution recommendations

Views and Sheets¶

Catalog views and sheets in the model: - View names and types - Sheet numbers and names - View templates applied - Visibility graphics - View-specific parameters

Families¶

List all families and types: - Family names and categories - Family types and instances - Family parameters - Nested families - External references

SubCategories¶

Document subcategory structure: - Subcategory names and parents - Line weights and patterns - Material assignments - Visibility settings

Workflow¶

1. Launch Tool¶

Access ModelHealthWarning from NeroScale ribbon: - Opens in any non-family document - Validates document is loaded - Displays extraction options interface

2. Configure Extraction¶

Select what to extract: - Warnings: Check to include model warnings - Views / Sheets: Check to include view/sheet catalog - Families: Check to include family inventory - SubCategories: Check to include subcategory definitions - Select All: Toggle to quickly select/deselect all options

3. Choose Export Format¶

Select output format: - JSON: Structured data for programmatic processing - Excel: Spreadsheet format with multiple worksheets - CSV: Lightweight tabular format

4. Set Output Path¶

Configure export destination: - Browse to select folder - Auto-generates filename based on model name - File extension updates based on selected format

5. Execute Export¶

Run the extraction: 1. Tool processes selected extraction options 2. Collects data from active document 3. Formats data according to chosen export type 4. Saves file to specified location 5. Reports completion status

Export Formats¶

JSON Format¶

Structure

{
  "model": {
    "name": "Project Name",
    "exportDate": "2024-04-19T10:30:00Z"
  },
  "warnings": [...],
  "views": [...],
  "families": [...],
  "subCategories": [...]
}

Advantages - Ideal for automation and scripting - Easy to parse and process - Supports complex nested data - Version control friendly

Use Cases - API integration - Custom reporting scripts - Data transformation workflows - Quality assurance automation

Excel Format¶

Structure - Separate worksheet for each data type - Tabular layout with headers - Formatted cells for readability - Filter-enabled columns

Advantages - Easy to review and analyze - Share with non-technical stakeholders - Built-in filtering and sorting - Familiar interface for most users

Use Cases - Team review meetings - Executive summaries - Quality control audits - Issue tracking

CSV Format¶

Structure - Comma-separated values - One file per data type - Plain text format - Header row included

Advantages - Universal compatibility - Lightweight and fast - Easy to import into other tools - Simple processing

Use Cases - Database imports - Third-party tool integration - Large-scale data processing - Long-term archival

Best Practices¶

Regular Scans¶

Establish Schedule - Run health checks before major milestones - Scan after significant model changes - Include in quality assurance workflows - Document baseline health metrics

Track Trends - Compare reports over time - Identify recurring issues - Monitor warning accumulation - Measure improvement efforts

Issue Resolution¶

Prioritization - Address errors before warnings - Fix high-impact issues first - Resolve issues affecting collaboration - Document resolution approaches

Prevention - Understand root causes - Update standards and templates - Train team on best practices - Implement preventive measures

Report Management¶

Organization - Use consistent naming conventions - Include date/time in filenames - Organize by project and phase - Maintain report archive

Distribution - Share relevant sections with stakeholders - Include summary and recommendations - Document action items - Track resolution progress

Common Issues Detected¶

Model Warnings¶

Overlapping Elements - Duplicate elements at same location - Walls/floors overlapping - Room separation issues

Missing Elements - Deleted instances referenced elsewhere - Missing families or types - Broken external links

Performance Issues - Large family sizes - Complex geometry - Excessive detail levels - Heavy nested families

Data Quality - Missing or invalid parameters - Inconsistent naming - Incomplete information - Invalid values

View-Related Issues¶

Excessive Views - Too many unused views - Duplicate views - Inefficient view templates

View Configuration - Overly complex filters - Unnecessary overrides - Performance-impacting settings

Family Issues¶

In-Place Families - Overuse of in-place families - Performance impact - Maintenance challenges

Family Parameters - Missing parameters - Inconsistent definitions - Parameter naming issues

Integration¶

Works With¶

• NeroSpec — Validate model against specifications
• RevitExtractor — Extract comprehensive model data
• CascadingJoin — Fix join-related warnings

Advanced Usage¶

Automated Reporting¶

Batch Processing - Script multiple model scans - Generate comparison reports - Automate issue tracking - Schedule regular health checks

CI/CD Integration - Include in build validation - Fail builds on critical issues - Track health metrics over time - Generate trend reports

Custom Analysis¶

Data Processing - Parse JSON output for custom metrics - Create custom dashboards - Build issue tracking systems - Integrate with project management tools

Reporting Templates - Create standardized report formats - Include company branding - Add context and recommendations - Distribute automatically

Troubleshooting¶

Export Fails¶

Check Permissions - Verify write access to output folder - Ensure folder exists - Check disk space availability

File Locked - Close Excel if exporting to Excel - Verify file isn't open elsewhere - Check file permissions

Missing Data¶

Verify Selection - Ensure extraction options are checked - Check "Select All" hasn't deselected items - Confirm data exists in model

Document Issues - Verify document is fully loaded - Check for workset permissions - Ensure model isn't corrupted

Performance Issues¶

Large Models - Extract data types individually - Use CSV for faster processing - Close unnecessary applications - Increase available memory

Tips and Tricks¶

• Baseline First: Create a baseline health report for comparison
• Regular Cadence: Schedule weekly or monthly scans
• Team Review: Share reports in team meetings
• Action Items: Track issues in project management system
• Compare Formats: Export same data in multiple formats for different audiences
• Document Fixes: Note resolution approaches for future reference
• Preventive: Use health reports to identify training needs

Requirements¶

Prerequisites¶

• Autodesk Revit (2024+)
• NeroScale add-in installed and loaded
• Project document open (not family documents)
• Read permissions on active document

System Requirements¶

• Sufficient disk space for exports
• Write permissions to output directory
• For Excel: Microsoft Excel compatibility

Configuration¶

Extraction Thresholds¶

• Warning severity filters (configurable)
• Element count limits
• Performance impact thresholds

Output Settings¶

• Default export location
• File naming patterns
• Format preferences
• Auto-open after export

Learn More¶

• Revit performance optimization
• Model health best practices
• BIM quality assurance standards
• Warning resolution strategies
• Family optimization techniques

FAQ¶

How are issues prioritized? Based on severity, performance impact, and data quality concerns. Errors are highest priority, followed by warnings with significant impact.

Can I scan linked models? Currently scans active document only. Open linked models individually to scan them.

How often should I run health checks? Recommended weekly for active projects, before major milestones, and after significant changes.

What file size is reasonable? Export size varies by model complexity. JSON and CSV are typically smaller than Excel.

Can I automate scans? Yes, via Revit API scripting or integration with CI/CD pipelines.

Does it fix issues automatically? No, it identifies issues for manual review and resolution. Automated fixes could have unintended consequences.