---
title: NetX TimeSeries Configuration
slug: netx-timeseries-configuration
description: NetX time series tag registry table specification
docTags: 
createdAt: 2026-08-14T16:07:40.959Z
---

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 Equipment](docId:5rkyG--EzYBTqbFa7BXbE) table. The unique constraint on this table is (**sourceEquipmentId + sourceId**).

:::hint{type="warning"}
**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 Equipment](docId:5rkyG--EzYBTqbFa7BXbE) record. The record will be rejected if it does not. |
| sourceId          | String        | No               | Time series tag identifier<br /><br />**OSI PI Use Tag ID:**<br />xxx.yyy.zzz<br /><br />**OSI PI AF use AttributeID**:<br />\\\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 |