User Guide

Getting Started
Welcome to RACE Management Console

RACE (Rule-Action-Cognition-Events) v2.1 is an advanced industrial monitoring platform with complete Event-Driven workflow orchestration. Create intelligent automation rules that automatically execute REST API actions and enrich events with real-time data from external microservices.

Key Concepts
  • Templates: Reusable rule definitions with placeholders and actions
  • Instances: Deployed templates configured for specific equipment
  • Placeholders: Dynamic binding points (e.g., <EQUIPMENT>, <LEVEL>)
  • Events: Generated when rules trigger, with automatic enrichment
  • Actions: REST API microservice calls executed automatically
  • System Tags: Auto-resolved placeholders (<EQUIPMENT>, <LINE>, <DATE>)
  • Enrichment: Event data populated by action execution results
Quick Start
  1. Configure CONNECT API settings
  2. Discover and register data streams
  3. Create rule templates with actions
  4. Deploy template instances
  5. Watch Event-Driven workflow in action
  6. Monitor enriched events in real-time
Initial Configuration
1. CONNECT API Configuration

Configure connection to AVEVA CONNECT Data Services:

  • Navigate to Configuration in the dashboard
  • Enter your tenant ID and namespace ID
  • Provide client credentials (ID and secret)
  • Test the connection to verify settings
Note: Contact your AVEVA administrator for CONNECT credentials if you don't have them.
2. Asset Discovery

Discover and register data streams:

  • Go to Assets → Manage
  • Click "Discover Assets" to scan for available streams
  • Review discovered streams and their data types
  • Select streams to monitor and register them
Tip: Start with a small set of critical streams before expanding to avoid overwhelming the system.
Template Management
Creating Templates
  1. Navigate to Templates: Go to Rules → Manage Rules
  2. Create Package: Organize templates in logical packages (e.g., "Production Monitoring")
  3. Add Template: Click "Add Template" and provide:
    • Template name and description
    • Category (production, maintenance, quality, etc.)
    • Color for visual identification
  4. Define Placeholders: Add placeholders that will be mapped to actual streams:
    • <EQUIPMENT> - Equipment identifier
    • <LEVEL> - Tank level sensor
    • <TEMPERATURE> - Temperature sensor
    • Specify data types: NUM (numeric), STR (string), DIS (discrete)
  5. Create Rules: Define conditions and actions for your template
Template Example

Name: Tank Level Monitor

Placeholders:

  • <LEVEL> - Tank level (NUM)
  • <EQUIPMENT> - Tank ID (STR)
Rule Creation

Rules define the logic for triggering events:

  • Conditions: When to trigger (e.g., level > 95%)
  • Logic: AND/OR combinations for multiple conditions
  • Event Details: What event to create
  • Stop Processing: Prevent subsequent rules from running
Available Operators:
  • equals, not_equals
  • greater_than, less_than
  • greater_than_or_equal, less_than_or_equal
  • contains, starts_with, ends_with
  • in_list, not_in_list
Rule Example
{
  "rule_id": "Tank.HighLevel",
  "rule_name": "High Level Alert",
  "conditions": [
    {
      "stream": "<LEVEL>",
      "operator": "greater_than",
      "value": 95.0
    }
  ],
  "logic": "AND",
  "event_name": "<EQUIPMENT>.HighLevel",
  "event_description": "Tank level critical",
  "severity": "warning",
  "category": "production"
}
Instance Management
Creating Instances

Instances are deployed configurations of templates for specific equipment:

  1. Create Instance: Go to Instance Management or Plant Model
  2. Select Template: Choose the template to instantiate
  3. Plant Location: Select the FLOC ID (equipment location)
  4. Map Placeholders: Connect template placeholders to actual data streams:
    • <LEVEL> → Wonderbrew.Tank001.Level.PV
    • <EQUIPMENT> → Tank001 (or use system tag)
  5. Variable Mappings: Add enrichment data (optional)
  6. Deploy: Activate the instance for monitoring
System Tags

Use automatic placeholders:

  • <EQUIPMENT> - Auto-detected
  • <DATE> - Current date
  • <TIME> - Current time
  • <SHIFT> - Current shift
Instance Lifecycle
Development

Create and configure instance with placeholder mappings

Deployed

Active monitoring with rule evaluation and event generation

Undeployed

Inactive with all events closed and monitoring stopped

Event Monitoring
Event Wall

Real-time visual timeline of all system events:

  • Timeline View: Events displayed chronologically
  • Color Coding: Events colored by template and severity
  • Grouping: Events grouped by template or category
  • Filtering: Filter by time range, template, or status
  • Auto-refresh: Real-time updates every 30 seconds
Event Details

Click any event to view:

  • Event name and description
  • Trigger conditions and values
  • Duration and status
  • Associated template and instance
  • Enrichment data
Event Management

Comprehensive event lifecycle management:

  • Edit Events: Modify event details and descriptions
  • Close Events: Manually close active events
  • Event History: Complete audit trail of changes
  • Bulk Operations: Manage multiple events at once
  • Export Data: Export event data for analysis
Event Categories
  • Production: Manufacturing and process events
  • Maintenance: Equipment health and service
  • Quality: Product quality and compliance
  • Utilization: Equipment usage and efficiency
  • Execution: Process execution and workflow
Event-Driven Workflow System

The RACE v2.1 Event-Driven system automatically executes REST API actions when rules trigger and enriches events with real-time data:

How Event-Driven Workflows Work
1. Rule Triggers

When stream data meets rule conditions, the system automatically:

  • Creates a new event
  • Applies system tag defaults
  • Resolves <EQUIPMENT> and <LINE> from Plant Model
2. Action Execution

REST API actions execute with event context:

  • HTTP requests to external microservices
  • Event enrichment data passed as input
  • Automatic retry and error handling
3. Result Integration

Action results update event enrichment:

  • Variables like LOTCODE populated
  • Changes persist with SQLAlchemy
  • Real-time dashboard updates
4. Force Evaluation

Manual testing and debugging:

  • Trigger actions on existing events
  • Test workflow without rule conditions
  • Debug action execution logic
System Tags Resolution
TagAuto-Value
<EQUIPMENT>Roaster022
<LINE>Line02
<DATE>2025-08-17
<TIME>16:05:30
<SHIFT>Evening
Verified Results

Real deployment testing confirmed:

  • LOTCODE: "N/A" → "5365L2R2"
  • Actions: Execute successfully
  • Persistence: Works with SQLAlchemy
Dynamic Form Builder

The Dynamic Form Builder is an enterprise-grade AI-powered system for creating and managing dynamic forms with advanced version control and MES workflow integration.

AI-Powered Form Creation

Create forms through conversational AI:

  • Navigate: Configuration → Form Builder
  • Create New Form: Click "Create New Form" button
  • Select AI Provider: Choose from OpenAI, Anthropic, or Gemini
  • Describe Requirements: Tell the AI what kind of form you need in natural language
  • Refine Design: Continue conversation to perfect the form structure
  • Generate JSON: AI creates complete form definition
Supported Widget Types
  • Input: text, number, email
  • Selection: dropdown, radio, checkbox
  • Advanced: date, switch, textarea
  • Layout: cards, grids
  • Interactive: buttons
  • Display: text labels
Advanced Version Management

4-Digit versioning system (major.minor.patch.build):

Version Controls
  • Version Dropdown: Select and load previous versions
  • Auto-increment: Optional build number increment (checkbox)
  • Status Management: Independent Draft/Published per version
  • URL Access: Direct version links (?ver=X.X.X.X&status=draft)
Grid Layout System
  • Drag & Drop: Position widgets on responsive grid
  • Version-Specific: Each version maintains completely independent grid layout configuration
  • Database Storage: Grid layouts saved and loaded per version with automatic isolation
  • Runtime Faithful: Exact layout reproduction for each specific version
AI Conversation

Describe form requirements in natural language and let AI design the structure

Grid Designer

Drag and drop widgets on responsive grid with version-specific persistence

MES Integration

Connect form buttons to ActionTemplates for complete MES workflow automation

Form Builder Workflow
  1. Create: Start AI conversation to generate form structure
  2. Design: Use grid layout to position and organize widgets
  3. Version: Control versioning with major.minor.patch.build system
  4. Status: Manage Draft/Published status per version
  5. Test: Use runtime preview to validate form behavior
  6. Deploy: Publish form for production use
  7. Iterate: Create new versions with improvements
Security & Access
  • Requires configuration.form_builder permission
  • Form-level access control
  • Complete audit logging
  • CSRF protection
Best Practices
Template Design
  • Use descriptive names for templates and rules
  • Group related templates in packages
  • Design templates for maximum reusability
  • Document placeholder requirements clearly
  • Use consistent naming conventions
  • Test templates thoroughly before deployment
Instance Management
  • Use descriptive instance names
  • Verify all placeholder mappings before deployment
  • Monitor instance performance after deployment
  • Undeploy instances before template modifications
  • Keep instance documentation updated
  • Regular review of deployed instances
Monitoring
  • Set up appropriate event categories
  • Monitor system health regularly
  • Review event patterns for insights
  • Clean up old events periodically
  • Use enrichment data for context
  • Establish alert escalation procedures
Common Workflows
1. Production Monitoring Setup
  1. Create "Production Monitoring" package
  2. Design templates for:
    • Equipment utilization tracking
    • Production rate monitoring
    • Quality parameter tracking
  3. Deploy instances for each production line
  4. Configure event wall for real-time monitoring
  5. Set up automated reports
2. Maintenance Alerting
  1. Create "Maintenance" package
  2. Design templates for:
    • Vibration monitoring
    • Temperature thresholds
    • Pressure anomalies
  3. Deploy instances for critical equipment
  4. Configure escalation procedures
  5. Monitor maintenance event patterns
3. Template Modification Process
  1. Identify instances using the template
  2. Undeploy all active instances
  3. Modify template as needed
  4. Test template with development instance
  5. Redeploy production instances
  6. Verify proper operation
4. Troubleshooting Process
  1. Check system health dashboard
  2. Review recent events for patterns
  3. Verify CONNECT API connectivity
  4. Check instance deployment status
  5. Review monitoring engine logs
  6. Test individual stream connections