Overview

BCFSleuth is a comprehensive web-based platform for analyzing Building Collaboration Format (BCF) files. Built specifically for AECO professionals, it provides universal BCF format support, advanced analytics, professional reporting, complete image management, and comprehensive viewpoint coordinate extraction - all running securely in your browser.

Quick Start

Key Features

How to Use BCFSleuth

Getting Started

Step 1: Access the Application

Navigate to https://thebimsider.github.io/bcfsleuth/V02/ in your web browser. No installation or registration required.

Step 2: Upload Your BCF Files

1. Drag and Drop: Simply drag your BCF file(s) from your file explorer onto the upload area
2. Click to Browse: Click the upload area to open a file browser and select your BCF files
3. Multiple Files: You can upload multiple BCF files simultaneously for batch processing

Supported formats: BCF 2.0, BCF 2.1, BCF 3.0

Step 3: File Processing

Once uploaded, BCFSleuth automatically:

• Detects the BCF version
• Extracts all topics, comments, and images
• Processes viewpoint coordinate data
• Analyzes the data structure
• Prepares interactive visualizations

Processing typically takes less than 2 seconds per file.

Working with Your Data

Basic Data Review (Simple Preview Tab)

1. Project Overview: View basic project information and statistics
2. Topic Summary: See total topics, comments, images, and viewpoints
3. Quick Export: Use the export button for immediate CSV or Excel download with coordinate options
4. File Information: Check BCF version and processing details

Detailed Analysis (Advanced Preview Tab)

1. Browse All Data: View complete topic information in a sortable table
2. Sort Columns: Click any column header to sort (click again to reverse)
3. Search Everything: Use the search box to find topics across all fields
4. Apply Filters: Use dropdown filters for Status, Priority, Assigned To, and Due Date
5. Expand Comments: Click blue ▶ arrows to read full comment threads
6. Adjust View: Change table pagination (25/50/100 rows per page)

Configuring Viewpoint Coordinate Data

Field Selection (Configuration Tab)

1. Viewpoint Coordinates Section: Find the dedicated "Viewpoint Coordinates (18 fields)" section
2. Section Control: Use the section checkbox to select/deselect all coordinate fields at once
3. Individual Fields: Expand the section to select specific coordinate fields:
   BCF Standard Coordinate Fields:

   • Camera Type (Perspective/Orthogonal)
   • Camera Position (X, Y, Z coordinates)
   • Camera Direction (X, Y, Z vectors)
   • Camera Up Vector (X, Y, Z vectors)
   • Field of View (for perspective cameras)
   • View to World Scale (for orthogonal cameras)

   Legacy Compatibility Fields:

   • Legacy Camera Position (X, Y, Z)
   • Legacy Camera Target (X, Y, Z)
4. Default Behavior: Coordinate fields are unchecked by default to avoid overwhelming new users with additional data columns
5. Template Integration: Save coordinate field selections in templates for consistent use

Understanding Viewpoint Data

• Primary Viewpoint: Each topic shows coordinates from its main viewpoint
• Multiple Viewpoints: Topics with additional viewpoints show them as expandable rows with distinctive orange background and green left border
• Visual Distinction: Viewpoint rows clearly differentiated from white topic rows and light blue comment rows
• Coordinate Precision: All coordinates displayed with 3-decimal precision
• Camera Types: Clear indication of Perspective vs Orthogonal camera properties
• BCF Compliance: Full support for all BCF coordinate specifications

Visual Analytics (Analytics Dashboard Tab)

1. View Charts: Five interactive charts automatically generate from your data:

• Status Distribution: See how issues are distributed across statuses
• Priority Analysis: Understand priority breakdown with percentages
• Timeline Creation: View when issues were created over time
• Author Activity: See who's contributing and how much
• Comments Volume: Track comment engagement patterns

2. Full-Screen Charts: Click any chart to open in lightbox mode

• Use mouse wheel to zoom in/out
• Press arrow keys to navigate between charts
• Press ESC to close lightbox
• Click the download icon to save chart as PNG

3. Custom Analytics: Use the analytics builder to:

• Select specific fields to analyze
• Generate custom cross-field reports
• Export custom analysis in multiple formats

Image Management (Image Viewer Tab)

1. Browse Images: View all extracted images in a grid layout
2. Full-Screen Viewing: Click any image to open in lightbox
   • Use arrow keys or click arrows to navigate
   • Mouse wheel or +/- keys to zoom
   • ESC to close
3. Download Images:
   • Single: Click download icon on any image
   • Multiple: Select images and use "Download Selected"
   • All: Use "Download All as ZIP" for complete collection
4. Generate Reports: Create professional documents with embedded images

Creating Reports and Exports

Data Export Options with Coordinates

1. Choose Export Format:
   • CSV: Universal format with complete coordinate data
   • Excel: Professional formatted spreadsheets with coordinate columns
2. Select Fields: Use the Configuration tab to:
   • Choose standard BCF fields plus viewpoint coordinates
   • Select all 18 coordinate fields or specific subsets
   • Save coordinate selections as templates
   • Apply saved templates for consistent coordinate exports
3. Coordinate Export Structure:
   • Topic Rows: Include primary viewpoint coordinate data
   • Viewpoint Rows: Additional rows for each extra viewpoint with complete coordinates
   • Field Consistency: Same coordinate data across Advanced Preview and exports
4. Export Process:
   • Click "Export" button in any tab
   • Choose your saved template or use default
   • Select file format
   • Download automatically starts

Professional Reports

1. PDF Reports: Three layout options available

• Grid Layout: Multiple images per page, compact format
• Detailed Report: One image per page with full topic information
• Executive Summary: Cover page with statistics plus optimized layout

2. Word Documents: Fully editable reports in three matching layouts

• Perfect for stakeholder collaboration
• Embedded images maintain quality
• Professional formatting with headers and styles

3. Custom Analytics Reports: Include charts and analysis in your reports

• Text format for quick review
• PDF format for formal presentation
• Word format for collaborative editing

Advanced Features

Template Management (Configuration Tab)

1. Create Templates:

• Select desired export fields
• Click "Save as Template"
• Name your template for easy identification

2. Manage Templates:

• Apply existing templates to any project
• Edit template field selections
• Delete unused templates
• Export templates as JSON files for team sharing

3. Import Team Templates:

• Receive JSON template files from colleagues
• Import via Configuration tab
• Apply standardized field selections across projects

Processing History

1. Track Activity: View all processed files and export operations
2. Review Metrics: See processing times, file sizes, and export counts
3. Export History: Download your processing history as CSV
4. Manage Sessions: Clear history or manage storage as needed

Tips for Best Results

Performance Enhancement

• Large Files: Process files individually if experiencing slowdowns
• Browser Memory: Close unnecessary tabs when working with large datasets
• Image Collections: Use ZIP download for large image collections rather than individual downloads

Data Quality

• Field Selection: Review available fields in Configuration tab before exporting
• Custom Fields: BCFSleuth automatically detects project-specific fields
• Version Differences: BCF 3.0 fields only appear when relevant content is detected

Report Preparation

• Template Strategy: Create templates for different report types (internal review, client presentation, compliance)
• Image Planning: Review images before generating reports to ensure relevant content
• Format Selection: Use PDF for final distribution, Word for collaborative editing

Team Workflows

• Standardization: Share export templates to ensure consistent reporting across team
• Processing History: Use history tracking for project documentation
• Multi-Format Output: Provide different report formats for different stakeholders

Working with Coordinate Data

• Camera Analysis: Use coordinate exports for camera position analysis and clash detection workflows
• Survey Integration: Export precise coordinates for integration with survey data and site positioning
• Model Validation: Compare viewpoint positions against design intent and construction progress
• Spatial Quality Control: Verify issue locations using precise camera coordinates for field verification
• Cross-Platform Coordination: Share exact viewpoint positions between different BIM software platforms
• Progress Documentation: Track spatial context of issues over time using coordinate-based analysis
• Viewpoint Management: Review multiple viewpoints to understand different perspectives on the same issue
• Precision Requirements: 3-decimal precision suitable for most AECO coordinate needs
• Template Strategy: Create coordinate-specific templates for different analysis types

User Interface Guide

Main Interface Tabs

Export Options

Data Export Formats

Chart and Image Export

Data Privacy & Security

BCFSleuth operates with complete client-side processing:

Technical Specifications

Browser Compatibility

• Chrome 90+ (Recommended)
• Firefox 85+
• Safari 14+
• Edge 90+

Performance Metrics

• BCF Processing: < 2 seconds for all formats
• Chart Generation: < 1 second for normal datasets
• Image Operations: Handles 300+ images efficiently
• Export Generation: < 10 seconds for comprehensive reports

Dependencies

• Chart.js 4.4.0 (Analytics)
• JSZip 3.10.1 (File processing)
• SheetJS 0.18.5 (Excel generation)
• jsPDF 3.0.1 (PDF creation)
• docx 7.8.2 (Word documents)

Advanced Features

Template Management

• Create Templates: Save field selection configurations
• Team Sharing: Export/import templates via JSON
• Version Control: Track template changes and usage
• Smart Defaults: Automatic template application

Custom Analytics

• Field Selection: Choose any combination of BCF fields
• Cross-Field Analysis: Discover data relationships
• Dynamic Updates: Real-time analysis as you modify selection
• Multi-Format Export: Text, PDF, and Word output options

Processing History

• Comprehensive Tracking: All file processing recorded
• Detailed Metrics: File sizes, processing times, export counts
• Export Capability: History available as CSV
• Session Persistence: Maintains history between browser sessions

Common Use Cases

Troubleshooting

Common Issues

Browser-Specific Notes

• Chrome: Best performance and feature support
• Firefox: Excellent compatibility, may be slower for large datasets
• Safari: Full functionality, some export dialogs differ
• Edge: Complete compatibility with Chrome-like performance

Support

Development & Contribution

BCFSleuth is developed using AI-assisted methodologies, combining domain expertise with advanced implementation capabilities.

Architecture

• Pure HTML/CSS/JavaScript (no framework dependencies)
• Modular design with clear separation of concerns
• Comprehensive error handling and user feedback
• Mobile-first responsive design

Contributing

• Report issues via GitHub
• Suggest features through discussions
• Submit pull requests for improvements
• Improve documentation and examples

About BCF

The Building Collaboration Format (BCF) is an open file format that supports workflow communication in BIM processes. It enables issue tracking, coordination, and quality management across different software platforms.

Learn More: buildingSMART International

Acknowledgments

BCFSleuth is inspired by the original Sloth application by Simon Moreau (BIM42). We're grateful for his pioneering work in BCF processing and contributions to the AECO open-source community.