System Documentation

Welcome to RACE MES Management Console Documentation

Comprehensive documentation for the Rule-Action-Cognition-Events framework, covering system architecture, API reference, user guides, and deployment instructions.

RACE Framework Architecture Diagram

Visual overview of the Rule-Action-Cognition-Events framework showing component interactions and data flow.

Quick access to the architectural slide with detailed component descriptions
System Architecture

Detailed technical documentation of the RACE framework architecture, including data models, service layers, and component interactions.

  • • Flask MVC Architecture
  • • Database Schema
  • • Service Layer Design
  • • Background Processing
API Reference

Complete REST API documentation with endpoints, request/response formats, and authentication details.

  • • Template & Instance Management
  • • Event-Driven Action Execution
  • • Real-time Monitoring Endpoints
  • • System Tags & Enrichment
  • • Force Evaluation & Lifecycle
User Guide

Step-by-step instructions for using the RACE Management Console, from basic setup to advanced configurations.

  • • Event-Driven Workflows
  • • Action Templates & Execution
  • • System Tags & Enrichment
  • • Real-time Event Management
  • • Plant Model Integration
Deployment Guide

Production deployment instructions, environment setup, and configuration management for enterprise environments.

  • • Environment Setup
  • • Database Configuration
  • • Security Settings
  • • Performance Tuning
Troubleshooting

Common issues, error messages, diagnostic procedures, and solutions for system problems.

  • • Common Errors
  • • Debug Procedures
  • • Log Analysis
  • • Performance Issues
Quick Reference

Essential shortcuts, keyboard commands, and quick access guides for efficient system operation.

  • • Keyboard Shortcuts
  • • System Tags Reference
  • • Rule Expression Syntax
  • • Placeholder Types
System Information
RACE Framework Version

Management Console v2.1 (August 2025)

Core Features
  • Event-Driven Workflow System
  • REST API Action Execution
  • Template-Instance Architecture
  • Dynamic System Tags Resolution
  • Real-time Event Enrichment
  • AI-Powered Cognition Engine
Technical Stack
  • Backend: Flask, SQLAlchemy, APScheduler
  • Frontend: Bootstrap 5, Feather Icons, Chart.js
  • Database: PostgreSQL (Production), SQLite (Development)
  • API Integration: CONNECT Data Services (OAuth2)
ISA-95 Compliance

Fully compliant with ISA-95 manufacturing operations management standards.