SIENTIAPDE-1084
Update README.md to reflect new workflow configuration parameters, including temporal input settings, tag definitions, and filter policies for enhanced clarity on system capabilities.
This commit is contained in:
62
README.md
62
README.md
@@ -387,28 +387,54 @@ The Scouter system exposes comprehensive Prometheus metrics:
|
||||
|
||||
### Workflow Configuration
|
||||
|
||||
Workflows are configured through input parameters:
|
||||
Temporal input parameters:
|
||||
|
||||
```json
|
||||
{
|
||||
"topic": "raw_sensor_data",
|
||||
"schedule_name": "hourly_collection",
|
||||
"model_name": "temperature_sensors",
|
||||
"model_id": "temp_001",
|
||||
"filters": {
|
||||
"NULL_VALUES_FILTER": {"policy": "DISCARD"},
|
||||
"OUT_OF_BOUNDS_FILTER": {"policy": "DISCARD"}
|
||||
},
|
||||
"model_tags": {
|
||||
"Temperature": {
|
||||
"data_range": [-50, 150],
|
||||
"aggr_function": "avg",
|
||||
"frequency": "60000"
|
||||
"schedule_name": "scouter-opcua-orchestrated-pipeline",
|
||||
"model_id": "1",
|
||||
"workflow_type": "scouter",
|
||||
"frequency": "5s", # Workflow execution frequency
|
||||
"max_retry_policy": 1, # Maximum number of retries for the workflow
|
||||
"read_tags": [
|
||||
{
|
||||
"tag_name": "Counter",
|
||||
"server_id": "1",
|
||||
"aggr_func": "avg",
|
||||
"tag_address": "ns=2;i=2",
|
||||
"frequency": "15000", # Tag expected frequency (used in Ingestor)
|
||||
"data_range": [
|
||||
-100,
|
||||
100
|
||||
]
|
||||
},
|
||||
{
|
||||
"tag_name": "Rollout",
|
||||
"server_id": "1",
|
||||
"aggr_func": "mdn",
|
||||
"tag_address": "ns=2;i=3",
|
||||
"frequency": "15000",
|
||||
"data_range": [
|
||||
-100,
|
||||
100
|
||||
]
|
||||
}
|
||||
},
|
||||
"retention_time": 3600,
|
||||
"schema": "sensor_data",
|
||||
"table_name": "temperature_readings"
|
||||
],
|
||||
"filters": [
|
||||
{
|
||||
"filter_name": "OUT_OF_BOUNDS_FILTER",
|
||||
"policy": "DISCARD"
|
||||
},
|
||||
{
|
||||
"filter_name": "NULL_VALUES_FILTER",
|
||||
"policy": "DISCARD"
|
||||
}
|
||||
],
|
||||
"tag_retention_minutes": 60, # Time that tag data is cached in Redis
|
||||
"active": true,
|
||||
"updated_at": {
|
||||
"$date": "2025-08-13T18:35:01.600Z"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user