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:
vitor-aignosi
2025-08-29 15:19:32 -03:00
parent 88576252af
commit 9dc3a4c55a

View File

@@ -387,28 +387,54 @@ The Scouter system exposes comprehensive Prometheus metrics:
### Workflow Configuration ### Workflow Configuration
Workflows are configured through input parameters: Temporal input parameters:
```json ```json
{ {
"topic": "raw_sensor_data", "schedule_name": "scouter-opcua-orchestrated-pipeline",
"schedule_name": "hourly_collection", "model_id": "1",
"model_name": "temperature_sensors", "workflow_type": "scouter",
"model_id": "temp_001", "frequency": "5s", # Workflow execution frequency
"filters": { "max_retry_policy": 1, # Maximum number of retries for the workflow
"NULL_VALUES_FILTER": {"policy": "DISCARD"}, "read_tags": [
"OUT_OF_BOUNDS_FILTER": {"policy": "DISCARD"} {
"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
]
}, },
"model_tags": { {
"Temperature": { "tag_name": "Rollout",
"data_range": [-50, 150], "server_id": "1",
"aggr_function": "avg", "aggr_func": "mdn",
"frequency": "60000" "tag_address": "ns=2;i=3",
"frequency": "15000",
"data_range": [
-100,
100
]
} }
],
"filters": [
{
"filter_name": "OUT_OF_BOUNDS_FILTER",
"policy": "DISCARD"
}, },
"retention_time": 3600, {
"schema": "sensor_data", "filter_name": "NULL_VALUES_FILTER",
"table_name": "temperature_readings" "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"
}
} }
``` ```