1/6/26, 5:01 PM POPScriptQuickReference.

html

Procedural Object Programming (POP) Script Quick Reference Guide

The purpose of this document is to provide a syntax reference for POP scripts. It is assumed the user is
familiar with the basic usage and structure of the scripting engine.

Environment:
CLI

Declarable Objects:
ALIAS ALLOCCALC ALLOCCFG ALMSVR ALMTAGCFG ARRAY BINARY

BOOL CALCCFG CONVERSION DBCONNECTION DBDIR DBFILE DBLOG

DBQUERY DBRECORD DBTAGLIST DBXLS DEFINE DIR ECMTIME

EFMALARM EFMEVENT FILE FLOAT FORMULACFG HEXSTR HOURLYHRP

HRPITEM HTTPCLIENT IMPORTMETER INT LIQUIDCOR MAILBOX MAILCLIENT

MAILMESSAGE MAILSENDER MEDIA MENUSERVER METERITEM MQTT NETWORK

OPCITEM OPCSERVER PDFAXIS PDFFILE PDFHEADERBOX PDFHEADERSECTION PDFLINECHART

PDFTABLE PDFTEXTBOX PORTCFG PROVECFG PROVEEPISODE PROVEMANAGER RECALC

ROLECFG RPTCFG RTDBITEM SCHEDCFG SERPORT SIGNAL SNMPSESSION

STACK STATION STEXT STRING SVALUE TICKET USERTAGCFG

VAPORPRES VARIANT WELLTEST XLS

Environment

[CLI] Top

CLI Environment. Useful commands and settings

Settings:
Name Description Default Value
WATCHDOG
Number of milliseconds the a script can take to
TIMEOUT 60000
complete <ms>
DBGLVL debug level for objects 3
ISDEBUG sets debug mode False
ECHO False
LOCAL sets local Echo mode False
DEBUG echo console output to debug False
SUPERDEBUG sets super debug mode (not for the faint of heart) False
DECIMALPLACES Number of decimal places in output 2
SCRIPT
ABORTONERROR when true, script will abort if parse returns an error True
line of script where parse error occured and script was
ABORTLINE 0
aborted
LASTRC return code from last script False
WATCHDOG watchdog flag from last script False
DIR script directory to use if not fully qualified D:\Tinbox\Apps\MBCSTest\imsPOPScripts\

[Link] 1/139
1/6/26, 5:01 PM [Link]
FILE Current script file
LINE Current Line 0
IPADDRESS IPAddress of requester
LAST
Number of milliseconds from the last start and stop of
TIMER 0
the timer
INPUT Last input from a WAIT or INPUT
RUN
FILE Last script file run
DIR Last script file dir
VERSION version of [Link] 2.8.1.5087
SQL
DBTYPE
Returns History Database type
HIST MSSQL
(MSSQL,MARIADB,FIREFIRD)
Returns Config Database type
CFG FIREBIRD
(MSSQL,MARIADB,FIREFIRD)
RTDB
EXIST
RC Return code 0
CFG
IMSVALUE
RC Return code 0
INSTALLPATH Installation Directory D:\Tinbox\Welltrak\
VALUE User Declared String D:\Tinbox\Welltrak\
COUNT Number of Parts of the string 0
INCLUDEEMPTY Include Empty parts when splitting True
LENGTH Length of the string 19
RC Return Code from last operation True
APPPATH Application Directory D:\Tinbox\Apps\MBCSTest\
VALUE User Declared String D:\Tinbox\Apps\MBCSTest\
COUNT Number of Parts of the string 0
INCLUDEEMPTY Include Empty parts when splitting True
LENGTH Length of the string 24
RC Return Code from last operation True

Commands:
Name Description
RENAME Rename an object <new name>,<old name>
BEEP beep the speaker <freq_Hz> <duration_ms>
DUMP
SHOW Dumps Show in CSV format
HELP Dumps Help in CSV format
TYPES Dumps object types to console
OBJECTS Dumps object list to console <objectName>
FLAGS Dumps flags for <objectName>
DESC Dumps the description of <objName>
CONNECTIONS Dumps Signal Connections and puts count on stack
PARSE
FLAGS Dumps Parsing Flags and puts size on stack
LOAD Reads the config from CALC.s
WRITE Writes the config to CALC.s
RAND Puts Random number on stack (<min> <max>)
[Link] 2/139
1/6/26, 5:01 PM [Link]
FRAND Puts double Random number on stack (<min> <max>)
ROUND Puts Rounded number on stack <value> <decimalPlaces>
CONNECT
RUN
ONDATACHANGE runs script when OnDataChange signal fires <FileName> <SignalingObjectName>
ONEXECUTE runs script when Execute signal fires <FileName> <SignalingObjectName>
ONERROR runs script when OnError signal fires <FileName> (<spawn=1>)
ONWARNING runs script when OnWarning signal fires <FileName> (<spawn=1>)
INLINE
ONDATACHANGE runs commands when OnDataChange signal fires <numStackItems> <SignalingObjectName>
ONEXECUTE runs commands when Execute signal fires <numStackItems> <SignalingObjectName>
DISCONNECT
ALL Disconnect all signals
OBJECT Disconnect all signals for <SignalingObjectName>
BLOCK
ALL Block all signals
OBJECT Disconnect all signals for <SignalingObjectName>
UNBLOCK
ALL Block all signals
OBJECT Disconnect all signals for <SignalingObjectName>
DEBUG Print specified remark to debug, output settings with %setting%
CLR Clear Screen
REMARK Print specified remark on the console, output settings with %setting%
SLEEP Sleep for the <miliseconds>
TIMER Timer (ticks) functions
START Start the Timer
STOP Calc delta since START, goes on stack
WAIT pauses until key hit, optional char arg for abort key
WATCHDOG
RESET Resets the watchdog, call only if needed for long running scripts
INPUT takes input until enter is pressed, then put on stack
SPAWN Same as run but in a new menu
SYSTEM executes system <command string>
EXISTS check if <objName> exists, puts 1 or 0 on stack
GETTYPE put declaration type on stack for <objName>
HIDE Hides <setting or command>
UNHIDE Hides <setting or command>
SQL
CMD Executes SQL command on HIst DB return code on stack
CFGCMD Executes SQL command on Cfg DB return code on stack
EXISTS Checks if <table> (<Col>) exists in HIst DB return code on stack
CFGEXISTS Checks if <table> (<Col>) exists in Cfg DB return code on stack
RTDB
READ Read Tag <name> put value on stack
WRITE Write Tag <name> <value>
ADD Add RTDB Tag <Tag_Name> (<isReset 0|1 default is 0> (<default_Val>))
EXISTS Check existance of <Tag_Name>
ISBASEMODEL Check if <ObjName> is a BaseModel, puts 0 or 1 on stack
ISBASERECORD Check if <ObjName> is a BaseRecord, puts 0 or 1 on stack
BACKUP
CFG Backup of cfgDB result on stack (<fileName>)
CFG

[Link] 3/139
1/6/26, 5:01 PM [Link]
IMSVALUE
GET Get value from TBLIMSVALUES by <name> onto stack
SET <name> <value> puts 0 or 1 on stack
ADD Add TBLIMSVALUES Entry by <name> <value>
Compares two DBRecords <obj1> <obj2> (NOTE. This will fetch and modify content of both
DIFF
models)
INSTALLPATH Installation Directory
SPLIT split into parts based upon <token>
PART part the string into parts of <length>
MAKE Remake from modified parts (<token>)
CLENSE Clense of all bad characters (<allowable_chars>)
DELETE Delete part of a string by <PartNumber>
CONTAINS Check if the string contains <token> (result in RC and on stack)
STARTSWITH Check if the string starts with <token> (result in RC and on stack)
ENDSWITH Check if the string ends with <token> (result in RC and on stack)
REPLACE Replace <token1> with <token2>
SUBSTR Puts sub string on stack <startPos> <endPos>
FIND Puts position of substring on stack <startPos> <tok>
AT Puts character at <startPos> on stack
RESIZE Resize string truncating to new <length>
REMOVE Remove # of chars from beginning <number>
APPEND
CHAR append character ie(\n \t 0x0d 0x0a)
TRIM Trim <char> from ends (case sensitive)
ISNUMBER Is it a number (result in RC and on stack)
ISDECIMAL does string have decimals (result in RC and on stack)
ISTIMESTAMP Is it a timestamp (result in RC and on stack)
TOUPPER To upper case
TOLOWER To lower case
APPPATH Application Directory
SPLIT split into parts based upon <token>
PART part the string into parts of <length>
MAKE Remake from modified parts (<token>)
CLENSE Clense of all bad characters (<allowable_chars>)
DELETE Delete part of a string by <PartNumber>
CONTAINS Check if the string contains <token> (result in RC and on stack)
STARTSWITH Check if the string starts with <token> (result in RC and on stack)
ENDSWITH Check if the string ends with <token> (result in RC and on stack)
REPLACE Replace <token1> with <token2>
SUBSTR Puts sub string on stack <startPos> <endPos>
FIND Puts position of substring on stack <startPos> <tok>
AT Puts character at <startPos> on stack
RESIZE Resize string truncating to new <length>
REMOVE Remove # of chars from beginning <number>
APPEND
CHAR append character ie(\n \t 0x0d 0x0a)
TRIM Trim <char> from ends (case sensitive)
ISNUMBER Is it a number (result in RC and on stack)
ISDECIMAL does string have decimals (result in RC and on stack)
ISTIMESTAMP Is it a timestamp (result in RC and on stack)
TOUPPER To upper case
TOLOWER To lower case

[Link] 4/139
1/6/26, 5:01 PM [Link]
PARSE
STATIONID puts station root and run as stack 0 and 1 <StationId>

Remarks:
The CLI CONNECT commands are intended for use with scripts run from a web user view.
There are three signals that can be connected.
The ONDATACHNANGE signal is emitted when the object in question has a value change.
The ONEXECUTE signal is emitted when the object in question is executed (eg. DBRECORD
EXECUTE)
There are two ways of running the script from the signal. The RUN causes a script file to be loaded
and run. The INLINE allows for a series of lines of script to be pushed onto the stack and used.
when the command CLI CONNECT INLINE ONDATACHANGE is run, the number of items on the
stack specified
will be copied aside so that they will be run when the signal occurs.
The SignallingObjectName refers to the object which emits the signal.
eg1. The following causes the myscript.s (assumed to be in the imsPOPScripts directory to be run
hen the object mydbrecord has a value change
CLI CONNECT RUN ONDATACHANGE myscript.s mydbrecord

eg2. The following causes prints two messages to debug whenever the object mydbrecord has a value
change
STACK PUSH CLI DEBUG Hi There
STACK PUSH CLI DEBUG Another Message
CLI CONNECT INLINE ONDATACHANGE 2 mydbrecord

There is another signal that can be connected it is the ONERROR signal.

The ONERROR signal is emitted when a script has an error statement or an abort is called.
The particulars of the error are passed to the script as parameters:
Arg1 - File Name of script with error in it (may be blank if in-line script run in a web View)
Arg2 - Directory location of the file
Arg3 - Return Code form the execution (always 0 at this time)
Arg4 - Line number in the file which caused the error
Arg5 - Watchdog Code form the execution (1 if the error was caused by watchdog or 0 if not)
(The particulars of the error are also always printed out to debug even if no Error Handler script is
connected)
myfile writeline
There is another signal that can be connected it is the ONWARNING signal.
The ONWARNING signal is emitted when the parser finds a command or setting with suspicious syntax
The particulars of the warning are passed to the script as parameters:
Arg1 - File Name of script with error in it (may be blank if in-line script run in a web View)
Arg2 - Directory location of the file
Arg3 - Line number in the file which caused the error
(The particulars of the warning are also always printed out to debug even if no Warning Handler script is
connected)
myfile writeline
[END]

Objects

[ALLOCCALC] Top

Allocations Calc Object

Settings:
[Link] 5/139
1/6/26, 5:01 PM [Link]

Default
Name Description
Value
TYPE Allocation Type (Proration | Volume | FirmService) Proration
USEHRP Uses HRP as DataSource ignoring tag <0|1> False
COMPOUNDINLETPRORATION Compounds proration factor when inlet flow to another <0|1> True
Use raw volume else shrunk vol for children total when computing
USERAWTOTALINLETPRORATION True
inlets proration factor <0|1>
SUGGESTEDVOL
WITHSHRINKAGE Displays suggested volume with shrinkage <0|1> False
USERNAME User Name SYSTEM
VALUE User Declared String SYSTEM
COUNT Number of Parts of the string 0
INCLUDEEMPTY Include Empty parts when splitting True
LENGTH Length of the string 6
RC Return Code from last operation True
COMMENT Allocations Save Comment
VALUE User Declared String
COUNT Number of Parts of the string 0
INCLUDEEMPTY Include Empty parts when splitting True
LENGTH Length of the string 0
RC Return Code from last operation True
AUTOCLEAR
EPISODE Auto clear episode on calc True
SALES Allocations Sale Data Access Object
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 17
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
Enable/Disable encryption for columns when setting data depending on
SETASENCRYPTED True
schema
Enable/Disable encryption for columns when getting data depending
GETASENCRYPTED True
on schema
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
[Link] 6/139
1/6/26, 5:01 PM [Link]
ALLOW
ROLLBACK Allow rollback of unsaved changes True
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
INLETS Allocations Inlet Data Access Object
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 18
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
Enable/Disable encryption for columns when setting data depending on
SETASENCRYPTED True
schema
Enable/Disable encryption for columns when getting data depending
GETASENCRYPTED True
on schema
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes True
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
WELLS Allocations Well Data Access Object
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 16
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False

[Link] 7/139
1/6/26, 5:01 PM [Link]
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
Enable/Disable encryption for columns when setting data depending on
SETASENCRYPTED True
schema
Enable/Disable encryption for columns when getting data depending
GETASENCRYPTED True
on schema
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
COMPANIES Allocations Company Data Access Object
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 7
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
Enable/Disable encryption for columns when setting data depending on
SETASENCRYPTED True
schema
Enable/Disable encryption for columns when getting data depending
GETASENCRYPTED True
on schema
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0

[Link] 8/139
1/6/26, 5:01 PM [Link]
ALLOW
ROLLBACK Allow rollback of unsaved changes True
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
CONTRACTS Allocations Contract Data Access Object
QUERY database query
DBSTYLE <HIST|CFG> CFG
DBTYPE <HIST|CFG> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
SELECTED
ROW Currently selected row (base 0) -1
ALLOW
ROLLBACK Allow rollback of unsaved changes False
MAX
ROWS Maximum Rows allowed in fetch 100000
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
COMPANYWELLS
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 10
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
Enable/Disable encryption for columns when setting data depending on
SETASENCRYPTED True
schema
Enable/Disable encryption for columns when getting data depending
GETASENCRYPTED True
on schema
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0

[Link] 9/139
1/6/26, 5:01 PM [Link]
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
LOG
DBSTYLE <AUTO|HIST|CFG> HIST
DBTYPE <MSSQL|MARIADB|FIREBIRD> MSSQL
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 8
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
Enable/Disable encryption for columns when setting data depending on
SETASENCRYPTED True
schema
Enable/Disable encryption for columns when getting data depending
GETASENCRYPTED True
on schema
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
EPISODE
DBSTYLE <AUTO|HIST|CFG> HIST
DBTYPE <MSSQL|MARIADB|FIREBIRD> MSSQL
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 12
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False

[Link] 10/139
1/6/26, 5:01 PM [Link]
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
Enable/Disable encryption for columns when setting data depending on
SETASENCRYPTED True
schema
Enable/Disable encryption for columns when getting data depending
GETASENCRYPTED True
on schema
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
ERRORS
DBSTYLE <AUTO|HIST|CFG> AUTO
DBTYPE <MSSQL|MARIADB|FIREBIRD>
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 4
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
Enable/Disable encryption for columns when setting data depending on
SETASENCRYPTED True
schema
Enable/Disable encryption for columns when getting data depending
GETASENCRYPTED True
on schema
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
[Link] 11/139
1/6/26, 5:01 PM [Link]
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True

Commands:
Name Description
CALC Runs Allocations using provided date and type
FETCH Fetch
CLEAR Clear
SAVE Saves Allocations results, including log and episode
RESETDATA Clears working values from models
USERNAME User Name
SPLIT split into parts based upon <token>
PART part the string into parts of <length>
MAKE Remake from modified parts (<token>)
CLENSE Clense of all bad characters (<allowable_chars>)
DELETE Delete part of a string by <PartNumber>
CONTAINS Check if the string contains <token> (result in RC and on stack)
STARTSWITH Check if the string starts with <token> (result in RC and on stack)
ENDSWITH Check if the string ends with <token> (result in RC and on stack)
REPLACE Replace <token1> with <token2>
SUBSTR Puts sub string on stack <startPos> <endPos>
FIND Puts position of substring on stack <startPos> <tok>
AT Puts character at <startPos> on stack
RESIZE Resize string truncating to new <length>
REMOVE Remove # of chars from beginning <number>
APPEND
CHAR append character ie(\n \t 0x0d 0x0a)
TRIM Trim <char> from ends (case sensitive)
ISNUMBER Is it a number (result in RC and on stack)
ISDECIMAL does string have decimals (result in RC and on stack)
ISTIMESTAMP Is it a timestamp (result in RC and on stack)
TOUPPER To upper case
TOLOWER To lower case
COMMENT Allocations Save Comment
SPLIT split into parts based upon <token>
PART part the string into parts of <length>
MAKE Remake from modified parts (<token>)
CLENSE Clense of all bad characters (<allowable_chars>)
DELETE Delete part of a string by <PartNumber>
CONTAINS Check if the string contains <token> (result in RC and on stack)
STARTSWITH Check if the string starts with <token> (result in RC and on stack)
ENDSWITH Check if the string ends with <token> (result in RC and on stack)
REPLACE Replace <token1> with <token2>
SUBSTR Puts sub string on stack <startPos> <endPos>
FIND Puts position of substring on stack <startPos> <tok>
AT Puts character at <startPos> on stack

[Link] 12/139
1/6/26, 5:01 PM [Link]
RESIZE Resize string truncating to new <length>
REMOVE Remove # of chars from beginning <number>
APPEND
CHAR append character ie(\n \t 0x0d 0x0a)
TRIM Trim <char> from ends (case sensitive)
ISNUMBER Is it a number (result in RC and on stack)
ISDECIMAL does string have decimals (result in RC and on stack)
ISTIMESTAMP Is it a timestamp (result in RC and on stack)
TOUPPER To upper case
TOLOWER To lower case
SALES Allocations Sale Data Access Object
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT

[Link] 13/139
1/6/26, 5:01 PM [Link]
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
INLETS Allocations Inlet Data Access Object
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
[Link] 14/139
1/6/26, 5:01 PM [Link]
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
WELLS Allocations Well Data Access Object
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
[Link] 15/139
1/6/26, 5:01 PM [Link]
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
COMPANIES Allocations Company Data Access Object
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
[Link] 16/139
1/6/26, 5:01 PM [Link]
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
CONTRACTS Allocations Contract Data Access Object
ADD
ROW Adds a row to then end with defaults and loads the record
ALIAS <colName> <colAlias>
EXECUTE Executes the query
SAVE Saves any changes to the database
HIDE
COL Hide <colName> from view
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch lastt row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
TOSTRING Put current record into <string obj>
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
COMPANYWELLS
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model

[Link] 17/139
1/6/26, 5:01 PM [Link]
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
BY
COMPANY fetch by associated to <CompanyId>
INLET fetch by associated to <InletId>
LIKENAME fetch by Like StationID/Name <key>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
LOG
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
[Link] 18/139
1/6/26, 5:01 PM [Link]
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
EPISODE
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
[Link] 19/139
1/6/26, 5:01 PM [Link]
COL Remove <colName> from the query
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
ERRORS
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
[Link] 20/139
1/6/26, 5:01 PM [Link]
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)

[END]

[ALLOCCFG] Top

This is a data access class for interfacing with Allocations configuration.

Settings:
Name Description Default Value
METER AllocCfgStn Object
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>

[Link] 21/139
1/6/26, 5:01 PM [Link]
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 12
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
WELL AllocCfgStn Object
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 12
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0

[Link] 22/139
1/6/26, 5:01 PM [Link]
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
INLET AllocCfgStn Object
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 12
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
SALES AllocCfgStn Object
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 12
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False

[Link] 23/139
1/6/26, 5:01 PM [Link]
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
CONTRACT
IN Alloc Contract Object
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 6
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG

[Link] 24/139
1/6/26, 5:01 PM [Link]
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
WITOTAL WI Total 0.00
OUT Alloc Contract Object
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 6
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
WITOTAL WI Total 0.00
COMPANY Alloc Conncract Object
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 4
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True

[Link] 25/139
1/6/26, 5:01 PM [Link]
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
LIMIT
TREE Limit Tree fetch True
TOOLTIP
ISTAG ToolTip is Tag True
AUTOSYNC
GROUPS Keep wells Synced into inlet groups True
NAMES Keep names in sync with Station Names True
GROUP Group Selection Model
QUERY database query
DBSTYLE <HIST|CFG> CFG
DBTYPE <HIST|CFG> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
SELECTED
ROW Currently selected row (base 0) -1
ALLOW
ROLLBACK Allow rollback of unsaved changes False
MAX
ROWS Maximum Rows allowed in fetch 100000
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
STATION Station Selection Model
QUERY database query
DBSTYLE <HIST|CFG> CFG

[Link] 26/139
1/6/26, 5:01 PM [Link]
DBTYPE <HIST|CFG> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
SELECTED
ROW Currently selected row (base 0) -1
ALLOW
ROLLBACK Allow rollback of unsaved changes False
MAX
ROWS Maximum Rows allowed in fetch 100000
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True

Commands:
Name Description
METER AllocCfgStn Object
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading

[Link] 27/139
1/6/26, 5:01 PM [Link]
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
BY
TYPE <WELL | INLET | SALES>
STATIONID <StationId>
COMPANY <CompanyId>
CONTRACT <ContractId>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc
COLLABEL
<ColNum> (<obj>)
CHECK
RECURSION <StationId> rc=1 is ok
WELL AllocCfgStn Object
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
[Link] 28/139
1/6/26, 5:01 PM [Link]
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
BY
TYPE <WELL | INLET | SALES>
STATIONID <StationId>
COMPANY <CompanyId>
CONTRACT <ContractId>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc
COLLABEL
<ColNum> (<obj>)
INLET AllocCfgStn Object
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
[Link] 29/139
1/6/26, 5:01 PM [Link]
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
BY
TYPE <WELL | INLET | SALES>
STATIONID <StationId>
COMPANY <CompanyId>
CONTRACT <ContractId>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc
COLLABEL
<ColNum> (<obj>)
SALES AllocCfgStn Object
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
[Link] 30/139
1/6/26, 5:01 PM [Link]
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
BY
TYPE <WELL | INLET | SALES>
STATIONID <StationId>
COMPANY <CompanyId>
CONTRACT <ContractId>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc
COLLABEL
<ColNum> (<obj>)
CONTRACT
IN Alloc Contract Object
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
[Link] 31/139
1/6/26, 5:01 PM [Link]
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
BY
COMPANY fetch by associated to <CompanyId>
STATION fetch by associated to <StationId>
CONTRACT fetch by <ContractId>
NOTSTATION fetch by No associated to <StationId>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc
COLLABEL
<ColNum> (<obj>)
OUT Alloc Contract Object
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
[Link] 32/139
1/6/26, 5:01 PM [Link]
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
BY
COMPANY fetch by associated to <CompanyId>
STATION fetch by associated to <StationId>
CONTRACT fetch by <ContractId>
NOTSTATION fetch by No associated to <StationId>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc
COLLABEL
<ColNum> (<obj>)
COMPANY Alloc Conncract Object
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>

[Link] 33/139
1/6/26, 5:01 PM [Link]
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
BY
COMPANY fetch by <CompanyId>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc
COLLABEL
<ColNum> (<obj>)
SYNC
NAMES Sync names from Station Names
FETCH
[Link] 34/139
1/6/26, 5:01 PM [Link]
TREE
BY
STATIONID (<StationId>)
CONTRACTID <ContractId>
COMPANYID <CompanyId>
GROUP Group Selection Model
ADD
ROW Adds a row to then end with defaults and loads the record
ALIAS <colName> <colAlias>
EXECUTE Executes the query
SAVE Saves any changes to the database
HIDE
COL Hide <colName> from view
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch lastt row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
INLET Fetch groups that are inlets
PICKER
BY
WELL Fetch Group and station picker by Well <StnId>
TOSTRING Put current record into <string obj>
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc
COLLABEL
<ColNum> (<obj>)
STATION Station Selection Model
ADD
ROW Adds a row to then end with defaults and loads the record
ALIAS <colName> <colAlias>
EXECUTE Executes the query
SAVE Saves any changes to the database
HIDE
COL Hide <colName> from view
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model

[Link] 35/139
1/6/26, 5:01 PM [Link]
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch lastt row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
WELLS
BY
DEST Fetch Wells by <DestStnId>
UNUSED
STATIONS Fetch unused stations (<IncludeStnId>)
AVAILABLE
DESTINATIONS Fetch inlets and sales points (<ExcludeStnId> <SelectStnId>)
INLETS Fetch inlets (<ExcludeStnId> <SelectStnId>)
TOSTRING Put current record into <string obj>
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc
COLLABEL
<ColNum> (<obj>)

[END]

[ALMSVR] Top

Settings:
Name Description Default Value
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 10
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True

[Link] 36/139
1/6/26, 5:01 PM [Link]
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True

Commands:
Name Description
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0> <default>
COL
<label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT

[Link] 37/139
1/6/26, 5:01 PM [Link]
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)

[END]

[ALMTAGCFG] Top

Settings:
Name Description Default Value
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 10
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000

[Link] 38/139
1/6/26, 5:01 PM [Link]
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True

Commands:
Name Description
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0> <default>
COL
<label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>

[Link] 39/139
1/6/26, 5:01 PM [Link]
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)

[END]

[ARRAY] Top

Array object that can contain other objects.

Multi-dimensional arrays can be made by adding other array objects to it.
Arrays may be cloned. eg: set =
Settings:
Name Description Default Value
SIZE # of elements in array 0

Commands:
Name Description
ADD
DEFINE Add element <ChildLeafName>
ALIAS Add element <ChildLeafName>
BOOL Add element <ChildLeafName>
INT Add element <ChildLeafName>
FLOAT Add element <ChildLeafName>
BINARY Add element <ChildLeafName>
VARIANT Add element <ChildLeafName>
ARRAY Add element <ChildLeafName>
STRING Add element <ChildLeafName>
FILE Add element <ChildLeafName>
STACK Add element <ChildLeafName>
ECMTIME Add element <ChildLeafName>
SIGNAL Add element <ChildLeafName>
MAILMESSAGE Add element <ChildLeafName>
MAILSENDER Add element <ChildLeafName>
MAILCLIENT Add element <ChildLeafName>
XLS Add element <ChildLeafName>
DIR Add element <ChildLeafName>
CONVERSION Add element <ChildLeafName>
HTTPCLIENT Add element <ChildLeafName>
SNMPSESSION Add element <ChildLeafName>
NETWORK Add element <ChildLeafName>
MAILBOX Add element <ChildLeafName>
DBQUERY Add element <ChildLeafName>
DBRECORD Add element <ChildLeafName>
DBFILE Add element <ChildLeafName>
DBDIR Add element <ChildLeafName>

[Link] 40/139
1/6/26, 5:01 PM [Link]
DBXLS Add element <ChildLeafName>
DBTAGLIST Add element <ChildLeafName>
OPCITEM Add element <ChildLeafName>
OPCSERVER Add element <ChildLeafName>
MENUSERVER Add element <ChildLeafName>
RTDBITEM Add element <ChildLeafName>
PORTCFG Add element <ChildLeafName>
CALCCFG Add element <ChildLeafName>
SCHEDCFG Add element <ChildLeafName>
FORMULACFG Add element <ChildLeafName>
ROLECFG Add element <ChildLeafName>
USERTAGCFG Add element <ChildLeafName>
PDFFILE Add element <ChildLeafName>
PDFTEXTBOX Add element <ChildLeafName>
PDFHEADERBOX Add element <ChildLeafName>
PDFHEADERSECTION Add element <ChildLeafName>
PDFAXIS Add element <ChildLeafName>
PDFLINECHART Add element <ChildLeafName>
PDFTABLE Add element <ChildLeafName>
ALLOCCFG Add element <ChildLeafName>
MQTT Add element <ChildLeafName>
STEXT Add element <ChildLeafName>
SVALUE Add element <ChildLeafName>
DBCONNECTION Add element <ChildLeafName>
ALMTAGCFG Add element <ChildLeafName>
ALMSVR Add element <ChildLeafName>
DBLOG Add element <ChildLeafName>
CALCARG Add element <ChildLeafName>
CALCTRIC Add element <ChildLeafName>
HRPCFG Add element <ChildLeafName>
RTUCFG Add element <ChildLeafName>
TACFG Add element <ChildLeafName>
ITEMCFG Add element <ChildLeafName>
METAITEMCFG Add element <ChildLeafName>
MOTSCHEMA Add element <ChildLeafName>
MOTTABLE Add element <ChildLeafName>
MOTCOLUMN Add element <ChildLeafName>
USERDATACFG Add element <ChildLeafName>
ROLEACCESS Add element <ChildLeafName>
USERROLE Add element <ChildLeafName>
USERSCHEMA Add element <ChildLeafName>
USERCOLUMN Add element <ChildLeafName>
AUTHLICENSE Add element <ChildLeafName>
WEBAUTH Add element <ChildLeafName>
LIQUIDCOR Add element <ChildLeafName>
VAPORPRES Add element <ChildLeafName>
METERITEM Add element <ChildLeafName>
TICKET Add element <ChildLeafName>
PROVECFG Add element <ChildLeafName>
PROVEEPISODE Add element <ChildLeafName>
PROVEMANAGER Add element <ChildLeafName>
HRPITEM Add element <ChildLeafName>

[Link] 41/139
1/6/26, 5:01 PM [Link]
EFMEVENT Add element <ChildLeafName>
EFMALARM Add element <ChildLeafName>
HOURLYHRP Add element <ChildLeafName>
STATION Add element <ChildLeafName>
RECALC Add element <ChildLeafName>
IMPORTMETER Add element <ChildLeafName>
WELLTEST Add element <ChildLeafName>
ALLOCCALC Add element <ChildLeafName>
MEDIA Add element <ChildLeafName>
SERPORT Add element <ChildLeafName>
HEXSTR Add element <ChildLeafName>
PROVERUNS Add element <ChildLeafName>
RPTCFG Add element <ChildLeafName>

[END]

[BINARY] Top

Settings:
Name Description Default Value
VALUE User Declared Bit Accessible Integer 0
BIT0 User Declared Bit False
BIT1 User Declared Bit False
BIT2 User Declared Bit False
BIT3 User Declared Bit False
BIT4 User Declared Bit False
BIT5 User Declared Bit False
BIT6 User Declared Bit False
BIT7 User Declared Bit False
BIT8 User Declared Bit False
BIT9 User Declared Bit False
BIT10 User Declared Bit False
BIT11 User Declared Bit False
BIT12 User Declared Bit False
BIT13 User Declared Bit False
BIT14 User Declared Bit False
BIT15 User Declared Bit False
BIT16 User Declared Bit False
BIT17 User Declared Bit False
BIT18 User Declared Bit False
BIT19 User Declared Bit False
BIT20 User Declared Bit False
BIT21 User Declared Bit False
BIT22 User Declared Bit False
BIT23 User Declared Bit False
BIT24 User Declared Bit False
BIT25 User Declared Bit False
BIT26 User Declared Bit False
BIT27 User Declared Bit False
BIT28 User Declared Bit False
BIT29 User Declared Bit False
[Link] 42/139
1/6/26, 5:01 PM [Link]
BIT30 User Declared Bit False
BIT31 User Declared Bit False

Commands:
Name Description

[END]

[BOOL] Top

[END]

[CALCCFG] Top

Settings:
Name Description Default Value
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 6
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
AUTOCLEAR Auto Clear data on new Execute False
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes True
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
TRIGGERS Calc Trig Config
DBSTYLE <AUTO|HIST|CFG> CFG

[Link] 43/139
1/6/26, 5:01 PM [Link]
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 2
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
AUTOCLEAR Auto Clear data on new Execute False
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes True
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
ARGS Calc Arg Config
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 4
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
AUTOCLEAR Auto Clear data on new Execute False
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes True
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0

[Link] 44/139
1/6/26, 5:01 PM [Link]
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True

Commands:
Name Description
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
BY
NAME Fetch by (<CalcName>)
TRIG
ROW Fetch by <item_row>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>

[Link] 45/139
1/6/26, 5:01 PM [Link]
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
TRIGGERS Calc Trig Config
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
BY
TAGNAME Fetch by <Tag_Name>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
[Link] 46/139
1/6/26, 5:01 PM [Link]
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
ARGS Calc Arg Config
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)

[Link] 47/139
1/6/26, 5:01 PM [Link]

[END]

[CONVERSION] Top

Settings:
Name Description Default Value
ATMOS Atmospheric Pressure 101.32
ALTITUDE Altitude (in m) -0.00

Commands:
Name Description
CONVERT Convert (InUnits OutUnits InValue)

[END]

[DBCONNECTION] Top

DB Connection Object
Settings:
Name Description Default Value
DBNAME Database Name
USER Username
PASSWORD Password
TYPE Database Type <FIREBIRD|MSSQL|MYSQL>
RC Return Code from last operation False

Commands:
Name Description
CONNECT Connects to Database

[END]

[DBDIR] Top

This is an object based upon BaseModel which is populated by a directory

listing
This object may be cloned.
eg: set =
eg: set =
This allows it to be used in conjunction with a DBRecord object to import
and export data between file and database
Settings:
Name Description Default Value
DBTYPE <MSSQL|MARIADB|FIREBIRD>
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 6

[Link] 48/139
1/6/26, 5:01 PM [Link]
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
PATH Directory Path
PATTERN File pattern (eg. .txt a002*.log)
INCLUDE
FILES Include Files in results True
DIRECTORIES Include Directories in results True
HIDDEN Include Hidden and system files in results False
SORT sort results by alphabet Dir first True

Commands:
Name Description
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0> <default>
COL
<label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)

[Link] 49/139
1/6/26, 5:01 PM [Link]
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)

[END]

[DBFILE] Top

This is an object based upon BaseModel which allows read/write access

to a file so that it can be used just like a database table.
The main difference is there is no WHERE clause capability and therefore
no filtering capability.
The default directory location is the AppPath unless the file is pathed
as an absolute path with \\ or :\
This object may be cloned.
eg: set =
eg: set =
This allows it to be used in conjunction with a DBRecord object to import
and export data between file and database
Settings:
Name Description Default Value
DBTYPE <MSSQL|MARIADB|FIREBIRD>
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 0
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False

[Link] 50/139
1/6/26, 5:01 PM [Link]
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 10000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
FILE File Name
DELIMITER Field Delimeter character ,
COMMENTCHAR Comment character #
TEXTCHAR Optional text field delimeter
ESCCHAR Optional escape character in case of delimeter in field \
NEWLINECHAR Optionally replace newline cahr with this \r
SECTION Optional section name
HASHEADER File has header row True
USEHEADER Use header or create cols manually True
USETEXTCHAR Use TEXTChar when saving False
TRIM Trim space from ends on import True

Commands:
Name Description
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0> <default>
COL
<label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL

[Link] 51/139
1/6/26, 5:01 PM [Link]
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)

[END]

[DBLOG] Top

This is the data access class for retrieving, importing, and exporting records
in DBLog tables in the history database. These tables are usually used
for logging and trending.
The FETch BY TIMEstamp command fetches 1 record that is prior to or the same
timestamp as the timestamp supplied. (or current time if none supplied)
The FETch BY RANge command fetches records between the two supplied timestamps.
The optional interval is in seconds and will cause the Fetch By Range to normalize
the records into the specified interval
The FETch BY PREvious fetches clears the selection and fetches the next previous
record (older record) than the current selected row based upon that row's timestamp
Using the FETch BY PREVious means that there will only be one record in the model
All of the FETch BY commands order the results with the newest at the top (row 0)
Settings:

[Link] 52/139
1/6/26, 5:01 PM [Link]

Name Description Default Value

DBTYPE <MSSQL|MARIADB|FIREBIRD> MSSQL
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 0
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes True
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
TABLE Table name

Commands:
Name Description
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE

[Link] 53/139
1/6/26, 5:01 PM [Link]
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
BY
TIMESTAMP Fetch record <= (<YYYY-MM-DD> <HH:MM:SS>)
RANGE Fetch records by time range <start_timestamp> <end_timestamp> (<interval_sec>)
PREVIOUS Fetch previous Record from DB based upon current record
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)

[END]

[DBQUERY] Top

This is a generic data access class that can be used to access any table
in the either the history or configuration database. After instantiation
set the query string and call Execute.
The DBStyle setting controls which database will be queried.
The Fetch First Row / Fetch Next Row commands will bring the columns of
one record at a time to properties under a Data heading.
The Columns will be created with the column names in the query.
Optionally setting the SCHema name allows the use of existing schemas to
provide full column definition including default values and enums.
Another option is to use the ADD COL SCHEMA or ADD COL DEF commands
to define the columns. The two ways of adding columns
(by SCHema name vs. by COL) are mutually exclusive. You cannot set the
schema name and then add columns as the schema will then be cleared.
likewise you can't add columns and then set the schema as the columns will be

[Link] 54/139
1/6/26, 5:01 PM [Link]

cleared.
The ROLLBack command will roll back usaved changes. The changes may be in
an unsaved state because save has not been called or because save failed.
The ALLOW ROLLBack flag must be set before the execute of the query in
order to have the data to rollback. The RC will be false if the rollback
was attempted with the ALLOW ROLLBack flag set to 0.
Calling the CLEar command will clear all data, the query, and the schema and columns.
DBRecord uses the BaseModel and can therefore be cloned.
eg: set =
This cloning technique works with any other object that uses the BaseModel.
Note: Save can only be performed if a schema has been set and all the index columns
have been selected or by adding all the index columns through the ADD COL SCHEMA
command. The index columns of all tables must also be selected in the query.
RC will be false after calling save if unable to save for one of these reasons.
Note: For XLS Export using the Fetch XLS or Export XLS commands the sheet name must
be fully qualified.
eg. myquery fetch xls all "myxls sheet1" 0 0
not: myquery fetch xls all sheet1 0 0
Settings:
Name Description Default Value
QUERY database query
DBSTYLE <HIST|CFG> HIST
DBTYPE <HIST|CFG> MSSQL
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
SELECTED
ROW Currently selected row (base 0) -1
ALLOW
ROLLBACK Allow rollback of unsaved changes False
MAX
ROWS Maximum Rows allowed in fetch 10000
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True

Commands:
Name Description
ADD
ROW Adds a row to then end with defaults and loads the record
ALIAS <colName> <colAlias>
COL
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0> <default>
DEF
<label> <min> <max> <tagName> <format> <isStn>)
SCHEMA <tableName> <colName>
SCHEMA <schemaName>
EXECUTE Executes the query
SAVE Saves any changes to the database
HIDE

[Link] 55/139
1/6/26, 5:01 PM [Link]
COL Hide <colName> from view
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch lastt row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
TOSTRING Put current record into <string obj>
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
DELETE
ROW Deletes the current record from the database

[END]

[DBRECORD] Top

This is a generic data access class that can be used to access any table
in the either the history or configuration database. After instantiation
set the schema and table name. If the schema name is valid then the isOK
flag will be set and the base record accessors such as
Execute and fetch first row / fetch next row can then be used.
The Fetch First Row / Fetch Next Row commands will bring the columns of
one record at a time to properties under a Data heading.
Selections can be customized by adding a where clause with the ADD WHERE command.
A virtual column can be added to any real table using the ADD COL command.
Virtual tables can be created by setting a name but not a schema and using
the ADD COL command to add column definitions.
If a tagName is added in the ADD COL command then the tag will be read
upon Execute and written upon Save.
The ROLLBack command will roll back usaved changes. The changes may be in
an unsaved state because save has not been called or because save failed.
The ALLOW ROLLBack flag must be set before the execute of the query in
order to have the data to rollback. The RC will be false if the rollback
was attempted with the ALLOW ROLLBack flag set to 0.
Calling the CLEar command will clear all data, the query, and the schema and columns.
DBRecord uses the BaseModel and can therefore be cloned.
eg: set =
This cloning technique works with any other object that uses the BaseModel.
[Link] 56/139
1/6/26, 5:01 PM [Link]

Note: For XLS Export using the Fetch XLS or Export XLS commands the sheet name must
be fully qualified.
eg. myquery fetch xls all "myxls sheet1" 0 0
not: myquery fetch xls all sheet1 0 0
Settings:
Name Description Default Value
DBSTYLE <AUTO|HIST|CFG> AUTO
DBTYPE <MSSQL|MARIADB|FIREBIRD>
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 0
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes True
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 10000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
SCHEMA Schema Name
TABLE Table Name

Commands:
Name Description
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0> <default>
COL
<label> <min> <max> <tagName> <isStn>)
SCHEMA <tableName> <colName>
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
[Link] 57/139
1/6/26, 5:01 PM [Link]
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)

[END]

[DBTAGLIST] Top

This is a data access class for interfacing with the realtime

database (In Memory). It support fetching and updating records.
Settings:

[Link] 58/139
1/6/26, 5:01 PM [Link]

Name Description Default Value

NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 6
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
MAX
ROWS Maximum Rows allowed in fetch 10000
OK Indicates Object is OK to use True
RC Return Code from last operation True

Commands:
Name Description
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0> <default>
COL
<label> <min> <max> <tagName> <isStn>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
REMOVE
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
CLEAR Clears the data and the query
FETCH
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)

[END]

[DBXLS] Top

This is an object based upon BaseModel which allows read/write access

to an XLS file so that it can be used just like a database table.
[Link] 59/139
1/6/26, 5:01 PM [Link]

The main difference is there is no WHERE clause capability and therefore

no filtering capability.
The default directory location is the AppPath unless the file is pathed
as an absolute path with \\ or :\
Files must be of type .XLS not .XLSX. The .XLS extension will be added
automatically if left off.
This object may be cloned.
eg: set =
eg: set =
This allows it to be used in conjunction with a DBRecord object to import
and export data between file and database
All row, col, and sheet references are 0 based.
Settings:
Name Description Default Value
DBTYPE <MSSQL|MARIADB|FIREBIRD>
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 0
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 10000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
FILE File Name .xls
HASHEADER File has header row in range True
USEHEADER Use header or create cols manually True
RANGE
START
ROW Start row number of range 0
COL Start col number of range 0

[Link] 60/139
1/6/26, 5:01 PM [Link]
SHEET
NUM Sheet number of range 0

Commands:
Name Description
ADD
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0> <default>
COL
<label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
CELL Fetches data from cell to given Variant <row> <col> <variant>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC

[Link] 61/139
1/6/26, 5:01 PM [Link]
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
SET
CELL Set data to cell <row> <col> <value>

[END]

[DEFINE] Top

Simple string object that can be set in the same way as any other variable.
The difference with the Define is that upon the appearance of it in a line
it will simply be replaced upon initial parsing of the line. Unlike a
normal variable or object which cannot be nested or dereferenced within a
literal, the define will.
eg.
DECLARE DEFINE USERNAME = "Fred Flintstone"
set mystr = "Your user name is: %USERNAME%"

eg.
DECLARE DEFINE BASENAME = "MyStuff"
DECLARE STRING %BASENAME% ErrorStr

eg.
DECLARE DEFINE DEBUGCMD = "CLI DEBUG %args arg0%"
DEBUGCMD This message goes to debug prefixed by the script name.

Unlike with C, the value can be changed at any time just like a string.
eg.
set USERNAME = "No One"
set mystr = "Your user name is: %USERNAME%"
[END]

[DIR] Top

Settings:
Name Description Default Value
PATH Directory Path
PATTERN File pattern (eg. .txt a002*.log) *
COUNT # files in matching the pattern 0
FILENAME Name of file from fetch
INCLUDE
FILES Include Files in results True
DIRECTORIES Include Directories in results False
HIDDEN Include Hidden and system files in results False
RC Return Code from last operation False

Commands:
Name Description
CREATE Create directory
EXISTS Check if path exists

[Link] 62/139
1/6/26, 5:01 PM [Link]
FETCH
FIRST Fetch the name of the first file
NEXT Fetch the name of the first file
TRUNCATE Delete files matching the pattern leaving <number> most recent
REFRESH refresh directory listing
REMOVE Remove directory

[END]

[ECMTIME] Top

Settings:
Name Description Default Value
STRING *Time as String 2025-05-15 15:18:12
DATE Date as String 2025-05-15
TIME Time as String 15:18:12
VAL Time as Long 1747302492
YEAR Year part 2025
MONTH Month 5
DAY Day 15
HOUR Hour 15
MINUTE Minute 18
SECOND Second 12
ISYESTERDAY Is this Date Yesterday False
ISENDOFMONTH Is this the last day in the month False
DOW 1-7 Mon-Sun 4
NAME
SHORTMONTH Short Name of Month MAY
MONTH Name of Month May
DAY Day Of Week Name Thursday
USEISO8601 ISO8601 has T between date and Time False
TIMEZONE
OFFSET Number of Hours From UTC 5.50
NAME TimeZone Name India Standard Time
ABBR TimeZone Abbr Name ie MST UTC+-5.500000

Commands:
Name Description
NOW Refresh with current time
ADDYEAR Add Number of years to time
ADDMONTH Add Number of months to time
ADDDAY Add Number of days to time
ADDHOUR Add Number of hours to time
ADDMINUTE Add Number of minutes to time
ADDSECOND Add Number of seconds to time
IMPORT
FORM1 Import from string <MM/DD/YYYY hh:mm:ss>
FORM2 Import from string <DD/MM/YYYY hh:mm:ss>
FORM3 Import from string <YYYYMMDD>
FORM4 Import from string <YYYY-MMM-DD>
FORM5 Import from string <MMDD>
[Link] 63/139
1/6/26, 5:01 PM [Link]
FORM6 Import from string <hhmm(ss)>

[END]

[EFMALARM] Top

This is a data access class for import and export of EFM Events.
Settings:
Name Description Default Value
DBSTYLE <AUTO|HIST|CFG> AUTO
DBTYPE <MSSQL|MARIADB|FIREBIRD>
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 0
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes True
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
RTU RTU Name

Commands:
Name Description
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0> <default>
COL
<label> <min> <max> <tagName> <isStn>)

[Link] 64/139
1/6/26, 5:01 PM [Link]
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)

[END]

[EFMEVENT] Top

This is a data access class for import and export of EFM Events.
Settings:
[Link] 65/139
1/6/26, 5:01 PM [Link]

Name Description Default Value

DBSTYLE <AUTO|HIST|CFG> AUTO
DBTYPE <MSSQL|MARIADB|FIREBIRD>
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 0
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes True
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
RTU RTU Name

Commands:
Name Description
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0> <default>
COL
<label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug

[Link] 66/139
1/6/26, 5:01 PM [Link]
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)

[END]

[FILE] Top

Settings:
Name Description Default Value
NAME File Name
RC Return Code from last operation False

Commands:
Name Description
OPEN
NEW Opens the file as new
READ Opens the file for reading

[Link] 67/139
1/6/26, 5:01 PM [Link]
APPEND Opens the file for Append
CLOSE Closes the file
EXISTS Check if file exists, puts 1 or 0 on stack and in rc
RENAME Rename to <newName>, puts 1 or 0 on stack and in rc
DELETE Delete, puts 1 or 0 on stack and in rc
COPY Copy to <newName>, puts 1 or 0 on stack and in rc
WRITELINE Writes the specified line to the file including End Of Line terminator
WRITEBYTES Writes the specified output to the file, line will not be terminated
READLINE Reads the next line into the specified <string_obj>
GOTOLINE Goes to specified line number -base0- <line number>

[END]

[FLOAT] Top

[END]

[FORMULACFG] Top

Settings:
Name Description Default Value
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 4
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes True
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 10000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False

[Link] 68/139
1/6/26, 5:01 PM [Link]
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True

Commands:
Name Description
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0> <default>
COL
<label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
BY
NAME Fetch by (<FormulaName>)
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)

[Link] 69/139
1/6/26, 5:01 PM [Link]
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)

[END]

[HEXSTR] Top

Settings:
Name Description Default Value
SIZE Number of Elements of TYPE 0
PACKING byte packing ABCD
POSITION Current Element Position 0
RC Return Code 0
TYPE Data Type <bit char i16 u16 i16 u16 flt string> char
DATA Data Element [POSITION]

Commands:
Name Description
CLEAR Clear
REVERSE Reverse Bits
DUMP Dumps the stack
ADD
STRING Adds Data <str>
BYTE Adds Data <0-255>
I16 Adds Data <+-32767>
FETCH
FIRST Get First Record
NEXT Get Next Record

[END]

[HOURLYHRP] Top

This is the data access class for retrieving, importing, and exporting HRPHourly records
Import and export can be done using the TOString/Fromstring commands.
This model is a transform from multiple rows in the DB table to columns.
At present time this a viewonly model, but could be extended to revert the data back to .
Settings:
Name Description Default Value
DBTYPE <MSSQL|MARIADB|FIREBIRD>
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 0
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False

[Link] 70/139
1/6/26, 5:01 PM [Link]
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
ISPRORATE Prorate Total to 24 Hour <true|false> False
SHOWROWHEADER Show Row Header <true|false> True
ISMETAEXPOSED Expose Meta Data <true|false> False
ISVALID Is the Model Valid True

Commands:
Name Description
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS

[Link] 71/139
1/6/26, 5:01 PM [Link]
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
BY
UKEY
TIMESTAMP Fetch HRP Data for Single Production Day <StnId> <Column|'ALL'> <datestamp>
STARTTIME
ENDTIME Fetch HRP Data for a Date Range <StnId> <Column|'ALL'> <starttimestamp> <endtimestamp>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc
COLLABEL
<ColNum> (<obj>)

[END]

[HRPITEM] Top

This is the data access class for retrieving, importing, and exporting HRP records
Import and export can be done using the TOString/Fromstring commands.
ORG_DATA may only be updated on a new record and may not be changed after saving.
COMMENT must be filled in in order for a save to work.
Any records in the future will have the EstOnly flag set on Save.
Settings:
Name Description Default Value
DBTYPE <MSSQL|MARIADB|FIREBIRD>
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 13
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
[Link] 72/139
1/6/26, 5:01 PM [Link]
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
COLUMN HRP Column name

Commands:
Name Description
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
BY
UKEY Fetch HRP Data <StnId> (<YYYY> (<MM> (<DD>)))
TIMESTAMP Fetch HRP Record <StnId> (<YYYY> <MM> <DD>) defaults to yesterday

[Link] 73/139
1/6/26, 5:01 PM [Link]
PREVIOUS Fetch previous Record from DB based upon current record
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)

[END]

[HTTPCLIENT] Top

This object allows sending HTTP POST/GET requests to a webserver

Settings:
Name Description Default Value
ADDR Server http address (i.e [Link]
URL Request Url (i.e. /sync/export)
FILENAME File Name for Post File (i.e. c:\[Link])
PORT Port number 80
UID User Id
PWD Password
PEERVERIFICATION Peer verification True
HOSTVERIFICATION Host verification True
ISPWDENCRYPTED Is Password Encrypted False
TIMEOUT Response Timeout (s) 3
RETRIES Max Number of Retries 1
CONTENTTYPE Message Content-Type application/text
COOKIE Cookie name
RC Return Code from last operation False

Commands:
Name Description
SEND Send data/request (<responseStringObj>)
GET
STRING GET data/request (<responseStringObj>)
FILE GET data/request save to file <Full File Name>
ADD
ARGUMENT Adds name-value pair as part of the message <name> (<value>)
HEADER Adds name-value pair as part of the header <name> (<value>)
REMOVE
ARGUMENT Removes name-value pair <name>
HEADER Removes name-value pair from header <name>
CLEAR
ARGUMENTS Removes all arguments

[Link] 74/139
1/6/26, 5:01 PM [Link]
HEADERS Removes all headers

[END]

[IMPORTMETER] Top

Settings:
Name Description Default Value
INPUTFILE Fully pathed input file
FORMATFILE Fully pathed format file for column mapping
FILTER station filter optional
COUNT # records loaded from file 0
SUCCESSCOUNT # records successfully inserted 0
FAILURECOUNT # records failed to insert 0
OK Return Code from last operation True
RC Return Code from last operation True
ERROR Last Error Message

Commands:
Name Description
LOAD Load records from inputfile
INSERT Insert loaded data into DB
FETCH
FIRST Fetch First Record from file
NEXT Fetch Next Record from file

[END]

[INT] Top

[END]

[LIQUIDCOR] Top

This object allows users to Correct Liquid Hyocarbon Products for Temp and Pressure
Settings:
Name Description Default Value
TABLE Set Get Table Used API11.1
ATMOSPRES Set Get Atmos Pres kPa 101.32
BASETEMP Set Get Base Temp Deg C 15.00
CORDENS Set Get Cor Dens 690.00
EQUILPRES Set Get Equil Pres kPa 0.00
FLOWPRES Set Get Flow Pres kPa 0.00
FLOWTEMP Set Get Flow Temp Deg C 0.00
VAPORPRES Set Get Vapor Pres kPaa 0.00
VAPOR100PRES Set Get Vapor Pres kPaa 0.00
OBSDENS Set Get Obs Dens 690.00
OBSPRES Set Get Obs Pres 0.00

[Link] 75/139
1/6/26, 5:01 PM [Link]
OBSTEMP Set Get Obs Temp 15.00
ISCALCCOR Is Calc Cor Density True
ISCALCCPL Is Calc CPL True
ISCALCCTL Is Calc CTL True
VPCALC Vapor Pressure Calc VPZERO
ISDEBUG Is Debug True
ISHYDRO Is Hydro False
CTL Cor Temp Factor 0.00
CPL Cor Pres Factor 0.00
CCF Combined Correction Factor 0.00
RC Calc Return 1 = GOOD 0 = BAD 0
STATUS Calc Status INITIALIZED

Commands:
Name Description
CALC Calc Corrected Density

[END]

[MAILBOX] Top

Settings:
Name Description Default Value
NAME Mailbox Name tmpObj
DIR Mailbox Directory D:\Tinbox\Apps\MBCSTest\mbx\tmpObj
MSG
COUNT Message Count 0
RC Return code from last operation False

Commands:
Name Description
LIST List Messages in this mailbox
ADD
MSG Add <ObjMailMsg> to mailbox
DEL
MSG Delete <ObjMailMsg> from mailbox
GET
MSG Get into Message Object <ObjMailMsg>
CLEANUP Delete Msgs older than <YYYY-MM-DD> <hh:mm:ss>
REBUILD Rebuild the mailbox based upon the actual email files

[END]

[MAILCLIENT] Top

Settings:
Name Description Default Value
VERBOSE Verbose setting adds error messages to e-mail False
SERVER <[Link]>

[Link] 76/139
1/6/26, 5:01 PM [Link]
IPPORT <IP_Port>
UID <you@[Link]>
PWD <password>
SSL <true|false|on|off|1|0> False
TMPDIR Temporary Directory for the files C:\WINDOWS\TEMP
COUNT number of Messages on server 0
RC Return code from last operation True
ERROR Last error message if rc is 0

Commands:
Name Description
LIST CheckServer for Messages
RETRIEVE Retrieve Mail by Id into Message <MailMessage> <Id>
DELETE Delete Mail Message by <Id>

[END]

[MAILMESSAGE] Top

Settings:
Name Description Default Value
FILENAME Name of received temporary .eml file C:\WINDOWS\TEMP\ecm_calc_service18785421.eml
TMPDIR Temporary Directory for the files C:\WINDOWS\TEMP
FROM Who the message is from
SUBJECT Subject of message
BODY Body of message
True if this has received content from a MailClient
INITRECEIVE False
object
True if this message has enough set to send with a
INITSEND False
MailSender object

Commands:
Name Description
PARSE Parse temporary .eml file into components
ADD
RECIPIENT Add e-mail address to recipient list <e-mail>
FILE Add File as attachment
DELETE Delete All files for this Message
SAVE Save Mail Message

[END]

[MAILSENDER] Top

Settings:
Name Description Default Value
VERBOSE Verbose setting adds error messages to e-mail True
SERVER <[Link]>
IPPORT <IP_Port>
UID <you@[Link]>
[Link] 77/139
1/6/26, 5:01 PM [Link]
PWD <password>
SSL <true|false|on|off|1|0> False
PEERVERIFICATION Peer verification True
HOSTVERIFICATION Host verification True
BYTES number of bytes sent 0
RC Return code from last operation False
ERROR Last error message if rc is 0

Commands:
Name Description
SEND Send <MailMessage>

[END]

[MEDIA] Top

Settings:
Name Description Default Value
FILE Media File to Play
ERROR Error Code 0
RC Return Code from last operation 0

Commands:
Name Description
PLAY Set the File to Play

[END]

[MENUSERVER] Top

This object allows receiving client signals from another process. It listens on the specified
TCP/IP socket and accepts connections. Connections are authenticated. The UserId and source
IP Address are provided as settings for inromational purposes. After instantiation and
setting the IPPort, the object must be started with the START command in order to start
listening on the port. Upon calling the START command the RC can be checked. If the RC is
0 then the listen failed, most likely due to the port being in use. The READ command
polls for messages from the client. Upon calling READ, RC will be 1 if there is a message
The message will be pushed onto the stack or copied to the optionally supplied STRING
object. Any time the IP Port number is changed the listener will be stopped and must be
restarted. The object is automatically stopped upon deletion. Stopping closes all
client connections.
The MENUSERVER object supports multiple simultaneous connections but since tracking the
connection is difficult in script it is recommended that the applicaiton be designed such
that only one client connect at a time per MENUSERVER object.
The SEND command can be used to send data to the client. This will go to the client
specified by the UID and IPADDRESS properties
Settings:
Name Description Default Value
IPPORT IPPort to listen 8999
USESAUTHENTICATION Client must authenticate 1
MENUREADS Menu Reads Messages False

[Link] 78/139
1/6/26, 5:01 PM [Link]
IPADDRESS IPAddress of Client
UID Uid of Client
RC Return Code from last operation False

Commands:
Name Description
START Start Listening on port
STOP Stop Listening on port
READ Read Message (<respStringObj>)
SEND Send Message <message>

[END]

[METERITEM] Top

This is the data access class for retrieving, importing, and exporting meter records
The Diff and Overlay commands will put a list of column names that have changed on the stack.
The Fetch By Effective command is the most common way of getting the current record.
The Fetch By Timestamp command is for getting a specific record. If there is not record
for that timestamp then the preciously inserted record will be fetched. The caller must
check the timestmap to ensure it was the anticipated record.
To create a new empty record for a meter it is recomended to either use the
Fetch By Effective
or
Init By Stationid
Using a Fetch or the Init will ensure the basic properties such as meter type are set.
It is not recommended to use the Add Row method.
The metadata such as PORTNAME, RTUNAME, TANAME, ITEMNAME, DEVICETYPE,
EN_METERTYPE
will get reloaded any time the UK_StationId is changed.
If the TS_TIMESTAMP was not set on a new record then it will get set to current
upon save.
If the UK_STATIONID or TS_TIMESTAMP are changed then the record will be treated
as a new record and an insert will be performed rather than an update on the
existing record.
If any column other than the TS_TIMESTAMP or LASTUPDATE was changed then the
TS_TIMESTAMP and
LASTUPDATE will get set to current and it will get inserted as a new record upon save.
If nothing was changed in an existing record then the LASTUPDATE will get set to
current and the record will be updated upon save.
Import and export can be done using the TOString/Fromstring commands or by using the Import
method which makes use of a [Link] file and either a CSV or XLS file from a 3rd party
Settings:
Name Description Default Value
DBSTYLE <AUTO|HIST|CFG> HIST
DBTYPE <MSSQL|MARIADB|FIREBIRD> MSSQL
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 109
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False

[Link] 79/139
1/6/26, 5:01 PM [Link]
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes True
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
CHECKGCTOTAL Check GC Total on Save True

Commands:
Name Description
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH

[Link] 80/139
1/6/26, 5:01 PM [Link]
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
BY
EFFECTIVE Fetch effective Meter Record <StnId> <day> <month> <year>
TIMESTAMP Fetch Meter Record <StnId> <YYYY-MM-DD (HH:MM:SS)>
PREVIOUS Fetch previous Record from DB based upon current record
PRODUCTS Fetch Product List for this meter
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
INIT
BY
STATIONID New Default Record for <StnId>
DIFF
RECORD Compare records <row1> <row2> put diff on stack
METER Compare records of this <row> to <meterItem> <row> put diff on stack
OVERLAY
RECORD Overlay <row1> with <row2>
METER Overlay this <row> with <meterItem> <row2>
SEND Send Meter Record to RTU

[END]

[MQTT] Top

Settings:
Name Description Default Value
IP IP address of the Broker [Link]
PORT IP Port of the Broker 1883
CLIENTID Client Id

[Link] 81/139
1/6/26, 5:01 PM [Link]
USER User Name
PWD Password
USESSL use SSL False
USELEGACY use Legacy 3.13 True
USECLEAN use Clean Connection False
KEEPALIVE Keep Alive (in seconds) 60
RC Return Code from last operation False

Commands:
Name Description
PUBLISH Publish Topic <topic> <value> <(qos=0)> <(retain=false)>

[END]

[NETWORK] Top

This object allows sending Network requests to a webserver

Settings:
Name Description Default Value
PACKETSIZE Packet Size 32
TIMEOUT Response Timeout (s) 5000
MESSAGE Last Message
SELECTED
ROW Current Selected Row -1
NUM
ROWS Number of Rows 0
RC Return Code from last operation False

Commands:
Name Description
PING Send Ping <IP>
ARP Send ARP
FETCH
FIRST Fetch First ARP Value
NEXT Fetch Next ARP Value
LAST Fetch Last ARP Value

[END]

[OPCITEM] Top

This object browses for OPC Tags from a specified server. The IP Address
and OPC Server name must be specified. The IP Address can optionally
be a fully qualified server name instead (eg. [Link])
if the connection has not been made it will be attempted when the Execute
command is called. If the IP Address or server changes while connected then
the next time the execute command is called the connection will be
disconnected and a connection to the new server will be attempted.
The OK flag will be set to false if connection to the OPC Server
could not be made.
This s a ECMBaseModel based object and is therefore clonable to other DBObjects.

[Link] 82/139
1/6/26, 5:01 PM [Link]

Settings:
Name Description Default Value
QUERY database query
DBSTYLE <HIST|CFG> HIST
DBTYPE <HIST|CFG> MSSQL
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 4
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
SELECTED
ROW Currently selected row (base 0) -1
ALLOW
ROLLBACK Allow rollback of unsaved changes False
MAX
ROWS Maximum Rows allowed in fetch 100000
ROLE User Role Restrictions
OK Indicates Connection Status True
RC Return Code from last operation True
ISCONNECTED 1 if connected to server False
LAST
ERROR Last Error if OK is 0
INCLUDETQV Include TQV as well as tag True
IPADDR IP Address or name of server [Link]
OPCSRVNAME Name of OPC Server instance Softing.OPCToolboxDemo_ServerDA.1
DAVER OPC DA Version 2
TAG
FILTER Tag Filter (eg. time.* a001.r*)
MAX Max Num tags to browse 1000

Commands:
Name Description
ADD
ROW Adds a row to then end with defaults and loads the record
ALIAS <colName> <colAlias>
EXECUTE Executes the query
SAVE Saves any changes to the database
HIDE
COL Hide <colName> from view
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
[Link] 83/139
1/6/26, 5:01 PM [Link]
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch lastt row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
TOSTRING Put current record into <string obj>
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
CONNECT Connect to the configured server
DISCONNECT Disconnect from the configured server

[END]

[OPCSERVER] Top

This is an OPC Server browser object. Setting the IPAddress causes it to

attempt a connection to that server and browse for OPC servers. the Execute
command is not needed. The IP Address can optionally
be a fully qualified server name instead (eg. [Link])
The OK flag will be set to false if it could not browse. This is likely caused by
an invalid IP Address or firewall and it could not connect to the server for browsing
This s a ECMBaseModel based object and is therefore clonable to other DBObjects.
Settings:
Name Description Default Value
DBSTYLE <HIST|CFG> HIST
DBTYPE <HIST|CFG> MSSQL
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 8
COLS Number of Cols in the model 7
TRANSPOSE Transpose row and col when writing to spreadsheet False
AUTOCLEAR Auto Clear data on new Execute True
SELECTED
ROW Currently selected row (base 0) 7
ALLOW
ROLLBACK Allow rollback of unsaved changes False
MAX
ROWS Maximum Rows allowed in fetch 100000
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
IPADDR IP Address or name of server [Link]
DAVER OPC DA Version
DATA Data Columns row 8 of 8
NAME NAME [Link].1
IPADDR IPADDR [Link].1
URL URL [Link].1
[Link] 84/139
1/6/26, 5:01 PM [Link]
DESCRIPTION DESCRIPTION [Link].1
OPCSPEC OPCSPEC [Link].1
CLSID CLSID [Link].1
PROGID PROGID [Link].1

Commands:
Name Description
ADD
ROW Adds a row to then end with defaults and loads the record
ALIAS <colName> <colAlias>
EXECUTE Executes the query
SAVE Saves any changes to the database
HIDE
COL Hide <colName> from view
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch lastt row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
TOSTRING Put current record into <string obj>
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)

[END]

[PDFAXIS] Top

PDF Widget that defines and draws an axis.

To be used with the Draw Widget command of a PDFFile object.
Settings:
Name Description Default Value
RC Return Code from last operation True
X1 top left X coord 0.00
Y1 top left Y coord 0.00
X2 bottom left X coord 0.00

[Link] 85/139
1/6/26, 5:01 PM [Link]
Y2 bottom left Y coord 500.00
LABEL Label text for axis myAxis
WEIGHT
AXIS Line Weight of Axis 1
TICK
MINOR Minor tick interval 0
MARGIN Minor tick interval 20
MARGIN pixels between axis and label 20

Commands:
Name Description
ADD
MAJOR Add Major Tick

[END]

[PDFFILE] Top

This object allows the creation of PDF files.

All coordinates are x,y from the top left corner of the margin.
Where multiple coordinates such as x1,y1 and x2,y2 are required
x1 must be <= x2 and y1 must be <= y2.
Write bytes coordinate is from the top left of the text.
Write Text rotation_angle is in degrees.
The Draw Widget command accepts the fully qualified name of any
PDF Widget such as PDFTextBox or PDFAxis.
Valid colors are: blacksilvergraywhitemaroonredpurplefuchsiagreenlimeoliveyellownavybluetealaqua
Settings:
Name Description Default Value
NAME File Name \
RC Return Code from last operation True
FONT
NAME Font Size Courier
SIZE Font Size 8
COLOR
NAME Color by Name
PAGE
TITLE text to be displayed at top of page
GRID 0=hide 1 = show False
SIZE 0=letter, 1=legal 0
DIRECTION 0=portrait, 1=landscape 0
MARGIN Margin 40.00
BORDER ON of OFF True
MAX
WIDTH pixel width 532
HEIGHT pixel height 712
CURRENT
Y Current Y possition 46.00

Commands:
Name Description
OPEN
[Link] 86/139
1/6/26, 5:01 PM [Link]
NEW Opens the file for writing
SAVE Save and Closes the file
WRITE
LINE Writes the specified line to the file including End Of Line terminator
TEXT <x1> <y1> <rotation_angle> <output text>
FLOAT <x1> <y1> <rotation_angle> <format> <output text>
FORMFEED Create a Page Break
DRAW
LINE Draw a line <x1> <y1> <x2> <y2>
BOX Draw a box <x1> <y1> <x2> <y2> <thickness> <fill>
CBOX Draw a curve box <x1> <y1> <x2> <y2> <r> <thickness> <fill>
CIRCLE Draw a circle <x_center> <y_center> <radius> <thickness> <fill>
IMAGE Draw a circle <x1> <y1> <x2> <y2>
WIDGET Draw a pdf widget <Instantiated_name>

[END]

[PDFHEADERBOX] Top

PDF Widget that defines and draws a curved box with a Header in it.
To be used with the Header Section object.
Settings:
Name Description Default Value
RC Return Code from last operation True
X1 top left X coord 0.00
Y1 top left Y coord 0.00
X2 bottom left X coord 100.00
Y2 bottom left Y coord 50.00
R radius 5
MARGIN Margin inside box 1
WEIGHT Line Weight 1
TITLE
LABEL Title Label HeaderBox
FONT
SIZE Title Font Size 14.00
NAME Title Font Name Helvetica-Bold
AUTOSIZE Automatically adjust font size to fit text True
ALIGN
HORIZONTAL <LEFT|CENTER|RIGHT> CENTER
VERTICAL <TOP|MIDDLE|BOTTOM> MIDDLE

Commands:
Name Description

[END]

[PDFHEADERSECTION] Top

PDF Widget that defines and draws a Header Section Title Bar with Lines.
To be used with the Header Box Widget.

[Link] 87/139
1/6/26, 5:01 PM [Link]

Settings:
Name Description Default Value
RC Return Code from last operation True
X1 top left X coord 0.00
Y1 top left Y coord 0.00
X2 bottom left X coord 100.00
Y2 bottom left Y coord 50.00
MARGIN Margin inside box 2
WEIGHT Line Weight 2
TITLE
LABEL Title Label HeaderSection
FONT
SIZE Title Font Size 14.00
NAME Title Font Name Helvetica-Bold
AUTOSIZE Automatically adjust font size to fit text True
ALIGN
HORIZONTAL <LEFT|CENTER|RIGHT> CENTER
VERTICAL <TOP|MIDDLE|BOTTOM> MIDDLE

Commands:
Name Description

[END]

[PDFLINECHART] Top

PDF Widget that defines and draws a line chart from a model.
To be used with the Draw Widget command of a PDFFile object.
A series must be added to the chart. A model can then be set
in the series. If the fully qualified model name set as the
model is a valid model then the name will appear in the model
name. If it is invalid it will be blank.
Settings:
Name Description Default Value
RC Return Code from last operation True
X1 top left X coord 0.00
Y1 top left Y coord 0.00
X2 bottom left X coord 0.00
Y2 bottom left Y coord 500.00
TITLE Title text
SHOW
BOARDER Show boarder False
DATEONLY Show Date Only True
GRID Show grid lines False
LEGEND Show grid lines False
FONT
SIZE
LABEL Title font size 8.00
LEGEND Legend font size 8.00
XMTICKS X Axis Num Ticks 2
YMTICKS Y Axis Num Ticks 2
[Link] 88/139
1/6/26, 5:01 PM [Link]
MARGIN 2
XAXIS User Declared PDF Axis Widget
RC Return Code from last operation True
LABEL Label text for axis myAxis
WEIGHT
AXIS Line Weight of Axis 1
TICK
MINOR Minor tick interval 0
MARGIN Minor tick interval 20
MARGIN pixels between axis and label 20

Commands:
Name Description
ADD
SERIES (<series_name>)
CLEAR Clear models
XAXIS User Declared PDF Axis Widget
ADD
MAJOR Add Major Tick

[END]

[PDFTABLE] Top

PDF Table Widget that draws a table from a model.

To be used with the Draw Widget command of a PDFFile object.
If the coordinates are left default of -1 then the table will
start at the beginning of the next line of normal text.
This way it can be incorporated into normal text reports
without having to resort to using the coordinate system
The Align setting is used to align in horizontally on
the page when not using the coordinate system
Settings:
Name Description Default Value
RC Return Code from last operation True
X1 top left X coord -1.00
Y1 top left Y coord -1.00
X2 bottom left X coord -1.00
Y2 bottom left Y coord -1.00
MODEL Name of model
TITLE Title text
SHOW
BOARDER Show boarder True
GRID Show grid lines True
ALIGN <LEFT|CENTER|RIGHT> CENTER
MAXROWS Max Num Rows to display 10

Commands:
Name Description

[END]

[Link] 89/139
1/6/26, 5:01 PM [Link]

[PDFTEXTBOX] Top

PDF Widget that defines and draws a box and puts lines of text in it.
To be used with the Draw Widget command of a PDFFile object.
Settings:
Name Description Default Value
RC Return Code from last operation True
X1 top left X coord 0.00
Y1 top left Y coord 0.00
X2 bottom left X coord 100.00
Y2 bottom left Y coord 50.00
MARGIN Margin inside box 1
WEIGHT Line Weight 1
AUTOSIZE Automatically adjust font size to fit text True
ALIGN
HORIZONTAL <LEFT|CENTER|RIGHT> CENTER
VERTICAL <TOP|MIDDLE|BOTTOM> MIDDLE

Commands:
Name Description
ADD
LINE Add Line of text
CLEAR Clear Lines

[END]

[PORTCFG] Top

Settings:
Default
Name Description
Value
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 26
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
AUTOCLEAR Auto Clear data on new Execute False
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
Enable/Disable encryption for columns when setting data depending on
SETASENCRYPTED True
schema
Enable/Disable encryption for columns when getting data depending on
GETASENCRYPTED True
schema
SELECTED
ROW Currently selected row (base 0) -1

[Link] 90/139
1/6/26, 5:01 PM [Link]
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
PROPAGATE
FETCH Include children on fetch True
METAITEMS Item Config
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 41
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
AUTOCLEAR Auto Clear data on new Execute False
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
Enable/Disable encryption for columns when setting data depending on
SETASENCRYPTED True
schema
Enable/Disable encryption for columns when getting data depending on
GETASENCRYPTED True
schema
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
RTUCFG RTU Config

[Link] 91/139
1/6/26, 5:01 PM [Link]
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 67
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
AUTOCLEAR Auto Clear data on new Execute False
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
Enable/Disable encryption for columns when setting data depending on
SETASENCRYPTED True
schema
Enable/Disable encryption for columns when getting data depending on
GETASENCRYPTED True
schema
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
CLEANUP
METADATA Remove Meta Data on delete True
HISTDATA Remove Hist Data on delete True
METAITEMS Item Config
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 41
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
AUTOCLEAR Auto Clear data on new Execute False
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
Enable/Disable encryption for columns when setting data depending on
SETASENCRYPTED True
schema
Enable/Disable encryption for columns when getting data depending on
GETASENCRYPTED True
schema

[Link] 92/139
1/6/26, 5:01 PM [Link]
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
TACFG Ta Config
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 9
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
AUTOCLEAR Auto Clear data on new Execute False
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
Enable/Disable encryption for columns when setting data depending on
SETASENCRYPTED True
schema
Enable/Disable encryption for columns when getting data depending on
GETASENCRYPTED True
schema
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
METAITEMS Item Config

[Link] 93/139
1/6/26, 5:01 PM [Link]
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 41
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
AUTOCLEAR Auto Clear data on new Execute False
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
Enable/Disable encryption for columns when setting data depending on
SETASENCRYPTED True
schema
Enable/Disable encryption for columns when getting data depending on
GETASENCRYPTED True
schema
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
ITEMCFG Item Config
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 41
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
AUTOCLEAR Auto Clear data on new Execute False
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
Enable/Disable encryption for columns when setting data depending on
SETASENCRYPTED True
schema
Enable/Disable encryption for columns when getting data depending on
GETASENCRYPTED True
schema
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0

[Link] 94/139
1/6/26, 5:01 PM [Link]
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 1000000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True

Commands:
Name Description
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO
COL
1|0> <default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
Fetch row of data into named properties under data heading by <rowNum> | <Col>
ROW
<Value>
BY

[Link] 95/139
1/6/26, 5:01 PM [Link]
NAME Fetch by (<portName> (<rtuName> (<taName>)))
ITEM
ROW Fetch by <item_row>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc
COLLABEL
<ColNum> (<obj>)
METAITEMS Item Config
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO
COL
1|0> <default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
Fetch row of data into named properties under data heading by <rowNum> | <Col>
ROW
<Value>
BY
TAGNAME Fetch by <Tag_Name>
SMART
[Link] 96/139
1/6/26, 5:01 PM [Link]
POINTTYPE Fetch by <Tag_Name>
TAGROLE Fetch by <Tag_Role> (<StnId> || <StnRoot>)
RTU Fetch by <StnRoot>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc
COLLABEL
<ColNum> (<obj>)
RTUCFG RTU Config
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO
COL
1|0> <default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
Fetch row of data into named properties under data heading by <rowNum> | <Col>
ROW
<Value>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT

[Link] 97/139
1/6/26, 5:01 PM [Link]
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc
COLLABEL
<ColNum> (<obj>)
SYNC
TEMPLATE Sync current RTU record with TEMPLATE or visa versa
METAITEMS Item Config
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO
COL
1|0> <default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
Fetch row of data into named properties under data heading by <rowNum> | <Col>
ROW
<Value>
BY
TAGNAME Fetch by <Tag_Name>
SMART
POINTTYPE Fetch by <Tag_Name>
TAGROLE Fetch by <Tag_Role> (<StnId> || <StnRoot>)
RTU Fetch by <StnRoot>
TOSTRING Put current record into <string obj>

[Link] 98/139
1/6/26, 5:01 PM [Link]
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc
COLLABEL
<ColNum> (<obj>)
TACFG Ta Config
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO
COL
1|0> <default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
Fetch row of data into named properties under data heading by <rowNum> | <Col>
ROW
<Value>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE

[Link] 99/139
1/6/26, 5:01 PM [Link]
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc
COLLABEL
<ColNum> (<obj>)
METAITEMS Item Config
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO
COL
1|0> <default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
Fetch row of data into named properties under data heading by <rowNum> | <Col>
ROW
<Value>
BY
TAGNAME Fetch by <Tag_Name>
SMART
POINTTYPE Fetch by <Tag_Name>
TAGROLE Fetch by <Tag_Role> (<StnId> || <StnRoot>)
RTU Fetch by <StnRoot>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE

[Link] 100/139
1/6/26, 5:01 PM [Link]
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc
COLLABEL
<ColNum> (<obj>)
ITEMCFG Item Config
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO
COL
1|0> <default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
Fetch row of data into named properties under data heading by <rowNum> | <Col>
ROW
<Value>
BY
TAGNAME Fetch by <Tag_Name>
SMART
POINTTYPE Fetch by <Tag_Name>
TAGROLE Fetch by <Tag_Role> (<StnId> || <StnRoot>)
RTU Fetch by <StnRoot>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
[Link] 101/139
1/6/26, 5:01 PM [Link]
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc
COLLABEL
<ColNum> (<obj>)

[END]

[PROVECFG] Top

Note: Where clause does not require single quotes ' around the comparison value.
Note: For XLS Export using the Fetch XLS or Export XLS commands the sheet name must
be fully qualified.
eg. mydbrec fetch xls all "myxls sheet1" 0 0
not: mydbrec fetch xls all sheet1 0 0
Settings:
Name Description Default Value
DBSTYLE <AUTO|HIST|CFG> HIST
DBTYPE <MSSQL|MARIADB|FIREBIRD> MSSQL
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 62
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes True
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True

Commands:
[Link] 102/139
1/6/26, 5:01 PM [Link]

Name Description
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
BY
PROVERID
TIMESTAMP Fetch prove by <ProverId> <timestamp>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
ADD
ROW Init New by <proverId>
SAVE Save
CLEAR Clear Init New by <proverId>

[END]

[Link] 103/139
1/6/26, 5:01 PM [Link]

[PROVEEPISODE] Top

Note: Where clause does not require single quotes ' around the comparison value.
Note: For XLS Export using the Fetch XLS or Export XLS commands the sheet name must
be fully qualified.
eg. mydbrec fetch xls all "myxls sheet1" 0 0
not: mydbrec fetch xls all sheet1 0 0
Settings:
Name Description Default Value
RUNS Prove Runs
DBSTYLE <AUTO|HIST|CFG> HIST
DBTYPE <MSSQL|MARIADB|FIREBIRD> MSSQL
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 39
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes True
Enable/Disable encryption for columns when setting data depending on
SETASENCRYPTED True
schema
Enable/Disable encryption for columns when getting data depending on
GETASENCRYPTED True
schema
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
RETCODE Returns the RetCode for the Run
GOOD
ERRORSTRING Gets the Last Error in String Form
Data.........
CFG Prove Config
DBSTYLE <AUTO|HIST|CFG> HIST
DBTYPE <MSSQL|MARIADB|FIREBIRD> MSSQL
CONNECTION External DB connection object <dbconnection obj>
NUM

[Link] 104/139
1/6/26, 5:01 PM [Link]
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 62
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes True
Enable/Disable encryption for columns when setting data depending on
SETASENCRYPTED True
schema
Enable/Disable encryption for columns when getting data depending on
GETASENCRYPTED True
schema
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
PASSES Prove Passes
DBSTYLE <AUTO|HIST|CFG> HIST
DBTYPE <MSSQL|MARIADB|FIREBIRD> MSSQL
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 21
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
Enable/Disable encryption for columns when setting data depending on
SETASENCRYPTED True
schema
Enable/Disable encryption for columns when getting data depending on
GETASENCRYPTED True
schema
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase

[Link] 105/139
1/6/26, 5:01 PM [Link]
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
DBSTYLE <AUTO|HIST|CFG> HIST
DBTYPE <MSSQL|MARIADB|FIREBIRD> MSSQL
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 117
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes True
Enable/Disable encryption for columns when setting data depending on
SETASENCRYPTED True
schema
Enable/Disable encryption for columns when getting data depending on
GETASENCRYPTED True
schema
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
LASTERROR Looks at last error string style
STYLE Looks at last error string
GOOD
ERRORSTRING Gets the Last Error in String Form
Data.........

Commands:
Name Description
[Link] 106/139
1/6/26, 5:01 PM [Link]
RUNS Prove Runs
ADD
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
ROLLBACK Rollback unsaved changes
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
CFG Prove Config
DUPLICATE
ROW Adds row to the end based on current record and loads it
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
ROLLBACK Rollback unsaved changes
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
[Link] 107/139
1/6/26, 5:01 PM [Link]
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
PASSES Prove Passes
ADD
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
ROLLBACK Rollback unsaved changes
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
[Link] 108/139
1/6/26, 5:01 PM [Link]
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
DUPLICATE
ROW Adds row to the end based on current record and loads it
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
ROLLBACK Rollback unsaved changes
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
BY
STATIONID
TIMESTAMP Fetch prove by <StationId> <timestamp>
RANGE Fetch prove by <StationId> <start_timestamp> <end_timestamp>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
CLEAR Clears to make ready for new episode
SAVE Saves prove episode
DELETE Deletes the current episode and it's runs
NEW
BY
PROVERID Create new episode for <proverId>
CALC Calcs the Episode
CALCRUN CalcRun the Episode
[Link] 109/139
1/6/26, 5:01 PM [Link]
COMPARE Compares Two Episodes
Creates Prove Report in HTML Format, optional episode object to compare <stringobj>
TOHTML
(episodeObj)
GETFMT Gets FMT File <stringobj>
CANBEACCEPTED Sets RC to true if prove can be accepted

[END]

[PROVEMANAGER] Top

Note: Where clause does not require single quotes ' around the comparison value.
Note: For XLS Export using the Fetch XLS or Export XLS commands the sheet name must
be fully qualified.
eg. mydbrec fetch xls all "myxls sheet1" 0 0
not: mydbrec fetch xls all sheet1 0 0
Settings:
Name Description Default Value
RUNS Prove Runs
DBSTYLE <AUTO|HIST|CFG> HIST
DBTYPE <MSSQL|MARIADB|FIREBIRD> MSSQL
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 39
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
Enable/Disable encryption for columns when setting data depending on
SETASENCRYPTED True
schema
Enable/Disable encryption for columns when getting data depending on
GETASENCRYPTED True
schema
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
[Link] 110/139
1/6/26, 5:01 PM [Link]
RETCODE Returns the RetCode for the Run
GOOD
ERRORSTRING Gets the Last Error in String Form
Data.........
CFG Prove Config
DBSTYLE <AUTO|HIST|CFG> HIST
DBTYPE <MSSQL|MARIADB|FIREBIRD> MSSQL
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 62
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
Enable/Disable encryption for columns when setting data depending on
SETASENCRYPTED True
schema
Enable/Disable encryption for columns when getting data depending on
GETASENCRYPTED True
schema
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
PASSES Prove Passes
DBSTYLE <AUTO|HIST|CFG> HIST
DBTYPE <MSSQL|MARIADB|FIREBIRD> MSSQL
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 21
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False

[Link] 111/139
1/6/26, 5:01 PM [Link]
Enable/Disable encryption for columns when setting data depending on
SETASENCRYPTED True
schema
Enable/Disable encryption for columns when getting data depending on
GETASENCRYPTED True
schema
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
DBSTYLE <AUTO|HIST|CFG> HIST
DBTYPE <MSSQL|MARIADB|FIREBIRD> MSSQL
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 117
FETCH Number of Fetches made 0
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
Enable/Disable encryption for columns when setting data depending on
SETASENCRYPTED True
schema
Enable/Disable encryption for columns when getting data depending on
GETASENCRYPTED True
schema
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MAX
ROWS Maximum Rows allowed in fetch 100000
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
LASTERROR Looks at last error string style
STYLE Looks at last error string
GOOD
ERRORSTRING Gets the Last Error in String Form
Data.........

[Link] 112/139
1/6/26, 5:01 PM [Link]
CURRENTPASS Get Current Pass 0
CURRENTRUN Get Current Run 0
TOTALPASS Get Total Passes 0
TOTALRUNS Get Total Runs 0
ERROR Looks at last error string Invalid Episode
STATUS Looks at last error string Starting Prove

Commands:
Name Description
RUNS Prove Runs
ADD
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
ROLLBACK Rollback unsaved changes
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
CFG Prove Config
DUPLICATE
ROW Adds row to the end based on current record and loads it
DUMPDEBUG Dumps the current record to Debug
[Link] 113/139
1/6/26, 5:01 PM [Link]
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
ROLLBACK Rollback unsaved changes
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
PASSES Prove Passes
ADD
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
ROLLBACK Rollback unsaved changes
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
[Link] 114/139
1/6/26, 5:01 PM [Link]
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
DUPLICATE
ROW Adds row to the end based on current record and loads it
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
ROLLBACK Rollback unsaved changes
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
BY
STATIONID
TIMESTAMP Fetch prove by <StationId> <timestamp>
RANGE Fetch prove by <StationId> <start_timestamp> <end_timestamp>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)

[Link] 115/139
1/6/26, 5:01 PM [Link]
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
CLEAR Clears to make ready for new episode
SAVE Saves prove episode
DELETE Deletes the current episode and it's runs
NEW
BY
PROVERID Create new episode for <proverId>
CALCRUN CalcRun the Episode
Creates Prove Report in HTML Format, optional episode object to compare <stringobj>
TOHTML
(episodeObj)
GETFMT Gets FMT File <stringobj>
CANBEACCEPTED Sets RC to true if prove can be accepted
ADDPASS Adds a Pass
CALC Calcs the Episode
RESETPASS Resets Passes
REMOVELASTPASS Calcs the Episode

[END]

[RECALC] Top

This is the data access class for performing flow recalculation. It uses
HRP values and meter records from history. These values can also be overridden.
The recalculated value can be saved which will cause an event to be put into
The EFM Event log for the Station Id. If any HRP values are overridden then
they will be updated in the database as a correction with a comment. If any meter
record values are overridden then a new meter record will be inserted with an
effective date for the recalc date and a timestamp and lastupdate at the time of
the recalc. Upon calling the CALC command the RC will be set to reflect the
success of the [Link] all records were successfully recalculated then the RC
will be 1. If one or more of the records failed to recalculate then the RC will
be 0. The recalcok column can be used to determine which record(s) failed to recalc
Settings:
Name Description Default Value
DBSTYLE <AUTO|HIST|CFG> HIST
DBTYPE <MSSQL|MARIADB|FIREBIRD> MSSQL
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 14
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
Enable/Disable encryption for columns when setting data depending on
SETASENCRYPTED True
schema
Enable/Disable encryption for columns when getting data depending on
GETASENCRYPTED True
schema
SELECTED
[Link] 116/139
1/6/26, 5:01 PM [Link]
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
UKEY ukey or StationId
2025-05-14
STARTDATE start date
00:00:01
2025-05-14
ENDDATE end date
23:59:59
INCLUDE
DETAILS Put calc details in Lasterror False
METER Meter Record Access
DBSTYLE <AUTO|HIST|CFG> HIST
DBTYPE <MSSQL|MARIADB|FIREBIRD> MSSQL
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 109
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
Enable/Disable encryption for columns when setting data depending on
SETASENCRYPTED True
schema
Enable/Disable encryption for columns when getting data depending on
GETASENCRYPTED True
schema
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0

[Link] 117/139
1/6/26, 5:01 PM [Link]
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
CHECKGCTOTAL Check GC Total on Save True

Commands:
Name Description
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)

[Link] 118/139
1/6/26, 5:01 PM [Link]
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
INIT
BY
STATION Insert row for <stnId> (<yyyy> <mm> <dd>) defaults to yesterday
RANGE Insert row for date range <stnId> <yyyy> <mm> <dd> <yyyy> <mm> <dd>
CALC Recalculate Flow
METER Meter Record Access
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
BY
EFFECTIVE Fetch effective Meter Record <StnId> <day> <month> <year>
[Link] 119/139
1/6/26, 5:01 PM [Link]
TIMESTAMP Fetch Meter Record <StnId> <YYYY-MM-DD (HH:MM:SS)>
PREVIOUS Fetch previous Record from DB based upon current record
PRODUCTS Fetch Product List for this meter
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
INIT
BY
STATIONID New Default Record for <StnId>
DIFF
RECORD Compare records <row1> <row2> put diff on stack
METER Compare records of this <row> to <meterItem> <row> put diff on stack
OVERLAY
RECORD Overlay <row1> with <row2>
METER Overlay this <row> with <meterItem> <row2>
SEND Send Meter Record to RTU

[END]

[ROLECFG] Top

Settings:
Name Description Default Value
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 6
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes True
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE

[Link] 120/139
1/6/26, 5:01 PM [Link]
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 10000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True

Commands:
Name Description
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0> <default>
COL
<label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
BY
NAME Fetch by (<Role>)
TOSTRING Put current record into <string obj>

[Link] 121/139
1/6/26, 5:01 PM [Link]
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)

[END]

[RPTCFG] Top

This is the data access class for managing report configurations.

It also allows generation of reports.
The DEMand command will asynchronously demand a report that has been fetched
through RPTCFG object.
The GENerate command will syncronously generate a report with the specified
details and does not require a report config to have been fetched. The
file names can be either fully pathed or if just the names are used then
the default paths will be assumed
The RC will indicate the result of the GENerate command. If RC == 0 then
the STATus setting will indicate the error code. The result codes are listed
in the ERG documentation.
Settings:
Name Description Default Value
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 31
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes True
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0

[Link] 122/139
1/6/26, 5:01 PM [Link]
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
STATUS Indicates status of the report generation 1

Commands:
Name Description
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0> <default>
COL
<label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>

[Link] 123/139
1/6/26, 5:01 PM [Link]
BY
NAME Fetch Report by <name>
ID Fetch Report by <Id>
ALL Fetch All Report Configs
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
DEMAND Demand the current report <day> <month> <year> (<stnId> <grpId> <hrpschema> <ticketId>)
Syncronously generate the report as specified by <triggerValue> <fmtFile> <outputFile> <YYYY-MM-DD
GENERATE
HH:MM:SS> (<stnId> <grpId> <hrpschema> <ticketId>)

[END]

[RTDBITEM] Top

A Read is performed any time the name of the tag is changed.

This includes setting the name during declaration.
Settings:
Name Description Default Value
NAME Tag Name tmpObj
VALUE *Value (RW)
TIMESTAMP Timestmap (RO) 2025-05-15 15:18:12
OPTION Option (RW) 0
RC Return code from last operation False

Commands:
Name Description
READ Read Tag
WRITE Write Tag

[END]

[SCHEDCFG] Top

Settings:
Name Description Default Value
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>
NUM

[Link] 124/139
1/6/26, 5:01 PM [Link]
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 11
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes True
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 10000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True

Commands:
Name Description
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0> <default>
COL
<label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)

[Link] 125/139
1/6/26, 5:01 PM [Link]
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
BY
NAME Fetch by (<SchedName>)
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)

[END]

[SERPORT] Top

Settings:
Name Description Default Value
PORT Port COM1
PARITY Parity NONE
BAUD Baud rate 9600
STOP Stop Bits 1
BYTE Byte Size 8
MODE Mode ASCII
TIMEOUT Timeout (ms) 1000
TXSTR tx String
TXSIZE tx size 0
RXSTR rx string
RXSIZE rx size 0
RXDONE rx done 0
ERROR Error Code
RC Return Code 0

Commands:
Name Description
OPEN Open the port

[Link] 126/139
1/6/26, 5:01 PM [Link]
CLOSE Close the port
SEND Tx Data
RECV Rx Data
TXOBJ Assigns Tx HexStr
RXOBJ Assigns Rx HexStr

[END]

[SIGNAL] Top

This object allows sending signals between processes. The object may be kept around and
and used with multiple IPPorts without deletion in between. The Service name may be used
instead of the IPPort and a lookup will be made. If the lookup fails then the IPPort will
be set to 0. Lookup by name should not be done to signal to another server because that
server may have different IPPort nummbers.
The RC indicates the success or failure of the SEND command. If an optional string name
can be passed to the SEND command then any response will be put in that string. If no
string is passed then any response will be pushed onto the stack
If more response strings are expected then the READ command can be called. In that case
RC will be set true if there is data. Like with the SEND command the data will be placed into
the supplied string or pushed onto the stack. Calling READ is not usually needed
Settings:
Name Description Default Value
IPADDRESS IPAddress of recipient [Link]
IPPORT IPPort of recipient (or task name) 8091
UID User Id admin
PWD Password admin
WAITRESPONSE Indicates if it waits for a response. False
TIMEOUT Response Timeout (ms) 100
RETRIES Max Num Retries 3
SIGNAL Signal String to Send Time
ISPWDENCRYPTED Indicates if password is encrypted False
RC Return Code from last operation False

Commands:
Name Description
SEND Send Signal (<responseStringObj>)
READ check for more data (<responseStringObj>)

[END]

[SNMPSESSION] Top

SNMP session obj

Settings:
Name Description Default Value
VERSION SNMP Version <2|3> 2
IPADDR Agent IP <string> [Link]
COMMUNITY SNMP Community <string> public
TIMEOUT Set Timeout <milliseconds> 6000
ISCONNECTED Is Connected False
[Link] 127/139
1/6/26, 5:01 PM [Link]
SELECTED
ROW Current Selected Row 0
NUM
ROWS Number of rows 0
RC Return Code from last operation True

Commands:
Name Description
CONNECT Connect to agent
DISCONNECT Disconnect agent
CLEAR Clears oids and results
ADD
OID Add oid to read <oid> or write <oid> <val> (<INT|STR>)
READ Reads added OID
TABLE Reads table <oid>
WRITE Writes values to added OID
ASYNC
WRITE Writes values to added OID
FETCH
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading

[END]

[STACK] Top

A User definable stack object that allows typical stack based operations such as
push and pop.
The default stack size is 10. Items pushed on after the tenth will cause the
first item to roll off the end and be lost. The max size can be changed at any time.
Settings:
Name Description Default Value
SIZE
CURRENT Current Stack depth 0
MAX Max Stack depth 10
0 value from stack EMPTY
1 value from stack EMPTY
2 value from stack EMPTY
3 value from stack EMPTY
4 value from stack EMPTY
5 value from stack EMPTY
6 value from stack EMPTY
7 value from stack EMPTY
8 value from stack EMPTY
9 value from stack EMPTY

[Link] 128/139
1/6/26, 5:01 PM [Link]

Commands:
Name Description
OPERATE operate on stack contents <+|-|*|/|%...>
PUSH push <arg> onto stack
POP Pop first item off stack
CLEAR clear stack contents

[END]

[STATION] Top

Note: Where clause does not require single quotes ' around the comparison value.
Note: For XLS Export using the Fetch XLS or Export XLS commands the sheet name must
be fully qualified.
eg. mydbrec fetch xls all "myxls sheet1" 0 0
not: mydbrec fetch xls all sheet1 0 0
Settings:
Name Description Default Value
DBSTYLE <AUTO|HIST|CFG> HIST
DBTYPE <MSSQL|MARIADB|FIREBIRD> MSSQL
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 26
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes True
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes True
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
ROOT Station Root (no Run#)
[Link] 129/139
1/6/26, 5:01 PM [Link]
RUNNUM Station Run# 1
GROUPID GroupId of group Fetch
BALANCETYPE For Group 0=reciept, 1=delivery 0

Commands:
Name Description
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0> <default>
COL
<label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
EXECUTE Executes the query
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
BY
GROUP Fetch first station by <groupId or *>
STATIONID Fetch record by <stationId>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT

[Link] 130/139
1/6/26, 5:01 PM [Link]
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
ISFUEL sets RC to 1 if fuel meter
ISVENT sets RC to 1 if Vent meter
HRPLIST puts csv list of HRP cols on stack

[END]

[STEXT] Top

Settings:
Name Description Default Value
VALUE Text Value
VISIBLE Is Visible False

Commands:
Name Description

[END]

[STRING] Top

Srting object that allows storage and manipulation. Strings can be

added to each other with the + operator.
eg.
set mystr value = mystring value + myotherstring value
set mystr value = mystring value + 1
set mystr value = mystring value + "a literal"
Clense removes all but 0 to 9, a to z, A to Z unless an optional argument is
given which contains extra allowable characters. If the string contains
spaces it must be in quotes. To include quotes, the quote must be escapped
with an \ To include a \ use two of them \\
eg.
mystr Clense +*-
mystr Clense "+ -"
mystr Clense "\""
mystr Clense "\t\n"
Split, Append, and Trim, Replace, Clense accept \t and \n as characters
Settings:
Name Description Default Value
VALUE User Declared String
COUNT Number of Parts of the string 0
INCLUDEEMPTY Include Empty parts when splitting True
LENGTH Length of the string 0
RC Return Code from last operation True

[Link] 131/139
1/6/26, 5:01 PM [Link]

Commands:
Name Description
SPLIT split into parts based upon <token>
PART part the string into parts of <length>
MAKE Remake from modified parts (<token>)
CLENSE Clense of all bad characters (<allowable_chars>)
DELETE Delete part of a string by <PartNumber>
CONTAINS Check if the string contains <token> (result in RC and on stack)
STARTSWITH Check if the string starts with <token> (result in RC and on stack)
ENDSWITH Check if the string ends with <token> (result in RC and on stack)
REPLACE Replace <token1> with <token2>
SUBSTR Puts sub string on stack <startPos> <endPos>
FIND Puts position of substring on stack <startPos> <tok>
AT Puts character at <startPos> on stack
RESIZE Resize string truncating to new <length>
REMOVE Remove # of chars from beginning <number>
APPEND
CHAR append character ie(\n \t 0x0d 0x0a)
TRIM Trim <char> from ends (case sensitive)
ISNUMBER Is it a number (result in RC and on stack)
ISDECIMAL does string have decimals (result in RC and on stack)
ISTIMESTAMP Is it a timestamp (result in RC and on stack)
TOUPPER To upper case
TOLOWER To lower case

[END]

[SVALUE] Top

Settings:
Name Description Default Value
VALUE RTDB Value
VISIBLE Is Visible True
DECIMALS Num Decimal Places 1853161472

Commands:
Name Description

[END]

[TICKET] Top

A Data access object that can be use for importing tickets

or fetching tickets from the database
Settings:
Name Description Default Value
DBSTYLE <AUTO|HIST|CFG> HIST
DBTYPE <MSSQL|MARIADB|FIREBIRD> MSSQL
CONNECTION External DB connection object <dbconnection obj>

[Link] 132/139
1/6/26, 5:01 PM [Link]
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 52
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes False
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
LASTERROR Last error

Commands:
Name Description
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
BY
STATIONID Create new ticket for <StationId> (<TimeOn>)
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
REMOVE
COL Remove <colName> from the query
ROW Removes the current record from the model
WHERE Removes the where clause optionally by (<colName>)
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL

[Link] 133/139
1/6/26, 5:01 PM [Link]
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
BY
STATIONID
TIMESTAMP Fetch ticket by <StationId> <timestamp>
RANGE Fetch tickets by <StationId> <start_timestamp> <end_timestamp>
TICKETID Fetch ticket by <TicketId>
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)
CALC Calcs the ticket
CLOSETICKET Closes the Ticket and Saves It
SAVE Saves the ticket
TOHTML Creates Ticket Report in HTML Format <stringobj>

[END]

[USERTAGCFG] Top

Settings:
Name Description Default Value
DBSTYLE <AUTO|HIST|CFG> CFG
DBTYPE <MSSQL|MARIADB|FIREBIRD> FIREBIRD
CONNECTION External DB connection object <dbconnection obj>

[Link] 134/139
1/6/26, 5:01 PM [Link]
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 7
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes True
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 10000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True

Commands:
Name Description
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0> <default>
COL
<label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS

[Link] 135/139
1/6/26, 5:01 PM [Link]
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
BY
NAME Fetch by (<TagName>)
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLNAME
(<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc <ColNum>
COLLABEL
(<obj>)

[END]

[VAPORPRES] Top

This object allows users to Vapor Pressure for Hydrocarbon Products

Settings:
Name Description Default Value
DENSITY Density (kg/m3) 690.00
TEMP Temperature (DegC) 0.00
VP Vapor Pres (kPaA) 0.00
VP100 Vapor Pres at 100DegC (kPaA) 0.00
RC Calc Return 1 = GOOD 0
STATUS Calc Status INITIALIZED

Commands:
Name Description
CALCPURE Calc VP for Pure Vapor Pressure
CALCVP Calc VP from VP100
CALCVP100 Calc VP100 from VP

[END]

[Link] 136/139
1/6/26, 5:01 PM [Link]

[VARIANT] Top

Variant object that allows storage and manipulation of any basic data type
such as strings, ints, floats, etc. They can be manipulated with operators
and conditionals such as + - > <
Clense removes all but 0 to 9, a to z, A to Z unless an optional argument is
given which contains extra allowable characters. If the string contains
spaces it must be in quotes. To include quotes, the quote must be escapped
with an \ To include a \ use two of them \\
eg.
mystr Clense +*-
mystr Clense "+ -"
mystr Clense "\""
mystr Clense "\t\n"
Settings:
Name Description Default Value

Commands:
Name Description
CLENSE Clense of all bad characters (<allowable_chars>)
ABS Change to Absolute value

[END]

[WELLTEST] Top

Settings:
Name Description Default Value
DBSTYLE <AUTO|HIST|CFG> HIST
DBTYPE <MSSQL|MARIADB|FIREBIRD> MSSQL
CONNECTION External DB connection object <dbconnection obj>
NUM
ROWS Number of Rows in the model 0
COLS Number of Cols in the model 47
FETCH Number of Fetches made 0
TRANSPOSE Transpose row and col when writing to spreadsheet False
USEISO8601 ISO8601 has T between date and Time False
AUTOCLEAR Auto Clear data on new Execute True
ISCHANGE Indicates if selected row has changed False
ISNEWROW Indicates if selected row is new False
ISUPDATEONFAIL Does an update if insert failes True
SETASENCRYPTED Enable/Disable encryption for columns when setting data depending on schema True
GETASENCRYPTED Enable/Disable encryption for columns when getting data depending on schema True
SELECTED
ROW Currently selected row (base 0) -1
TOP Sets Top in Select Statement ( 0) 0
WHERE
OVERRIDE Custom Where Cluase
MIN
FETCHTIME Minimum Fetch Time (ms) 0
MAX
[Link] 137/139
1/6/26, 5:01 PM [Link]
FETCHTIME Maximum Fetch Time (ms) 0
ROWS Maximum Rows allowed in fetch 100000
AVG
FETCHTIME Average Fetch Time (ms) 0
ALLOW
ROLLBACK Allow rollback of unsaved changes False
ROLE User Role Restrictions
OK Indicates Object is OK to use True
RC Return Code from last operation True
LASTERROR Last error

Commands:
Name Description
ADD
WHERE Add Where Clause <colName> <=|==|!=|>|<|<>|~=> <value> (<value2>)
ORDER Add <orderCol><desc|asc>
ROW Adds row to the end and loads the record
BY
STATIONID Create new WellTest for <testwellId> <testmeterId> (<Time>)
WELLTESTOBJ Create new WellTest for <testWellObj>
<colName> <colType(bit|i16|i32|dbl|string|timestamp> <isVirtual(1|0)> (<width> <isRO 1|0>
COL
<default> <label> <min> <max> <tagName> <isStn>)
ALIAS <colName> <colAlias>
ENUM <colName> <enumStr> <enumVal>
DUPLICATE
ROW Adds row to the end based on current record and loads it
DUMPDEBUG Dumps the current record to Debug
DISABLE
ALL
SIGNALS Disable/Enable all Signals <TRUE|FALSE|1|0>
SAVE Saves any changes to the database
DELETE
ROW Deletes the current record from the database
ROLLBACK Rollback unsaved changes
CLEAR Clears the data and the query
FETCH
XLS
HEADER Fetch Header data to <XLS sheet> (<row> <col>)
DATA Fetch All data to <XLS sheet> (<row> <col>)
ALL Fetch Header and All data to <XLS sheet> (<row> <col>)
FIRST
ROW Fetch first row of data into named properties under data heading
NEXT
ROW Fetch next row of data into named properties under data heading
PREVIOUS
ROW Fetch previous row of data into named properties under data heading
LAST
ROW Fetch last row of data into named properties under data heading
BY
STATIONID Fetch Last WellTest by <testewellId>
ROW Fetch row of data into named properties under data heading by <rowNum> | <Col> <Value>
ACTIVE Fetch Active WellTests

[Link] 138/139
1/6/26, 5:01 PM [Link]
BY
STATIONID
TIMESTAMP Fetch WellTests by <testwellId> (<timestamp>)
TOSTRING Put current record into <string obj>
FROMSTRING Import record from <string obj>
EXPORT
XLS Export to XLS file <XLS sheet>
IMPORT
XLS Import XLS file <XLS sheet> (<startRow>)
VALIDATE
ROW Validate current record or optional (<row>), result in RC
ALL Validate All Rows, result in RC
Get column name by index. Pushes value to stack optionally to given object. Result in rc
COLNAME
<ColNum> (<obj>)
Get column label by index. Pushes value to stack optionally to given object. Result in rc
COLLABEL
<ColNum> (<obj>)
START Starts the Current WellTest
NOTIFY Notify When Purge Complete
FORCEEND Forces the End of the Test
ACCEPT Accepts a Test
REJECT Rejects a Test

[END]

[XLS] Top

Settings:
Name Description Default Value
PATH File Path (not name) tmpObj
NAME File Name (path and ext. optional) tmpObj
FONT
BOLD <true | false> False
ITALIC <true | false> False
COLOR <number from 8 to 63> 8
NAME font Arial
SIZE font style 10
RC Return code from last operation False

Commands:
Name Description
ADDSHEET <sheet_name>
SAVE save named object to the specified path as a .xls
OPEN open existing .xls file

[END]

[Link] 139/139