TUBT List API

This API allows you to recall previous transactions (called TUBT) that have been attempted. Most API calls internally generate one or more TUBT packets which alter the state of the Point of Sale.

Input Arguments

Arg#	Name	Type	Description
3		's'	Required. Constant 'retailmax.elink.tubt.list'
9		's'	Predicates to select data to return.
8		'E'	Maximum rows to return.
101		'E'	Selection mode. Set to 1 to retrieve actual TUBT contents, 0 returns headers only

When calling this API a single TUBT code is typically supplied so that only transactions of a certain type are returned. The transaction code can be encoded with a predicate like

	&9=f110,0,NNN

Where NNN is the transaction code required.

If you wish to select record for a single key value, such as only changes to Pid 123, then a predicate can be supplied that is applied to each source transaction. The general form of this is

	&9=DATS.f100,0,NNN

This predicate is applied to the data packet. See examples below for further examples.

Output Arguments

The output of this API is an array of FILE packets, and each FILE block may then contain TUBT packets that represent each individual transaction

FILE Packet

Arg#	Name	Description
f1110	File	Actual filename on the server

TUBT Packet

A TUBT packet is a standard wrapper around an actual transaction. It is designed to have enough information to allow routing and processing, but does not contain any actual work directly

Arg#	Name	Description
f110	tCode	Transaction Code. A unique number that identifies the transaction type within a schema.
f111	Schema	A number allocated by Fieldpine that indicates the family this transaction belongs too. The values f111 and f110 together uniquely identify transactions to their defining metadata. Common values seen: 4 Meetu4 8 Fieldpine POS 9 Fieldpine Retail Logic
f105	Physkey	Unique key identifying this single transaction
f107	RmSystem	Claimed RmSystem indicating which retailer/database this transaction is intended for.
f104	GenDt	Date/Time this message was originally generated
f114	SecurityId	Key to security information recording who generated this transaction

Notes

Codes and descriptions of TUBT packets can be found under Reference Data

Fieldpine reports use a Javascript wrapper to access this API. See /elink/eLinkHistory.js for technical details. While not specifically documented, there are several examples in the standard reports showing how it can be used.

Examples

Select all staff edit transactions performed. Staff Edit TUBT is code 422, schema 8.

/gnap/buck?3=retailmax.elink.tubt.list&9=f110,0,422&9=f111,0,8

Result:

<ARAY>
<FILE>
  <File>E:\customers\live_data\TUBT_IT8LVUP8KQ84GQA_1_20160610.DATI</File>
  <f120>00-1D-09-D2-1B-99</f120>
  <f121>2016|6|10|17|50|18||</f121>
  <f122>2016|6|10|5|50|18||</f122>
  <TUBT>
    <f110>422</f110>
    <f111>8</f111>
    <f104>2017|1|5|6|7|0||</f104>
    <f105>KQPQAAAADUE8EG9ZADAHAEAAAABQAAAB</f105>
    <f107>6,3,2,2</f107>
    <f101>IT8LVUP8KQ84GQA</f101>
    <f113>A0783ab9d</f113>
    <f114>KEPYISIADUE8EG9ZKFGLIDYAAABABQCT</f114>
    <DATS>
      <f11>69</f11>
      <f100>10</f100>
      <f101>Jim</f101>
      <f102>1</f102>
      <f107/>
      <f130>jem@xtra</f130>
      <f131/>
    </DATS>
  </TUBT>
  <TUBT>
    <f110>422</f110>
    <f111>8</f111>
    <f104>2017|1|5|6|8|48||</f104>
    <f105>KQPQAAAADUE8EG9ZAAYHAEAAAACQAAAB</f105>
    <f107>6,3,2,2</f107>
    <f101>IT8LVUP8KQ84GQA</f101>
    <f113>A0783ab9d</f113>
    <f114>KEPYISIADUE8EG9ZKFGLIDYAAABABQCT</f114>
    <DATS>
      <f11>69</f11>
      <f100>10</f100>
      <f101>Jim</f101>
      <f102>1</f102>
      <f130>jim@example.com</f130>
    </DATS>
</TUBT>
</FILE>
</ARAY>

Select all staff edit transactions performed against tid=123. Staff Edit TUBT is code 422.