---
title: TimeSeries Configuration
slug: timeseries-configuration
docTags: 
createdAt: 2023-03-22T19:17:42.000Z
---

# Summary

The TimeSeries Configuration table is the master registry of historian tags. A historian tag is a digital ID that identifies a specific measurement on a specific well. The [TimeSeries History](docId\:LaH15kJXITEjXtldDptLh) table relates to this registry by sourceId.

Each configuration entry belongs to a single well, specified as **sourceWellId**. Each well can have one tag of each measurement type (e.g. WHP, OILRATE).

The unique constraint on this table is (**sourceWellId + sourceId + measurement**).

:::hint{type="warning"}
**TimeSeries Configuration** for a given **sourceId** must be added to the system before attempting to add **TimeSeries History** to that **sourceTimeSeriesId**.
:::

| **Variable** | **Data Type** | **Is Nullable?** | **Description**                                                                                                                                                |
| ------------ | ------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| sourceWellId | String        | No               | Source ID for the well<br /><br />**From WellView:** wvwellheader table, idwell column<br />**From OpenWells:** cd\_well table, well\_id column                |
| 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. The UoM in this field must match the documented UoM for the measurement, as listed below.                                                     |

***

# Time Series Measurement Values

Time series measurements must be provided from the following list of possible values. ProdX forces standardization to enable high frequency data to be used in modeling and comparative visualization.

## Rates

- OILRATE - STB/d
- GASRATE - Mscf/d
- GASLIFTINJECTIONRATE - Mscf/d (actual gas lift injection rate)
- GASLIFTINJECTIONRATESETPOINT - Mscf/d (control system gas lift injection rate setpoint)
- WATERRATE - STB/d
- SANDRATE - g/s

## Pressures

- WHP - psig (wellhead/tubing head pressure)
- CHP - psig (casing pressure)
- DHGP - psig (downhole gauge pressure)
- DHGP\_DISCHARGE - psig (downhole gauge pressure at pump discharge)
- PRESSUREUPSTREAM - psig (upstream choke pressure / flowline pressure)
- PRESSUREDOWNSTREAM - psig (downstream choke pressure tubing side)
- PRESSURE\_DOWNSTREAM\_ANNULUS - psig (downstream choke pressure annulus side)
- HPSEPARATORPRESSURE - psig
- LPSEPARATORPRESSURE - psig

## Temperatures

- WHT - degF (wellhead/tubing temp)
- CHT - degF (casing temp)
- DHGT - degF (downhole gauge temp)
- FLOWLINETEMPERATURE - degF

## Other

- CHOKE - %
- WELLCYCLINGFLAG - unitless (flag indicating the cycling status of the well)

## ESP

### Drive

- ESP\_VSD\_HEAT\_SINK\_TEMP - degF
- ESP\_VSD\_BUS\_VOLTAGE - volts
- ESP\_VSD\_CURRENT - amps
- ESP\_VSD\_VOLTAGE - volts

### Motor

- ESP\_MOTOR\_CURRENT - amps
- ESP\_MOTOR\_FREQUENCY - hz
- ESP\_MOTOR\_TEMPERATURE - degF
- ESP\_MOTOR\_VOLTAGE - volts

### Controller

- ESP\_HIGH\_SPEED\_CLAMP - hz
- ESP\_LOW\_SPEED\_CLAMP - hz
- ESP\_CURRENT\_LIMIT - amps
- ESP\_CURRENT\_SETPOINT - amps
- ESP\_CONTROL\_MODE - unitless (1 = Frequency mode, 2 = PID Rate control, 3 = PID Amps control)

### General

- ESP\_INTAKE\_PRESSURE - psig
- ESP\_DISCHARGE\_PRESSURE - psig
- ESP\_FLUID\_TEMPERATURE - degF
- ESP\_RUNTIME - hours (hours of cumulative runtime today)
- ESP\_VIBRATION\_X - g
- ESP\_VIBRATION\_Y - g

## Sucker Rod Pump

- SRP\_POLISHED\_ROD\_LOAD - lb
- SRP\_POLISHED\_ROD\_POSITION - in
- SRP\_PUMP\_FILLAGE - %
- SRP\_PUMP\_INTAKE\_PRESSURE - psig
- SRP\_STROKE\_RATE - strokes/min
- SRP\_RUNTIME - minutes (minutes of cumulative runtime today)

## Plunger

- PLUNGER\_EVENT - unitless (valve open = 0, valve closed = 1, or plunger arrived = 2)

## Deprecated

The following values are still accepted for backwards compatibility but should not be used in new integrations:

- SANDIND
- CONDRATE
- FLOWLINEPRESSURE

***

# Data Integrity Checks

| **Condition**                                 | **Response**                              |
| --------------------------------------------- | ----------------------------------------- |
| sourceWellId does not exist in the Well table | Record Rejected and current batch aborted |
| measurement is not one of the values above    | Record Rejected                           |
| Any non-nullable field is NULL                | Record Rejected                           |

:::hint{type="warning"}
If any record in a POST references an unknown **sourceWellId**, the whole batch is aborted — records earlier in the payload are not committed.
:::

***

# Common Error Messages

| **API**                    | **Scenario**         | **Error Response**                                           |
| -------------------------- | -------------------- | ------------------------------------------------------------ |
| Add / Upsert configuration | Unknown sourceWellId | Well with source id xxx was not found, current batch aborted |