FLY BIM Catalyst Technical Manual
Reverse-engineered technical documentation, parameter schemas, and operating protocols for Project Preparation, Assemblies Engineering, and Legend Factory in Autodesk Revit.
Project Preparation & Model Sanitation
Project Preparation.panel • Environment Bootstrapping & Model Disinfection
The First Line of Defense: Sanitizing Inherited BIM Models
In architectural production, projects rarely start in a sterile vacuum. Teams inherit models loaded with legacy CAD layers, non-standard materials from vendor families, and missing code parameter bindings. Running calculations or automated legends on an uncalibrated project leads to false code calculations and corrupt schedules. Project Preparation is the mandatory pre-flight engine that establishes data schemas, purges duplicate materials, and standardizes 2D detail families.
Environment Setup
Binds 11 core shared parameters and loads standard 2D detail drafting families in one transaction.
Material Cleanup
Audits all active materials, swaps compound layers with certified standards, and archives dirty duplicates.
Detail Family Rename
Cleans CAD prefix junk, standardizes Title Casing with acronym protection, and prepends CB_2D_.
1. Environment Setup
Parameter Schema Injection & Standard 2D Detail Family Autoloader
Before running any Catalyst automation, the host Revit project requires specific parameters for building code tracking and legend generation. Environment Setup reads the centralized CB_Shared_Parameters.txt file and automates the API binding across 5 structural and architectural categories with zero manual effort.
11 Core Shared Parameters Binding Schema
| Parameter Name | Bound Categories | Role & Functional Purpose |
|---|---|---|
| CB_Function | Walls, Floors, Roofs, Ceilings, Soffits | Core architectural classification enum (e.g. EXTERIOR_WALL) |
| CB_Show_In_Legend | Walls, Floors, Roofs, Ceilings, Soffits | Boolean toggle (1 = Render on Legend, 0 = Exclude) |
| CB_FRR_Proposed / Ref | Walls, Floors, Roofs | BCBC fire rating outcome and ULC/CAM reference code |
| CB_STC_Rating / Ref | Walls, Floors | Acoustic rating score and empirical laboratory test ID |
| CB_Effective_R_Value | Walls, Floors, Roofs, Soffits | Thermal envelope compliance tracking and energy code citation |
| CB_Is_Load_Bearing / Shear | Walls | Structural role flags governing fire test criteria requirements |
Environment Setup temporarily switches the Revit shared parameters file path to CB_Shared_Parameters.txt, executes the atomic category bindings, loads the required 2D detail components, and immediately restores your original firm shared parameter path. Your Revit user preferences remain untouched.
2. Material Cleanup (Material Alchemist)
Automated Project Material Disinfection & Compound Structure Deep-Clean Engine
Eliminating Dirty Materials from Foreign and Vendor Families
When linking structural or MEP models, or importing vendor equipment families, Revit inevitably absorbs duplicate, non-standard materials (e.g. Gypsum Wall Board 1, Generic 150mm, Default Wall). If left unaddressed, these dirty materials cause the Performance Calculator to miss acoustic/fire additive rules and prevent Legend Factory from finding corresponding 2D detail components in CB_Material_Mapping_Enriched.csv.
The 4 Operational Verbs of Material Alchemist
The material strictly matches certified entries in CB_Standard_Materials.csv. No alteration required.
Updates the material name and description in-place to conform to MasterFormat naming standards without modifying compound layer IDs.
Penetrates every compound structure (Walls, Floors, Roofs, Ceilings) in the active model, swaps all occurrences of the dirty material with the standard material ID, then archives the orphan.
Registers a new certified material into the project and standard database with architectural description attributes pre-configured.
Translation Memory (CB_Translation_Memory.json)
Caches previous material cleansing decisions. Once a messy material from a specific structural consultant is mapped to a standard material, future project imports are mapped automatically with zero cognitive overhead.
WPF Interactive Grid & CSV Workflow
Operators can review mappings inside a responsive WPF table with live search filters, or export active project materials to CSV for offline spreadsheet review and re-import with atomic commit.
3. Detail Family Standardizer
4-Stage Regular Expression Engine & Architectural Acronym Protection
Aligning 2D Drafting Components with the Catalyst Ecosystem
Detail component libraries often suffer from decades of AutoCAD imports and inconsistent naming (e.g. Detail_Items_M_concrete_cmu-Section). Because Legend Factory procedurally fetches detail families based on standardized mapping keys, inconsistent naming causes 2D cells to fail. Detail Family Standardizer sanitizes all Detail Items (OST_DetailComponents) through a 4-stage heuristic engine.
The 4 Sanitation Heuristic Stages (smart_clean)
Strips legacy CAD export prefixes such as Detail_Items_ and Detail_Item_.
Eliminates redundant -Section or -section suffixes using case-insensitive regex parsing.
Converts words to clean Title Case while enforcing an architectural acronym protection whitelist: GWB, CMU, ACM, AISC, HSS, OWSJ, OWWJ, CB, 2D remain strictly capitalized.
Translates metric M_ into canonical CB_2D_, replaces spaces with single underscores, and collapses multiple consecutive delimiters.
Once detail families are standardized (e.g. CB_2D_Linear_C-Stud(Plan)), they immediately align with the mapping database used by Legend Factory, ensuring 100% automated graphical generation on construction sheets.
Overview & Working Paradigm
In professional architectural practice, compound assemblies (Walls, Floors, Roofs, Ceilings) are the single largest source of documentation discrepancy. A change in partition thickness or stud cavity depth typically demands manually updating dozens of types, recalculating fire ratings, rewriting specifications, and revising schedule tags. The Catalyst Assemblies Suite automates this pipeline through a strictly sequenced, deterministic data model.
Taxonomy-Driven Metadata
Every downstream automation—from acoustic calculations to elevation legend generation—is anchored directly to the CB_Function metadata stamped onto the assembly.
Atomic Revit Transactions
Modifications run inside atomic transaction scopes with automatic rollback on Revit warning cascades, protecting hosted doors, windows, sweeps, and wall joins.
Classify all assemblies into architectural building code categories (CB_Function).
Dissect layers, evaluate against BCBC STC/FRR tables, and stamp verified code ratings into types.
Generate standardized Type Names and CSI MasterFormat Type Marks (EW3-1, IW5-1, F3-1).
Perform global material replacements, stud cavity resizing, or value-engineering thickness adjustments.
1. Function Assignment Center
Metadata Foundation • BIM Taxonomy & Legend Filter
The Core Foundation of the Entire Catalyst Ecosystem
Native Revit only offers binary functions like "Interior" or "Exterior", which fails in multifamily and commercial architecture where code requirements diverge between Party Walls, Corridor separations, and Shaft enclosures. Function Assignment Center is the single most critical step in Catalyst: it establishes the architectural taxonomy (CB_Function).All downstream operations—including acoustic evaluations, fire resistance scoring, Type Mark nomenclature, and automated legend generation—strictly depend on valid function assignments.
Standard CB_Function Taxonomy Matrix
| Assembly | Standard Function Enum | Code Intent (BCBC / NBCC) |
|---|---|---|
| Wall | EXTERIOR_WALL | Building envelope, vapor retarder & thermal continuity |
| Wall | INTERIOR_WALL-PARTY | Suite-to-Suite acoustic separation (STC ≥ 50, 1h FRR) |
| Wall | INTERIOR_WALL-CORRIDOR | Suite-to-Public corridor smoke barrier (STC 50, 45m FRR) |
| Wall | INTERIOR_WALL-SHAFTCORE | Shaftliner, 2h fire enclosure, CH-stud core |
| Floor | TYPICAL_FLOOR / SUITE | Vertical acoustic separation, subfloor & topping verification |
Any assembly left as UNASSIGNED will be automatically bypassed by the Performance Calculator to avoid incorrect code certifications, and will be omitted from automated Legend Factory generation.
2. Performance Calculator (FRR & STC Dual Engine)
BCBC / NBCC Compliance • Empirical Acoustic & Fire Rating Engine
Automating Building Code Verification
Fire-Resistance Ratings (FRR) and Sound Transmission Class (STC) ratings are typically disconnected annotations. When layers change, annotations become obsolete and trigger permit rejections. Performance Calculator dissects compound layers like a code engineer, runs empirical database matching, and stamps verified ratings with diagnostic reasoning directly into Revit parameters.
Three-Stage Performance Engine Architecture
Prior to deep scans, intercepts structural impossibilities. Light-frame walls or floors with zero gypsum layers instantly return N/A [Fast-Fail | Bare Framing].
Scans ULC_FRR_Database.json for certified test designs. For non-standard builds, falls back to BCBC Appendix D Component Additive Method (CAM).
Solid concrete core (≥250mm = STC 60, ≥200mm = STC 57). Any gypsum board directly mounted to concrete earns a certified +8 bonus. Negative stud spacing indexing ensures 400mm framing is not downgraded by 600mm rules.
Revit Type Parameters Stamped by Performance Calculator
CB_FRRCB_STCCB_FRR_LogCB_STC_Log3. Assembly Rename & MasterFormat Nomenclature
Standardized Type Mark & Physical Layer Protocol
Deterministic Naming Based on Physical Compound Layers
Revit project schedules frequently drift when designers modify physical materials or thicknesses inside an assembly without renaming the type. Assembly Rename inspects structural layers, generates a standardized Type Name, detects duplicate collisions, and writes an industry-compliant Type Mark.
Type Mark Structure & CSI MasterFormat® Logic (e.g. EW3-1, IW5-2, F3-1, R6-1)
CSI MasterFormat-1, -2) is sequenced strictly by CB_Function importance hierarchy (fire/shear cores before party walls before partition furrings).ISO 19650-2 & NBIMS Compliance
Conforms to ISO 19650-2 principles: deterministic field segmentation, functional role identification, and UniFormat / OmniClass Table 21 cross-compatibility.
CSV Rules Synchronization
Firms with proprietary naming standards can easily synchronize custom prefixes, abbreviations, and rules via CB_Standard_Material.csv.
4. Assembly Material Configuration
Global Physical Layer Modification & Recalibration
Single-Pane Compound Structure Management
When working on multi-unit residential models, modifying insulation thickness or stud cavity dimensions across 40 different wall types traditionally requires drilling through nested type properties 40 times. Assembly Material Configurator aggregates all active Compound Structures in the project by Material and Layer occurrence into a single WPF controller with atomic Revit transaction safeguards.
⚙️ Smart Length Parsing Engine (parse_smart_length)
Features regex unit normalization converting contractor and architect notations into Revit internal decimal feet:
Operator Protocol
5/8").Apply Changes to commit via a single Revit Transaction.Legend Factory & Sheet Creator
Legend&Sheet Creator.panel • Procedural 2D Assembly Legends & Sheet Placement
Procedural Assembly Drafting Synchronized with 3D BIM Data
In standard practice, assembly legends (Wall, Floor, Roof schedules) are manually drafted using disconnected 2D lines and text tags. Whenever a specification, gypsum type, or cavity insulation changes, drafting legends fall out of sync, causing costly site conflicts and permit delays. Legend Factory eliminates this gap by procedurally extracting compound layers directly from active Revit elements, converting them into true-to-scale 2D detail components, stamping verified code performance ratings, and laying them onto sheets automatically.
To guarantee 100% documentation integrity and prevent unmapped visual discrepancies, three preceding steps must be completed:
All assembly layers must use standard materials conforming to CB_Standard_Materials.csv. If foreign or legacy materials exist, run Material Cleanup in Project Preparation first to batch-normalize them.
Run Performance Calculator on all assemblies. The verified Fire Resistance Rating (CB_FRR) and Sound Transmission Class (CB_STC) stamp directly into the cell header on the sheet.
Run Assembly Rename to assign standardized Type Names and MasterFormat Type Marks (EW3-1, IW5-1). This controls the natural ascending sort order on sheets.
2D Detail Graphics Generation & Custom Material Extension
How does Legend Factory produce authentic architectural drawings instead of generic flat boxes?
Every standard material is mapped to a dedicated Revit 2D Detail Component Family (e.g. CB_2D_Linear_C-Stud(Plan), CB_2D_Bricks_Top, CB_2D_Linear_Cast_in_Situ_Conc, resilient channels, and batt insulation). The engine dynamically instantiates, dimensions, and aligns these families to the exact layer thickness.
If your project specifies non-standard or proprietary materials (e.g. specialized acoustic isolators, terracotta rainscreens, mass timber CLT systems) not yet in the standard library, contact Fei Feng (fei@flybim.ca) directly for rapid custom 2D family profiling and mapping integration.
Material Typography: Description Property over Raw Name
In the generated legend cell stack, the text describing each layer is pulled from the Revit Material's Description parameter (ALL_MODEL_DESCRIPTION), NOT the raw Revit Material Name.
Raw material names often contain internal BIM prefixes or sorting codes (e.g. 09 - FINISH - GWB 5/8" Type X). Using Description outputs clean, specification-grade contract text (e.g. 16mm (5/8") TYPE X GYPSUM BOARD).
- Nominal Lumber: Auto-converts to wood industry standards (
2x4,2x6,2x8,2x10,2x12). - Staggered Studs: Suppresses individual thickness to depict staggered cavity geometry.
- Variable Slopes: Flags concrete topping with variable thickness markers.
Unified Print Factory: Sheet Layout & Pagination Engine
The layout engine (UnifiedPrintFactoryEngine) packs drafting views and sheets according to paper space limits:
Select your titleblock family and specify starting numbers (e.g. A 0.21 for Horizontal, A 0.31 for Vertical). The engine creates new sheets sequentially and centers viewports at the configured top-left paper offsets.
Select pre-created project sheets from the checklist. The engine places generated legends onto checked sheets in strictly ascending Sheet Number order, preserving your existing sheet set structure.
FlyBIM Help Center Integration
Revit Ribbon Launch Mechanism
Inside Autodesk Revit, navigating to the Catalyst tab and clicking the Help Center pushbutton triggers the native PyRevit browser dispatcher, immediately opening the documentation portal on flybim.ca/docs in your default browser.
Embedded directly into Catalyst.tab/FlyBIM.panel/Help Center.pushbutton/Script.py, enabling instant, context-aware architectural reference without exiting Revit.
Need Custom Rule Presets for Your Architectural Firm?
FLY BIM Technologies provides enterprise onboarding, custom nomenclature dictionaries, and city-specific building code calibrations (BCBC, AB, OBC, NBCC).