Skip to main content

FacilFlow Documentation

Data pipeline platform for manufacturing analytics — Version 0.3.0

FacilFlow is the central hub for collecting, processing, and delivering industrial data from plant floor systems to analytics applications. It bridges operational technology (OT) and information technology (IT), enabling engineers to build data pipelines without writing code.

Key Features​

Visual Pipeline Builder​

  • Drag-and-Drop: Build data pipelines visually with React Flow
  • Live Preview: See data flowing through your pipeline in real-time
  • Node Types: Sources, processors, sinks, and edge agent nodes
  • Node Palette: Categorized node library with search

Real-time Monitoring​

  • Pipeline Status: Live updates via WebSocket connections
  • Agent Heartbeats: Real-time edge agent health tracking
  • Toast Notifications: Instant alerts for status changes and errors

Edge Agent Management​

  • Deploy Agents: Manage FacilEdge agents at plant sites
  • Monitor Status: Real-time health and connectivity status
  • Remote Control: Start, stop, and restart agents remotely

Data Connectors​

  • OPC-UA: Direct PLC and SCADA connectivity
  • PI System: OSIsoft historian integration
  • Airbyte: 300+ source connectors for databases, APIs, and more

Data Explorer​

  • SQL Queries: Query time-series data with native SQL
  • Time Ranges: Flexible time range picker for analysis
  • Visualizations: Charts and tables for query results

Multi-Cloud Object Store​

  • Provider Agnostic: Switch between MinIO, AWS S3, Azure Blob, and Google Cloud Storage
  • Unified Interface: Same UI for all storage providers
  • Bucket Management: Create, list, and delete buckets across providers
  • Object Operations: Upload, download, delete with presigned URLs
  • Connection Testing: Verify provider connectivity from the UI

Jarvis AI Assistant​

  • Floating Chat Panel: Access via Ctrl+K or the chat bubble in the bottom-right
  • SSE Streaming: Real-time response streaming for immediate feedback
  • Artifact Rendering: View charts, tables, code blocks, and Mermaid diagrams inline
  • Canvas Panel: Side panel for exploring generated artifacts
  • Claude Code Integration: OAuth-based authentication via Claude Code CLI

Authentication & RBAC​

  • Firebase Auth: Email/password and Google SSO
  • Role-Based Access: Admin, Operator, Viewer roles
  • Protected Routes: Permission-based route guards
SectionDescription
Quick StartGet running in 5 minutes
InstallationDetailed installation options
User GuideLearn the UI and features
API ReferenceREST API documentation

Architecture Overview​

Getting Help​