Revit Extractor¶

Export all your Revit model data to a database or Excel file for analysis, reporting, and sharing.

What It Does¶

Revit Extractor pulls out all the information from your Revit model and saves it to either a database file or Excel workbook. This makes it easy to analyze your data, create reports, share information with team members who don't have Revit, or use the data in other programs.

Key Benefits¶

• Get All Your Data Out: Extract elements, parameters, families, views, sheets, and more
• Two Format Options: Save to database (for analysis) or Excel (for easy viewing)
• Include Linked Models: Optionally extract data from linked files too
• Easy to Use: Just pick your options and click Run
• Share Widely: Give data to team members who don't use Revit

What Gets Extracted¶

When you run Revit Extractor, it can pull out:

Model Information¶

• Project name and details
• Model properties
• Units and settings

Building Elements¶

• All elements (walls, doors, windows, etc.)
• Element properties
• Where elements are located
• Which worksets they're on

Organization¶

• Levels and their heights
• Rooms and spaces with areas
• Views and sheets
• Categories and families
• Worksets

Materials and Details¶

• All materials used
• Material properties
• Family types
• Parameters (both shared and project)

Links and References¶

• Linked Revit files
• CAD links
• External references

How to Use¶

Step 1: Choose Your Export Format¶

SQLite Database (.db file) - Best for: Analysis and querying data - Good for: Large amounts of data - Use when: You want to run queries or connect to analytics tools

Excel Workbook (.xlsx file) - Best for: Quick reviews and sharing - Good for: People familiar with Excel - Use when: You want to browse data or make simple reports

Step 2: Pick Output Location¶

1. Click the Browse button
2. Choose where to save the file
3. Name is auto-created from your model name
4. Pick a location you'll remember

Step 3: Choose Options¶

Include Linked Models - Check this to include data from linked Revit files - Unchecked = only extract from current model - Note: Including links makes it take longer

Reset Schema (SQLite only) - Checked = start fresh, delete old data - Unchecked = add to existing database - Usually keep this checked

Step 4: Run the Extraction¶

1. Click the Run or Export button
2. Wait while it extracts (may take several minutes for large models)
3. You'll see a confirmation when done
4. Your file is saved to the location you picked

Step 5: Open Your Data¶

For SQLite: - Use SQLite browser software (free to download) - Or connect to analytics tools like Power BI - Run queries to find what you need

For Excel: - Open the .xlsx file in Excel - Each data type is on a separate sheet - Use Excel's filter and sort features - Create pivot tables and charts

What's in Each Sheet/Table¶

When you open your export, you'll find these sections:

Projects - Project information and settings

Models - Document details and file info

Levels - All levels and their elevations

Rooms - Room names, numbers, areas, volumes

Views - All views and their settings

Sheets - All sheets and what's on them

Materials - Materials used in the model

Categories - Revit categories and organization

Families - All family types and how many instances

Elements - Individual elements with all their properties

Parameters - All parameter definitions

And more... depending on your model content

Tips for Success¶

Before You Extract¶

• Save your model first
• Close unnecessary views
• Make sure you have disk space
• Decide if you need linked models

Choosing Format¶

• Use Excel for quick sharing and browsing
• Use SQLite for serious analysis and large data sets
• Excel is easier to read
• SQLite is better for querying

Managing Extracts¶

• Name files with dates (e.g., ModelName_2026-04-19.xlsx)
• Keep extracts organized in one folder
• Delete old extracts you don't need
• Note what you extracted and why

Working with Data¶

• In Excel: Use filters to find what you need
• In Excel: Create pivot tables for summaries
• In SQLite: Learn basic SQL queries for power
• Share read-only versions with others

Common Uses¶

Create Reports¶

Pull data for project reports: - Room schedules with areas - Door and window counts - Material quantities - Equipment lists

Cost Estimation¶

Get quantities for pricing: - Export element counts - Get material quantities - Extract custom cost parameters - Share with estimators

Data Analysis¶

Analyze your model: - Check parameter consistency - Find missing information - Track element counts over time - Compare versions

Facility Management¶

Prepare data for operations: - Equipment information - Room and space data - Asset tracking information - Maintenance requirements

Share with Others¶

Give data to team members: - Excel files anyone can open - Non-Revit users can review - Consultants can analyze - Clients can see details

Common Questions¶

How big will my export file be? Depends on model size. Small models = a few MB. Large models can be 100+ MB.

How long does it take? Small models: under a minute. Large models with links: 5-15 minutes.

Can I choose what to extract? Not in the basic version - it extracts everything. Use filters in Excel/database after extraction.

Can I extract from family files? No, this tool works with project files only.

What if extraction fails? - Check you have write permission to the folder - Make sure you have enough disk space - Close the file if it's already open - Try a different save location

Can I open database files without special software? For SQLite, you'll need a SQLite viewer (free). For Excel, you just need Excel.

Does it change my model? No, it only reads data. Your model is not modified.

Use With Other Tools¶

• Schedule Excel: For focused schedule exports with edit capability
• Model Health Check: Extract and analyze health metrics
• NeroSpec: Validate extracted parameter data

Where to Find It¶

1. Open Revit
2. Look for the NeroScale ribbon
3. Click "Revit Extractor"
4. Choose your settings and run

RevitExtractor¶

Extract comprehensive, structured data from Revit models to SQLite or Excel for analysis, reporting, and integration with external systems.

Overview¶

RevitExtractor provides powerful data extraction capabilities for Revit models, exporting detailed model information to SQLite databases or Excel workbooks. Extract elements, parameters, families, materials, views, sheets, and more with customizable options for scope and detail level.

Key Features¶

• Dual Export Modes: SQLite database or Excel workbook
• Comprehensive Data: Elements, parameters, families, materials, views, sheets, and more
• Include Linked Models: Optionally extract data from linked Revit files
• Customizable Schema: Configure which data types to extract
• Incremental Updates: Reset schema or append to existing data
• Relationship Preservation: Maintain model structure and relationships
• Parameter Extraction: Capture all instance and type parameters
• Built-in Categories: Extract standard Revit category data

Export Modes¶

SQLite Database¶

Format - Single .db file containing all extracted data - Relational database structure - Normalized tables with foreign keys - Efficient storage and querying

Advantages - Powerful query capabilities with SQL - Efficient for large datasets - Integration with analytics tools - Supports complex relationships - Lightweight and portable

Use Cases - Data analysis and reporting - Integration with business intelligence tools - Custom application development - Long-term data archival - Cross-project data comparison

Excel Workbook¶

Format - Single .xlsx file with multiple worksheets - One worksheet per data type - Tabular layout with headers - Formatted for readability

Advantages - Familiar interface for most users - Easy sharing and collaboration - Built-in analysis tools (pivot tables, charts) - No special software required - Quick visual inspection

Use Cases - Executive reports and summaries - Team reviews and analysis - Quick data exploration - Client deliverables - Documentation packages

Data Types Extracted¶

Project Information¶

• Project name and number
• Author and organization
• Project address
• Issue date and status
• Building and site data

Models/Documents¶

• Document title and path
• Central model information
• Worksharing status
• Revit version
• Last save information

Units¶

• Length units
• Area units
• Volume units
• Angle units
• Custom unit definitions

Linked Files¶

• Linked Revit models
• Linked CAD files
• Link instances and paths
• Link transformation data
• Link status

Worksets¶

• Workset names and IDs
• Workset owners
• Element counts per workset
• Workset visibility
• Editable status

Levels¶

• Level names and elevations
• Computation height
• Building story
• Level type (Story/Others)

Spaces¶

• Space names and numbers
• Space areas and volumes
• Space level assignments
• Occupancy data
• Space boundaries

Rooms¶

• Room names and numbers
• Room areas and volumes
• Room level assignments
• Department assignments
• Finish information

Views¶

• View names and types
• View templates
• View scales
• Discipline settings
• View-specific parameters

Sheets¶

• Sheet numbers and names
• Sheet sizes
• Issue dates
• Revisions
• Placed views

Materials¶

• Material names and IDs
• Appearance assets
• Physical properties
• Thermal properties
• Structural properties

Categories¶

• Built-in categories
• Custom categories
• Category discipline
• Line weights
• Material assignments

Families¶

• Family names and types
• Family categories
• Type parameters
• Nested families
• External references

Elements¶

• Element IDs and categories
• Instance parameters
• Type parameters
• Geometry properties
• Location information
• Workset assignments

Parameters¶

• Shared parameters
• Project parameters
• Family parameters
• Parameter groups
• Parameter types and values

Workflow¶

1. Launch Tool¶

Open RevitExtractor from NeroScale ribbon: - Validates active document - Displays extraction configuration window

2. Select Export Mode¶

Choose output format: - SQLite: For database-based analysis - Excel: For spreadsheet-based review

3. Choose Output Location¶

Set export destination: - Click Browse button - Select folder location - Filename auto-generated from document name - File extension updates based on mode

4. Configure Options¶

Include Linked Models - Check to extract linked Revit file data - Processes all loaded linked models - Maintains link relationships - Increases extraction time

Schema Options (SQLite only) - Reset Schema: Delete existing database and create fresh - Append Data: Add to existing database (if schema compatible)

Extraction Scope (Advanced) - Select specific data types to extract - Customize parameter extraction - Filter categories - Set element ranges

5. Execute Extraction¶

Run the extraction: 1. Click Run/Export button 2. Monitor progress (if available) 3. Wait for completion confirmation 4. Review any warnings or errors 5. Open exported file

Database Schema (SQLite)¶

Core Tables¶

Projects - Project metadata and settings - Organization information - Issue data

Models - Document information - File paths and names - Worksharing details

Units - Unit type definitions - Display formats - Conversion factors

LinkedFiles - Linked model information - Link paths and types - Transform data

Worksets - Workset definitions - Ownership data - Element assignments

Levels - Level elevations - Level properties - Story designation

Spaces - Space geometry and properties - Boundary definitions - Occupancy data

Rooms - Room geometry and properties - Department assignments - Finish data

Views - View definitions - Template assignments - Display settings

Sheets - Sheet layouts - Placed views - Revision data

Materials - Material definitions - Asset assignments - Physical properties

Categories - Category definitions - Line styles - Material assignments

Families - Family and type definitions - Parameter schemas - Nested relationships

FamilyInstances - Element instances - Location data - Parameter values

Parameters - Parameter definitions - Shared parameter GUIDs - Parameter groups

Relationships¶

• Foreign keys maintain referential integrity
• Element-to-family relationships preserved
• Parameter-to-element mappings
• View-to-sheet placements
• Workset-to-element assignments

Excel Structure¶

Worksheet Organization¶

Each data type exported to separate worksheet: - Projects - Models - Linked Files - Worksets - Levels - Rooms - Spaces - Views - Sheets - Materials - Categories - Families - Elements - Parameters

Data Layout¶

• First row: Column headers
• Subsequent rows: Data records
• Formatted as Excel Table for filtering
• Auto-fitted columns
• Freeze panes on header row

Best Practices¶

Planning Extractions¶

Define Purpose - Identify what data you need - Determine appropriate format - Plan for linked models if needed - Consider extract frequency

Storage Management - Organize extracts by project and date - Use consistent naming conventions - Archive old extracts periodically - Manage disk space for large models

Performance Optimization¶

Selective Extraction - Extract only needed data types - Exclude linked models if not required - Use filters to limit scope - Close unnecessary applications

Timing - Run during off-hours for large models - Avoid peak network times if model is central - Allow sufficient time for complex models - Monitor system resources

Data Management¶

Version Control - Include date/time in filenames - Track model version extracted - Document extraction scope - Maintain extraction log

Quality Assurance - Spot-check extracted data - Verify critical parameters present - Validate relationships - Test queries before relying on data

Security and Privacy¶

Sensitive Data - Review what parameters are extracted - Filter confidential information - Control access to extract files - Follow organization data policies

Sharing - Sanitize data before external sharing - Remove proprietary information - Check for embedded file paths - Verify recipient permissions

Common Use Cases¶

BIM Analytics¶

Extract data for analysis: - Element counts and distributions - Parameter population rates - Quality assurance metrics - Model complexity measures

Cost Estimation¶

Pull quantity data: - Material quantities - Element counts by type - Room areas and volumes - Custom parameter values

Facility Management¶

Prepare COBie data: - Space data - Equipment information - Type and model numbers - Warranty information

Coordination Reports¶

Generate coordination data: - Clash detection preparation - Element property verification - Cross-discipline comparison - Change tracking

Custom Applications¶

Feed external systems: - Dashboard applications - Custom reporting tools - Analysis platforms - Integration workflows

Advanced Features¶

SQL Queries (SQLite)¶

Query extracted data efficiently:

-- Count elements by category
SELECT Category, COUNT(*) as Count
FROM Elements
GROUP BY Category
ORDER BY Count DESC;

-- Find rooms missing area
SELECT Name, Number
FROM Rooms
WHERE Area IS NULL OR Area = 0;

-- List families and instance counts
SELECT FamilyName, COUNT(*) as InstanceCount
FROM FamilyInstances
GROUP BY FamilyName;

Excel Analysis¶

Use Excel features: - Pivot tables for summaries - Charts for visualization - Conditional formatting - Power Query for transformation

Data Integration¶

Connect to other tools: - Power BI for dashboards - Tableau for analytics - Custom applications via ODBC - Web applications via API

Integration¶

Works With¶

• ScheduleExcel — Export specific schedule data to Excel
• ModelHealthWarning — Extract health metrics
• NeroSpec — Validate extracted parameter data

Troubleshooting¶

Export Fails¶

Check Permissions - Verify write access to output folder - Ensure folder exists - Check disk space availability - Close file if already open

File Locked - Close Excel if exporting to Excel - Close database connections - Check file isn't in use - Verify no file locks

Missing Data¶

Linked Models - Ensure linked models are loaded - Check "Include Linked" option - Verify link paths are valid - Reload links if needed

Parameters Missing - Verify parameters exist in model - Check parameter visibility - Ensure elements have parameters - Review parameter filters

Performance Issues¶

Large Models - Extract specific data types only - Disable linked model extraction - Close other applications - Use SQLite for better performance

Memory Issues - Increase available RAM - Process in smaller batches - Close unnecessary Revit views - Restart Revit before extraction

Tips and Tricks¶

• Test First: Extract from small model to verify settings
• Incremental: For recurring extracts, use append mode (SQLite)
• Document: Keep log of extractions (date, scope, purpose)
• Automate: Script regular extractions via Revit API
• Backup: Keep copy of model version used for extraction
• Validate: Spot-check extracted data for accuracy
• Format Choice: Use SQLite for analysis, Excel for reporting

Requirements¶

Prerequisites¶

• Autodesk Revit (compatible versions: 2024, 2025, 2026)
• NeroScale add-in installed and loaded
• Project document open

System Requirements¶

• Sufficient disk space for output file
• Write permissions to output directory
• For Excel: Microsoft Excel 2016+ (to open files)
• For SQLite: SQLite viewer or compatible database tool

Linked Models¶

• Linked models must be loaded in current session
• Links must be resolvable paths
• Appropriate permissions on linked files

Configuration¶

Extraction Options¶

Advanced users can configure: - Custom SQL schema definitions - Parameter extraction filters - Element range limits - Category inclusion/exclusion

Export Settings¶

Customize defaults: - Preferred export mode - Default output location - Schema reset behavior - Linked model handling

Learn More¶

• SQL query fundamentals
• Revit parameter types and storage
• Excel data analysis techniques
• Database design principles
• COBie data standards
• BIM analytics methods

FAQ¶

Can I customize fields? Yes, advanced configuration allows selecting specific data types and parameters.

How large can extracts get? Depends on model size. Large models can produce gigabytes of data, especially with linked models.

Can I schedule automatic extractions? Not built-in, but can be scripted using Revit API for automated workflows.

Does it work with older Revit versions? Supports Revit 2024+. Earlier versions may have limited compatibility.

Can I extract from families? RevitExtractor works with project documents, not family editors.

Is extracted data real-time? No, it's a snapshot at extraction time. Re-extract to get updated data.

Can I merge extracts from multiple models? SQLite databases can be merged with SQL. Excel requires manual consolidation or Power Query.

What if extraction fails partway? Partial data may be saved. Use Reset Schema and retry. Check error messages for guidance.