General information about XML protocol

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

XML package has the <TransactionBlock> basic tag. Separate xml package is sent to the 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 sent package is follows.

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

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

It's required to foresee an automatic connection repairing in case of disconnecting when the TCP protocol is in use.

Required tags of xml-package:

FunctionNumber – number of function.
TransactionTimestamp (conditionally required tag) – event time specified in yyyy-mm-ddThh:nn:ss.fff format. If the TransactionTimestamp tag is missing in the package, than time of package receipt is recording to the database except of event time.
The following symbols are in use:
yyyy - year as four-digit number.
mm- month in range from 01 to 12.
dd - day of the month in range from 01 to 31.
hh - hour in 24-hours format from 00 to 23.
nn - minutes in range from 00 to 59.
ss - seconds in range from 00 to 59.
fff - second thousandths (millisecond) in value of date and time.

Separate elements of XML package by line separators (consecutive 0xD, 0xA symbols). It's more convenient to do when system debugging (when using the xml_test.exe utility, see the Configuring xml_titles.txt settings file section).

Total number of parameters is not limited. Parameter names are without spaces. Received data are displaying in the screen as captions and recording to a database for further analysis.

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

All received data are recording to POS_LOG_MASTER and POS_LOG_DETAIL tables.

Default name of receipts database is pos, MS SQL Server 2008 is in use.

Page tree

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