Additional Features

Overview of advanced AquaGen features including SCADA/HMI visualization, Water Sustainability indices, Analytics & Reports, Manual Data Entry, and specialized monitoring tools.

1. SCADA Editor & Viewer

Supervisory Control and Data Acquisition (SCADA) interface for visual monitoring and control.

Overview

SCADA feature provides graphical representation of water infrastructure with real-time data visualization, allowing users to create custom diagrams and monitor live values on a visual schematic.

Routes:

/scada/editor - SCADA diagram editor
/scada/viewer - View-only SCADA interface

Permissions:

SCADA_EDITOR - Edit and create diagrams
SCADA_VIEWER - View existing diagrams

Key Features

SCADA Editor

Drag-and-Drop Interface: Place tanks, pipes, pumps, valves on canvas
Real-Time Data Binding: Link diagram elements to live sensors
Custom Shapes: Add text, shapes, images, icons
Layer Management: Organize complex diagrams in layers
Save/Load Diagrams: Persistent storage of SCADA layouts

Component Library:

Tanks (rectangular, circular, custom)
Pipes (straight, angled, curved)
Pumps (centrifugal, submersible)
Valves (gate, ball, check)
Sensors (flow, level, pressure)
Indicators (gauges, meters, status lights)

SCADA Viewer

Read-Only Mode: View diagrams without edit capability
Live Data Updates: Real-time sensor values on diagram
Color Coding: Status indicators (green=normal, red=alert, grey=offline)
Click for Details: Click elements to see detailed data
Full-Screen Mode: Presentation view for control rooms

Data Binding:

// Bind tank element to live stock data
element = {
  type: 'tank',
  unitId: 'UNIT_1',
  dataBinding: {
    value: 'stock.currentLevel',
    capacity: 'stock.maxCapacity',
    status: 'stock.online'
  },
  display: {
    showValue: true,
    showPercentage: true,
    colorByStatus: true
  }
};

API Endpoints

// Get SCADA diagram
GET /scada/graphEditor
Response: {
  diagram: {
    id: 'scada_1',
    name: 'Main Facility Overview',
    elements: [...],
    connections: [...],
    layout: {...}
  }
}

// Save SCADA diagram
POST /scada/data
Request Body: {
  diagram: {...}
}

2. Water Sustainability Features

Comprehensive water sustainability metrics and indices.

Water Balance

Track water inputs vs outputs for sustainability analysis.

Route: /water-balance Permission: WATER_BALANCE

Metrics:

Water Credited (Augmented):
- Rainwater harvested
- Rainwater recharged
- Wastewater treated and reused
Water Debited (Consumed):
- Groundwater extracted
- Municipal water used
- External water (tankers)

Balance Calculation:

Water Balance = Water Credited - Water Debited
Neutrality % = (Water Credited / Water Debited) × 100

Features:

Monthly water balance reports
Trend graphs (credited vs debited)
Neutrality score tracking
Export balance sheet (PDF, Excel)

Water Neutrality

Percentage of water augmented compared to water consumed.

Route: /water-neutrality

Display:

Current neutrality percentage
Historical trend (monthly, yearly)
Target vs actual comparison
Sustainability score

Color Coding:

Green (≥100%): Positive water balance
Yellow (75-99%): Near neutral
Orange (50-74%): Needs improvement
Red (<50%): Critical deficit

Water Indices

Four key sustainability indices:

Rain Water Index (RWI)

Measures rainwater harvesting efficiency

RWI = (Rainwater Harvested / Total Rainfall) × 100

Route: /rwi Permission: RWI

Features:

Rainfall data integration
Harvesting efficiency calculation
Potential vs actual comparison
Monthly/annual reports

Urban Water Index (UWI)

Urban water management performance metric

Route: /uwi Permission: UWI_DASHBOARD

Metrics:

Per capita water consumption
Water loss percentage
Reuse rate
Supply reliability

Water Risk Index (WRI)

Assess water stress and risk levels

Route: /wri Permission: WRI

Risk Factors:

Groundwater depletion rate
Dependency on external sources
Seasonal variability
Demand growth trends

Risk Levels:

Low Risk (0-25)
Medium Risk (26-50)
High Risk (51-75)
Critical Risk (76-100)

Ground Water Index (GWI)

Ground water sustainability indicator

Route: /gwi Permission: GWI

Calculations:

Extraction vs recharge ratio
Water table decline rate
Aquifer health score
Sustainability forecast

3. Analytics & Reports

Comprehensive reporting and data export capabilities.

Report Types

Consumption Report

Detailed breakdown of water consumption

Contents:

Daily/monthly/yearly consumption
Category-wise breakdown
Unit-wise analysis
Peak consumption periods
Trend analysis

Export Formats: PDF, Excel, CSV

Quality Report

Water quality parameter analysis

Contents:

Parameter readings (pH, TDS, Turbidity, etc.)
Threshold violation summary
Compliance status
Historical trends
Lab test results

Stock Report

Storage tank inventory report

Contents:

Current stock levels
Capacity utilization
Fill/drain patterns
Stock trends
Low stock alerts

Alert Summary Report

Comprehensive alert analytics

Contents:

Alert frequency by type
Response time analysis
Resolution status
Top alerting units
Alert trends

Scheduled Reports

Automated report generation and distribution

Features:

Daily/Weekly/Monthly Schedule
Email Distribution: Send to multiple recipients
Auto-Generate: Run at specified time
Template Customization: Choose report sections
Format Selection: PDF or Excel

Configuration:

{
  reportType: 'consumption',
  schedule: 'daily',
  time: '08:00',
  recipients: ['manager@example.com', 'admin@example.com'],
  format: 'PDF',
  sections: ['summary', 'trends', 'alerts']
}

Data Export

Bulk data export for external analysis

Export Options:

CSV: Raw data export
Excel: Formatted workbook with charts
PDF: Presentation-ready report
JSON: API data dump

Time Ranges:

Last 24 hours
Last 7 days
Last 30 days
Custom date range

4. Manual Data Entry

Manual input for offline sensors or manual readings.

Route: /manual-entry Permission: MANUAL_ENTRY

Features

Entry Forms:

Unit selection dropdown
Parameter selection
Value input with validation
Timestamp entry
Notes/comments field

Validation:

Min/max range checks
Unit type verification
Duplicate entry detection
Mandatory field validation

Use Cases:

Offline sensor backup
Lab test results entry
Manual meter readings
Calibration data
Historical data import

Audit Trail:

User who entered data
Entry timestamp
Original vs edited values
Edit history

API:

POST /manual/entry
Request Body: {
  unitId: 'UNIT_1',
  parameter: 'stock',
  value: 850.5,
  timestamp: '25/02/2026 10:30',
  notes: 'Manual reading from gauge',
  enteredBy: 'user123'
}

5. User Management

User roles, permissions, and account management.

Route: /users (Admin only) Permission: SUPER_USER

Features

User Roles

Super User: Full access, user management
Admin: All features except user management
Manager: View and basic operations
Operator: Limited to assigned units
Viewer: Read-only access

Permission Management

Granular permission assignment (33+ permissions)
Role-based templates
Custom permission sets
Unit-level access control

User Operations

Create/edit/delete users
Reset passwords
Enable/disable accounts
View activity logs
Bulk user import

6. Settings & Configuration

System-wide and user-specific settings.

Route: /settings

7. Energy Monitoring

Track energy consumption related to water operations.

Route: /energy Permission: ENERGY_CATEGORY

Features

Metrics:

Total energy consumption (kWh)
Energy per unit water (kWh/kL)
Pump efficiency
Peak demand
Cost analysis

Visualizations:

Energy consumption trends
Time-of-day analysis
Equipment-wise breakdown
Renewable vs non-renewable
Cost savings from efficiency

Integration:

Links to water pumping data
Correlates with flow rates
Treatment plant energy
Distribution network energy

8. Mobile App Features

Capacitor-based mobile application.

Capabilities

Platform Support:

iOS (native)
Android (native)
Progressive Web App (PWA)

Mobile-Specific Features:

Push notifications
Offline mode
Camera for issue reporting
GPS for field readings
Barcode scanner for unit identification

Optimizations:

Touch-friendly UI
Responsive layouts
Reduced data usage
Battery-efficient updates
App shortcuts

9. Comparison Tools

Side-by-side comparison of units, periods, or categories.

Route: /compare

Comparison Types

Unit Comparison

Compare two or more units
Side-by-side graphs
Performance benchmarking
Best/worst performers

Period Comparison

Month-over-month
Year-over-year
Custom date ranges
Seasonal analysis

Category Comparison

Source vs Consumption
Stock vs Flow
Expected vs Actual
Budget vs Actual

10. Geospatial Features

Map-based visualization and monitoring.

Library: Leaflet.js

Features

Map Views:

Facility overview map
Unit location markers
Cluster view for dense areas
Satellite/terrain layers
Custom boundaries

Interactive Elements:

Click marker for unit details
Color-coded by status
Real-time value tooltips
Navigate to unit on click
Heatmaps for consumption

Use Cases:

Locate offline units
Identify leakage zones
Plan maintenance routes
Visualize distribution network

Summary

All Additional Features:

Feature	Route	Permission	Key Functionality
SCADA Editor	`/scada/editor`	SCADA_EDITOR	Create visual diagrams
SCADA Viewer	`/scada/viewer`	SCADA_VIEWER	View live diagrams
Water Balance	`/water-balance`	WATER_BALANCE	Track inputs vs outputs
Water Neutrality	`/water-neutrality`	-	Sustainability percentage
RWI	`/rwi`	RWI	Rainwater harvesting index
UWI	`/uwi`	UWI_DASHBOARD	Urban water index
WRI	`/wri`	WRI	Water risk assessment
GWI	`/gwi`	GWI	Ground water index
Reports	`/reports`	REPORTS	Generate & schedule reports
Manual Entry	`/manual-entry`	MANUAL_ENTRY	Manual data input
User Management	`/users`	SUPER_USER	Manage users & permissions
Settings	`/settings`	-	System configuration
Energy	`/energy`	ENERGY_CATEGORY	Energy monitoring
Comparison	`/compare`	-	Compare units/periods
Maps	`/maps`	-	Geospatial visualization

Dashboard - Main overview page
Routes - Complete route reference
Permissions - Permission details
API & Services - API integration

Last Updated: February 2026

1. SCADA Editor & Viewer​

Overview​

Key Features​

SCADA Editor​

SCADA Viewer​

API Endpoints​

2. Water Sustainability Features​

Water Balance​

Water Neutrality​

Water Indices​

Rain Water Index (RWI)​

Urban Water Index (UWI)​

Water Risk Index (WRI)​

Ground Water Index (GWI)​

3. Analytics & Reports​

Report Types​

Consumption Report​

Quality Report​

Stock Report​

Alert Summary Report​

Scheduled Reports​

Data Export​

4. Manual Data Entry​

Features​

5. User Management​

Features​

User Roles​

Permission Management​

User Operations​

6. Settings & Configuration​

Categories​

Account Settings​

Facility Settings (Admin)​

Monitoring Configuration​

Integration Settings​

7. Energy Monitoring​

Features​

8. Mobile App Features​

Capabilities​

9. Comparison Tools​

Comparison Types​

Unit Comparison​

Period Comparison​

Category Comparison​

10. Geospatial Features​

Features​

Summary​

Related Documentation​

1. SCADA Editor & Viewer

Overview

Key Features

SCADA Editor

SCADA Viewer

API Endpoints

2. Water Sustainability Features

Water Balance

Water Neutrality

Water Indices

Rain Water Index (RWI)

Urban Water Index (UWI)

Water Risk Index (WRI)

Ground Water Index (GWI)

3. Analytics & Reports

Report Types

Consumption Report

Quality Report

Stock Report

Alert Summary Report

Scheduled Reports

Data Export

4. Manual Data Entry

Features

5. User Management

Features

User Roles

Permission Management

User Operations

6. Settings & Configuration

Categories

Account Settings

Facility Settings (Admin)

Monitoring Configuration

Integration Settings

7. Energy Monitoring

Features

8. Mobile App Features

Capabilities

9. Comparison Tools

Comparison Types

Unit Comparison

Period Comparison

Category Comparison

10. Geospatial Features

Features

Summary

Related Documentation