Documentation for POS Intellect 5.4. Documentation for other versions of Intellect is available too.

Previous page Description of XML protocol  Control package Next page

XML protocol allows adding connectivity with POS Intellect operation control system to POS software developers if data of POS operations is sent as XML packages. This format allows transferring any number of significant parameters to a system and organizing their displaying on a video image and saving in a transaction database.

XML package has the <TransactionBlock> basic tag. Separate xml package is sent to Intellect for each POS operation. Each package should have the <TransactionBlock> start tag and the </TransactionBlock> end tag. So each POS operation has its presentation as XML package. Example of a sent package is shown in the figure.

All parameters are presented as a text. It's possible to use a period or a comma to separate a fractional part of a number. Converting to the required type is performed automatically.

POS program should send data to TCP, UDP or RS232 port (specified in the settings). Separate port is used for each POS.

When the TCP protocol is used, it's required to foresee an automatic connection recovery in case of connection loss.

Required tags of xml-package:

  1. FunctionNumber—number of a function.
  2. TransactionTimestamp (conditionally required tag)—event time specified in the yyyy-mm-ddThh:nn:ss.fff format. It is specified in the UTC+0 time zone. If the TransactionTimestamp tag is missing in the package, the time of the package receipt is written to the database instead of event time.
    The following symbols are used:
    yyyy—year as four-digit number.
    mm—month, in the range from 01 to 12.
    dd—day of the month, in the range from 01 to 31.
    hh—hour in 24-hours format from 00 to 23.
    nn—minutes, in the range from 00 to 59.
    ss—seconds, in the range from 00 to 59.
    fff—thousandths of a second (millisecond) in date and time values.

The element of the XML package must be separated by line separators (consecutive 0xD, 0xA characters). It's more convenient to do when debugging the system (when using the xml_test.exe utility, see Configuring xml_titles.txt settings file).

The total number of parameters is not limited. Parameter names must not contain spaces. Received data are displayed on the screen as captions and recorded to a database for further analysis.

The Intellect\Modules\Pos\xml_titles.txt file is used for settings (see Format of xml_titles.xml settings file).

All received data are recorded to the POS_LOG_MASTER and POS_LOG_DETAIL tables.

The default name of the receipts database is pos, MS SQL Server 2008 is used.

  • No labels