BatchXfer table details
- Last UpdatedApr 24, 2025
- 6 minute read
The batchXfer table is used by the Batch Transfer Management application. The records in the batchXfer table contain configuration and runtime data for location points on a pipeline. The batchXfer table contains the following internal fields:
|
Internal Field Name |
Data Type |
Description |
|---|---|---|
|
act |
corrval |
Actual Gross Standard Volume (GSV) correction values. |
|
active |
oas_boolean_t |
Is the ticket active? |
|
apiVersion |
enum_apiVersion |
Version of the American Petroleum Institute (API) measurement standard to use. |
|
autoInh |
oas_boolean_t |
Is auto-inhibit enabled? |
|
autoInhPath |
path |
The path to the status or multistate record that identifies whether the batchXfer record is inhibited or enabled. |
|
auto_verify |
oas_boolean_t |
Should the Controller be prevented from editing completed tickets? |
|
batchScheduleMgmt |
operationManagementLocation |
How the batch schedule is to be managed. |
|
batchSwitchCriteria |
enum_batchSwitchCriteria |
When the batch needs to be switched. |
|
batchSwitchManualFlag |
oas_boolean_t |
Tickets can only be started after a batch switch? |
|
batchXferTime |
internaltime |
Most current time from source. |
|
bxf_config_error_alm.alminh |
oas_boolean_t |
Inhibit alarming batch transfer configuration errors? |
|
bxf_config_error_alm.evtinh |
oas_boolean_t |
Inhibit logging batch transfer configuration errors? |
|
bxf_gen_alm.alminh |
oas_boolean_t |
Inhibit alarming general batch transfer events? |
|
bxf_gen_alm.evtinh |
oas_boolean_t |
Inhibit logging general batch transfer events? |
|
cmdinh |
oas_boolean_t |
Is the command inhibited? |
|
csw |
double |
Correction for Sediment and Water (CSW). |
|
cswAllmState |
oas_boolean_t |
Is the device in a CSW alarm state? |
|
cswAna.alm.alminh |
oas_boolean_t |
Inhibit alarms associated with the sediment and water information? |
|
cswAna.alm.sev |
sev_enum |
The alarm severity for alarms associated with the sediment and water information. |
|
cswAna.point |
analogslot |
The path to the analog point that supplies the sediment and water information. |
|
cursta |
BatchXferStates |
The current state of the batch transfer record. |
|
dataset |
doas_dset_slot |
This field indicates the dataset to which the record is assigned. Datasets are used to associate the record with the privileges assigned for each system mode. Once a record is assigned to a dataset value, the dataset can only be changed to a value for which the system has a privilege record. |
|
delayedBatchStartTimeout |
int |
An acceptable period of time for the reset of the field device to occur after a new ticket start is attempted. |
|
delayedTicketStartTimestamp |
internaltime |
Timestamp when delayed ticket start requested. |
|
del_dband |
float |
The amount by which the GSV may deviate from the scheduled GSV before an alarm is generated. |
|
del_sz_alm.alminh |
oas_boolean_t |
Inhibit alarms when the difference between a ticket’s scheduled GSV and actual GSV exceeds del_dband? |
|
del_sz_alm.evtinh |
oas_boolean_t |
Inhibit event logging when the difference between a ticket’s scheduled GSV and actual GSV exceeds del_dband? |
|
deltaGSV |
double |
Difference between the current GSV and the previous GSV. |
|
deltaIV |
double |
Difference between the current Indicated Volume (IV) and the previous IV. |
|
description |
description |
A description of this Batch Transfer point, up to 47 characters in length. |
|
enastates |
string80 |
States that enable this meter device. |
|
enforceDupBatchId |
oas_boolean_t |
Allow multiple tickets to have the same Batch ID in the pending schedule? |
|
etime |
datetime |
Actual batch end time (mm/dd/yy hh:mm:ss). |
|
execActionSequence |
oas_boolean_t |
Execute an Action Sequence when a ticket is started? |
|
flag |
flags |
For information on the flag structure, see Flag structure details. |
|
flowrateUnitShort |
string16 |
The short form flow rate units for this record. |
|
FlowSeconds |
unsigned int |
The total flow duration in seconds. |
|
group |
groupslot |
Many records have this field. A group is assigned to all points that are closely related. |
|
GSV |
double |
Gross Standard Volume (GSV). |
|
GSV_Adjustment |
double |
GSV adjustment. |
|
GSV_Intg |
double |
Incremented GSV each hour. This field is reset to zero each hour. |
|
GSV_Intg_Time |
internaltime |
Time of last GSV rollup. |
|
GSflow |
double |
GSV based flow rate. |
|
GV |
double |
Gross Volume (GV). |
|
inh |
oas_boolean_t |
Disable the batchXfer record? |
|
inh_GSV_Intg |
oas_boolean_t |
Inhibit the saving of the hourly GSV count to Historical? |
|
inhstates |
string80 |
This field is used to enter one or more integers separated by commas. Each integer represents a status or multistate value that, if present, designates the batchXfer record as inhibited. |
|
inh_xisTkt |
oas_boolean_t |
Inhibit the sending of completed tickets to Historical? |
|
input |
AssignmentInputStruct |
Batch transfer assignment configuration details. |
|
IntegralValue |
double |
Integral value/average extension. |
|
isActionSequenceRequired |
oas_boolean_t |
Is an action sequence name required to be configured to start the batch? |
|
IV |
double |
Indicated volume. |
|
lastBS |
unsigned char |
Batch switch last status indicator. |
|
LastFlowSeconds |
unsigned int |
Last flow seconds. |
|
LastIntegralValue |
double |
Last integral value. |
|
lastIV |
double |
Last IV. |
|
lastGV |
double |
Last GV. |
|
lastGSV |
double |
Last GSV. |
|
lastMass |
double |
Last mass. |
|
lastticketMass |
double |
Mass of last ticket. |
|
lastproducttype |
prod |
The last product type recorded. |
|
lastTicketBatchGuid |
GUIDstring |
Batch GUID of last ticket. |
|
lastticketBatchID |
batchname |
Batch ID of last ticket. |
|
lastticketGSV |
double |
GSV of last ticket. |
|
lastticketNumber |
string16 |
Ticket number of last ticket. |
|
lastticketWAD |
double |
Weighted Average Density (WAD) of last ticket. |
|
Mass |
double |
Mass in pounds. |
|
min_activetime |
unsigned short |
The amount of time in seconds that a ticket must be active before a new ticket can be started. |
|
min_porder |
unsigned short |
The low limit for pending tickets. |
|
modified |
oas_boolean_t |
Has the ticket been modified? |
|
name |
pntname |
The name of the batchXfer record. |
|
newSchedule_alm.alminh |
oas_boolean_t |
Prevent new alarms from being recorded when there are new batch schedules available for download? |
|
newSchedule_alm.evtinh |
oas_boolean_t |
Prevent new events from being recorded when there are new batch schedules available for download? |
|
NSV |
double |
Net Standard Volume (NSV). |
|
originalGSV |
double |
Original GSV from the source. |
|
pendtkts |
pendschTicketArr |
An array of the pending schedule viewable by Controller. |
|
ppltask |
enum_ppltask |
The role that the batchXfer record plays for the batch tracking pipeline. |
|
pointClass |
configenumslot |
The point class category contains multiple configuration enumerations used for categorical configuration of points. |
|
pointSubClass |
configenumslot |
The point subclass category is a configurable enumeration category used for categorical configurations. It cannot be used for configurable alarms and events. |
|
pq_low_alm.alminh |
oas_boolean_t |
Disable alarming when the min_porder threshold is crossed? |
|
pq_low_alm.evtinh |
oas_boolean_t |
Disable event logging when the min_porder threshold is crossed? |
|
processingDelayedTicketStart |
oas_boolean_t |
Is the batch transfer in the process waiting for a manual batch switch reset? |
|
prodtype |
prodtypeslot |
Product type. |
|
productMismatchInhs.alminh |
oas_boolean_t |
Inhibit alarms associated with an instance of a product mismatch? |
|
productMismatchInhs.evtinh |
oas_boolean_t |
Inhibit event logging when there is an instance of a product mismatch? |
|
ptype_dband |
float |
Volume deadband for Product Transfer Checking. |
|
ptnum |
slot |
The slot number of the point in the database. |
|
remoteCommands |
oas_boolean_t |
Should ticket start/stop/split commands be execute by the remote flow computer? |
|
remoteSchedArgs |
string64 |
Extra plug-in configuration. |
|
remoteSchedPull |
oas_boolean_t |
Should tickets be pulled from a remote source into the database? |
|
remoteSchedPush |
oas_boolean_t |
Should tickets be pushed to a remote location? |
|
remoteSchedType |
enum_batchXferRemSched |
The plug-in type for remote schedules. |
|
remoteTktCtrl |
oas_boolean_t |
Transfer control of the batching data to a flow computer based at a remote site? |
|
remtkt |
oas_boolean_t |
Is this a remote ticket? |
|
rev |
oas_boolean_t |
Is this a reversal ticket? |
|
saveZeroVolTkt |
oas_boolean_t |
Allow a ticket that completed with no metered volume to be saved? |
|
sch |
pendsched |
The current active ticket (pulled from the top of the pending tickets schedule). |
|
schSource |
string64 |
Where to load pending schedules. |
|
schedule_ticket_id |
int |
The schedule sequence number. |
|
starttimeadj |
oas_boolean_t |
Set a batch's start time to the time the flow is initially indicated? |
|
stime |
datetime |
Actual batch start time (mm/dd/yy hh:mm:ss). |
|
stime_gmt |
internaltime |
Actual batch start time (Greenwich Mean Time). |
|
sulpctslot |
analogslot |
Analog point for sulphur percent. |
|
switchCleared |
oas_boolean_t |
Has the batch switch left its deadband? |
|
switchDeadBand |
float |
The value that triggers the batch switch to start a new ticket. |
|
switchsts |
path |
The path to the point that will dictate when a Batch Switch occurs. |
|
ticketno |
string16 |
Ticket number (A letter is appended for split tickets). |
|
Topof.day |
short |
The hour at which to cut or start a ticket for the preceding contract day or business day. |
|
Topof.day_action |
bat_action |
The type of ticket action to be performed by Batch Transfer at the top of day. |
|
Topof.dayinh |
oas_boolean_t |
Inhibit Topof.day_action from being performed at the top of day? |
|
Topof.month |
unsigned char |
The day on which to cut or start a ticket for the preceding contract day or business day. |
|
Topof.month_action |
bat_action |
The type of ticket action to be performed by Batch Transfer at the top of the month. |
|
Topof.monthinh |
oas_boolean_t |
Inhibit Topof.month_action from being performed at the top of the month? |
|
Topof.week |
weekday |
The day of the week on which to cut or start a ticket for the preceding week. |
|
Topof.week_action |
bat_action |
The type of ticket action to be performed by Batch Transfer at the top of the week. |
|
Topof.weekinh |
oas_boolean_t |
Inhibit Topof.week_action from being performed at the top of the week? |
|
totalGSV |
double |
Total GSV. |
|
tracking.cpl_inh.alminh |
oas_boolean_t |
Inhibit alarms when a ticket is completed? |
|
tracking.cpl_inh.evtinh |
oas_boolean_t |
Inhibit event logging when a ticket is completed? |
|
tracking.vol_inh.alminh |
oas_boolean_t |
Inhibit alarms when tracking.warnVol is reached? |
|
tracking.vol_inh.evtinh |
oas_boolean_t |
Inhibit event logging when tracking.warnVol is reached? |
|
tracking.warnTime1 |
string10 |
The time at which you would like the first warning to be issued. |
|
tracking.warnTime2 |
string10 |
The time at which you would like the second warning to be issued. |
|
tracking.warnVol |
float |
The volume after which an alarm and event will be triggered. |
|
tracking.wt1_inh.alminh |
oas_boolean_t |
Inhibit alarms when tracking.warnTime1 is reached? |
|
tracking.wt1_inh.evtinh |
oas_boolean_t |
Inhibit event logging when tracking.warnTime1 is reached? |
|
tracking.wt2_inh.alminh |
oas_boolean_t |
Inhibit alarms when tracking.warnTime2 is reached? |
|
tracking.wt2_inh.evtinh |
oas_boolean_t |
Inhibit event logging when tracking.warnTime2 is reached? |
|
unitprofile |
unitprofileslot |
The units in which the batch transfer information is displayed. |
|
useAutoInh |
oas_boolean_t |
Enable the use of the status or multistate record configured in autoInhPath? |
|
verified |
oas_boolean_t |
Has the ticket been verified? |
|
vol_dband |
float |
The minimum volume that needs to flow on the active ticket before a new ticket can be started. |
|
viscslot |
analogslot |
Analog point for viscosity. |
|
wa |
waval |
Weighted average GSV correction values. |
|
zerotktsplit |
oas_boolean_t |
Allow the Batch Transfer application to split tickets with zero volume? |