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

Configure CONNECT API settings
Discover and register data streams
Create rule templates with actions
Deploy template instances
Watch Event-Driven workflow in action
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

Navigate to Templates: Go to Rules → Manage Rules
Create Package: Organize templates in logical packages (e.g., "Production Monitoring")
Add Template: Click "Add Template" and provide:
- Template name and description
- Category (production, maintenance, quality, etc.)
- Color for visual identification
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)
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:

Create Instance: Go to Instance Management or Plant Model
Select Template: Choose the template to instantiate
Plant Location: Select the FLOC ID (equipment location)
Map Placeholders: Connect template placeholders to actual data streams:
- <LEVEL> → Wonderbrew.Tank001.Level.PV
- <EQUIPMENT> → Tank001 (or use system tag)
Variable Mappings: Add enrichment data (optional)
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

Tag	Auto-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

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

Create "Production Monitoring" package
Design templates for:
- Equipment utilization tracking
- Production rate monitoring
- Quality parameter tracking
Deploy instances for each production line
Configure event wall for real-time monitoring
Set up automated reports

2. Maintenance Alerting

Create "Maintenance" package
Design templates for:
- Vibration monitoring
- Temperature thresholds
- Pressure anomalies
Deploy instances for critical equipment
Configure escalation procedures
Monitor maintenance event patterns

3. Template Modification Process

Identify instances using the template
Undeploy all active instances
Modify template as needed
Test template with development instance
Redeploy production instances
Verify proper operation

4. Troubleshooting Process

Check system health dashboard
Review recent events for patterns
Verify CONNECT API connectivity
Check instance deployment status
Review monitoring engine logs
Test individual stream connections