Collect table details
- Last UpdatedApr 24, 2025
- 2 minute read
The records in the collect table are used to configure the collection of data from the analog, rate, remote, and status tables. The system sends the collected data to the Historical database (HDB).
Rather than obtaining access to the collect table information directly, you can also use Microsoft SQL statements (for example, select or delete) or RealTime utilities (for example, dbget and dbput) and registered procedures.
The collect table contains the following internal fields:
|
Internal Field Name |
Data Type |
Description |
|---|---|---|
|
accessFlag |
displayname |
This flag is used by easy eXtended Operator Station (ezXOS) to determine whether a table is being modified through the Advanced Database Editor (ADE). If the flag is set, access to the table is denied. |
|
colBuffer |
collect_buffer |
An array that stores the actual buffer of collect data for a point. |
|
collectPeriod |
period |
Sets the units to use for the time period for interval data. |
|
collectVar |
collect_type |
The type of collection that occurs for this point. |
|
currentMsg |
unsigned char |
The current transfer message number for replication to standby RealTime host(s). |
|
dbpath |
path |
The structure that stores the data path to the point. |
|
deadBand |
double |
The deadband for exception collection. |
|
deleteRec |
oas_boolean_t |
Should the collect record be deleted after it is flushed to Historical? |
|
firstSumXfr |
collect_time |
The last summary row that was sent to standby. |
|
flushCollect |
oas_boolean_t |
Are records ready to be flushed to Historical? |
|
flushHead |
unsigned short |
Index indicating where to start flushing data to Historical. |
|
flushTail |
unsigned short |
Index indicating where to stop flushing data to Historical. |
|
flushOwned |
oas_boolean_t |
Collect transfer to flush owned rows. |
|
flushOwnedTm |
internaltime |
Time of mode switch where ownership was relinquished. |
|
flushUnowned |
oas_boolean_t |
Collect transfer to flush non-owned rows. |
|
flushUnownedTm |
internaltime |
Time of mode switch where ownership was asserted. |
|
isOwned |
oas_boolean_t |
Local system owns this data as of the last known rows. |
|
lastCollect |
collect_time |
The time of the last collection. |
|
lastCollectMil |
short |
Millisecond interval of the last collection. |
|
lastData |
unsigned short |
Index indicating the most recent data. |
|
lastDQFlags |
long |
Data quality flags of the last point collected. |
|
lastStatus |
char |
The status of the last point collected. |
|
lastSummary |
collect_time |
The last hour summarized. |
|
lastSumXfr |
collect_time |
Oldest summary row sent to standby. |
|
lastSumXfrNum |
unsigned short |
The number of rows previously replicated to the standby RealTime host(s). |
|
lastValue |
collect_value |
Last value collected. |
|
numFlush |
unsigned short |
Number of unflushed items in the collect buffer. |
|
numPeriod |
short |
Number of periods between interval data samples. |
|
numSummary |
unsigned short |
Number of items in the summary buffer. |
|
numTrend |
unsigned short |
Number of values that can be used in trending. |
|
numXfr |
unsigned short |
Number of points waiting for replication to the standby RealTime host(s). |
|
ptName |
collect_name |
This field shows the name of this collect point. |
|
ptnum |
unsiged char |
This field represents the record’s slot number in the database. |
|
summarize |
oas_boolean_t |
Should this collect point be summarized? |
|
sumBuffer |
summary_buffer |
Array that stores the actual buffer of summary data. |
|
tagID |
int |
Last known Historical timeline tagID. |
|
trendHead |
unsigned short |
Index indicating the oldest data start. |
|
upldDaySum |
oas_boolean_t |
Collect the uploaded day summary from the device? |
|
xfrHead |
unsigned short |
Index indicating where to start flushing to standby. |