SNT - New Data Source

Overview

This guide explains how to configure new data sources in our system. The system is built around two core concepts: Categories and Entities.

System Architecture

Categories

• Definition: A collection of related entities
• Components:
  • Unique ID
  • Parent ID (specifies root category)
  • Icon (SVG format)
  • Static fields
  • Dynamic fields
• Root Categories: ASSET, PEOPLE, SENSOR, ANNOTATION, VEHICLE

Entities

• Definition: A specific object or person
• Components:
  • Category ID (links to parent category)
  • Unique ID
  • Unique name
  • Static fields
  • Dynamic fields

Field Types

• Static Fields: Values that change infrequently (e.g., team affiliation, equipment ID)
  • Stored in persistent storage
  • Maintained across sessions
• Dynamic Fields: Values that change frequently or rapidly
  • Consumed and processed in real-time
  • Not stored permanently

---

Step-by-Step Configuration

1. Creating a New Category

Prerequisites: Access to the category management page

Steps:

1. Navigate to Category Page → SNT Categories
2. Click Create
3. Configure the following fields:
   • Name: Category identifier
   • Parent Category: Select from root categories (ASSET, PEOPLE, SENSOR, ANNOTATION, VEHICLE)
   • Dynamic Fields: Define frequently changing data fields
   • Static Fields: Define infrequently changing data fields
   • Icon: Upload SVG icon file

2. Entity Creation Methods

Method A: Direct Entity Creation

Steps:

1. Navigate to Entity Page
2. Click Add Entity
3. Configure entity settings:
   • Category Selection: Choose the newly created category
   • Entity Name: Define unique identifier
   • Static Fields: Click Add Info Field to configure static data
   • Location Settings (if applicable):
     • UTM Coordinates
     • Panel
     • Level
     • Note: UTM coordinates automatically apply corresponding mine_area

Method B: External Data Source Integration

Supported Sources:

• API endpoints
• Database (MSSQL, PostgreSQL)
• Message Queue (Kafka)

Steps:

1. Navigate to Configuration Page
2. Select Data Source Type
3. Click Create Config
4. Enter connection parameters
5. Select Static in Processor Function for entity creation
6. Verify connection validity

3. Data Mapping Configuration

Steps:

1. Entity Category Mapping: Select target category for configuration
2. Source Field Mapping:
   • Map entity name field from source
   • Map timestamp field from source
   • Select timestamp format
3. Static Field Mapping (if applicable):
   • Click Add in Data Mapping Keys
   • Map source fields to static entity fields
4. Location Mapping (if using UTM coordinates):
   • Configure Easting, Northing, Altitude fields

4. Verification and Monitoring

Success Indicators:

• Source configuration status changes to OK
• Entities appear in Entity Page

Dynamic Field Processing:

• Dynamic Mode: Records last processed timestamp, processes only new values
• Stream Mode: Processes all messages without filtering

---

Troubleshooting

Common Issues

• Status Not OK: Check configuration parameters and source availability, Verify source credentials and network connectivity, Ensure field names match exactly between source and target