NetX TimeSeries Configuration
The NetX TimeSeries Configuration table is the registry of historian tags for NetX equipment. Historian tags are digital IDs which relate to a specific measurement on a specific piece of equipment. The NetX TimeSeries History table is related to this configuration registry table by the equipment and tag source IDs.
Each configuration entry belongs to a single piece of equipment, specified as sourceEquipmentId, which must match a sourceId in the NetX EquipmentNetX Equipment table. The unique constraint on this table is (sourceEquipmentId + sourceId).
TimeSeries Configuration for a given sourceId must be added to the system before attempting to add TimeSeries History to that tag.
Variable | Data Type | Is Nullable? | Description |
|---|---|---|---|
sourceEquipmentId | String | No | Source ID of the equipment this tag belongs to. This must match the sourceId of a NetX EquipmentNetX Equipment record. The record will be rejected if it does not. |
sourceId | String | No | Time series tag identifier OSI PI Use Tag ID: xxx.yyy.zzz OSI PI AF use AttributeID: \\server\\element\\attributeID |
measurement | String | No | See section below for possible values |
unit | String | Yes | Unit of measure |
Time Series Measurement Values
Time series measurements must be provided from the following list of possible values.
Rates
- OIL_RATE - STB/d
- GAS_RATE - Mscf/d
- WATER_RATE - STB/d
- GAS_LIFT_INJECTION_RATE - Mscf/d
Pressures
- INLET_PRESSURE - psig
- OUTLET_PRESSURE - psig
- TUBING_PRESSURE - psig
- DOWNSTREAM_CHOKE_PRESSURE - psig
Temperatures
- INLET_TEMPERATURE - degF
- OUTLET_TEMPERATURE - degF
Constraints
- MIN_GAS_LIFT_INJECTION_CONSTRAINT - Mscf/d
- MAX_GAS_LIFT_INJECTION_CONSTRAINT - Mscf/d
- MAX_WATER_RATE_CONSTRAINT - STB/d
Other
- EQUIPMENT_STATUS
- 0 -> Disabled
- 1 -> Enabled
- 2 -> Mask
- OPTIMIZATION_FLAG
- 0 -> Optimize
- 1 -> Fixed
- OIL_API_GRAVITY - API degrees
Data Integrity Checks
Condition | Response |
|---|---|
sourceEquipmentId does not match an Equipment record | Record Rejected |
measurement is not one of the enum values | Record Rejected |
Deleting an equipment record CASCADE DELETES its time series configurations. Deleting a configuration CASCADE DELETES its history.
Common Error Messages
API | Scenario | Error Response |
|---|---|---|
Add / Upsert a tag | Unknown sourceEquipmentId | Equipment with sourceId: "xxx" was not found |
Fetch a tag | Missing or invalid ids | TimeSeries with sourceEquipmentId "xxx" and sourceId "xxx" does not exist |
Delete a tag | Missing or invalid ids | TimeSeries with sourceEquipmentId: "xxx" and sourceId: "xxx" was not found |