 |
Command:
EVENT TAFS
 |
Node: event_tafs |
|
Mandatory: |
no |
|
max. Occurrence: |
unbounded |
|
Description: This tag is used as container for commands regarding the event transaction file.
|
|
 |
|
|
 |
Node: event_taf |
|
Mandatory: |
yes |
|
max. Occurrence: |
unbounded |
|
Supported modes: |
delete Delete the named item. deleteall Delete all items. deletelower Delete the taf entries from the sequence number 0 till the named sequence number. read Read the named item. read+ Read the following item. readall Read all items from the desired device(s). This doesn't mean comparable reading as in the L2 protocol.
|
|
Description: This command is used for reading or deleting entries in the event transaction file. The event TAF contains transactions that can't be assigned to processes originated from the sales modes (prepack mode, selfservice
mode, ...). The could be the event around a cash drawer.
|
|
 |
|
|
|
 |
Tag: device_no |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
1 - 999
|
|
Nillable: |
no |
|
Description: The number of the device that caused this entry.
|
|
 |
|
|
|
 |
Tag: sequence_no |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
1 - 2 147 483 647
|
|
Nillable: |
no |
|
Description: A continuous number for each TAF entry. Its value is starting with 1 and will never be reseted. Only a new version of a database file will reset this value. The sequence number can be used to get a unique entry point for reading or deleting TAF contents.
|
|
 |
|
|
|
 |
Tag: event_date |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
dateTime |
|
Range: |
- |
|
Nillable: |
yes |
|
Description: Date and time when the event happened. CCYY-MM-DDThh:mm:ss The format is as following: C = Century Y = Year M = Month D = Day T = Separator between date and time h = hour m = month s = second
|
|
 |
|
|
|
 |
Choice: |
|
|
|
|
 |
Node: cash_drawer |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Description: Information about a change in the status of the cash drawer.
|
|
 |
|
|
|
|
|
 |
Choice: |
|
|
|
|
|
|
 |
Node: open_request |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Description: The request of the application to open the cash drawer.
This request doesn't mean the cash drawer has been opened. Only if there is an event 'opened' following this event then the
cash drawer has been opened.
If the event 'opened' is missing then maybe a cash drawer isn't connected to the device or it may be locked.
|
|
 |
|
|
|
|
|
|
|
 |
Tag: reason |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
string |
|
Range: |
RECEIPT
|
|
Nillable: |
no |
|
Description: The reason why there was a request for opening the cash drawer.
Reason |
Comment |
RECEIPT |
The reason for the request was the printout of a receipt/label. |
|
|
 |
|
|
|
|
|
|
|
 |
Tag: info |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
string |
|
Range: |
- |
|
Nillable: |
no |
|
Description: Additional information about the reason. Depending on the value of <reason> the additional information can be:
<reason> |
Additional Information |
RECEIPT |
Receipt number of the receipt that caused the open request. |
|
|
 |
|
|
|
|
|
|
|
|
|
|
|
|
 |
Node: opened |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Description: The cash drawer has been opened. If there is an entry 'open_request' directly before this event then the cash drawer has been opened automatically by the cash
register application. If the entry 'open_request' is missing then the cash drawer has been opened manually.
|
|
 |
|
|
|
|
|
|
|
|
|
|
|
|
 |
Node: closed |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Description: The cash drawer has been closed.
|
|
 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
 |
Node: coin_count |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Description: Information about events happened during a coin count session.
|
|
 |
|
|
|
|
|
 |
Choice: |
|
|
|
|
|
|
 |
Node: entered |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Description: Coin count mode has been entered.
|
|
 |
|
|
|
|
|
|
|
|
|
|
|
|
 |
Node: total |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Description: The cash drawer has been closed.
|
|
 |
|
|
|
|
|
|
|
 |
Tag: amount |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
0 - 999 999 999
|
|
Nillable: |
no |
|
Description: The amount of a coin count session.
The value is represented in the minor unit/subunit i.e. Cent for the Euro or Penny for the British Pound.
The number of decimals places of this currency is provided in the tag <decimals>.
|
|
 |
|
|
|
|
|
|
|
 |
Tag: currency_code_long |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
string |
|
Range: |
max. 50 characters
|
|
Nillable: |
no |
|
Description: Name of the currency.
This is the name which has been set when creating a tender.
|
|
Notes: This tag is supported with version 1.27.0 and higher.
|
|
 |
|
|
|
|
|
|
|
 |
Tag: currency_code_short |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
string |
|
Range: |
max. 3 characters
|
|
Nillable: |
no |
|
Description: Short name of the currency.
This is the short name which has been set when creating a tender.
|
|
Notes: This tag is supported with version 1.27.0 and higher.
|
|
 |
|
|
|
|
|
|
|
 |
Tag: decimals |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
0 - 3
|
|
Nillable: |
no |
|
Description: The number of decimals places of this currency.
|
|
Notes: This tag is supported with version 1.27.0 and higher.
|
|
 |
|
|
|
|
|
|
|
|
|
|
|
|
 |
Node: leaved |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Description: Coin count mode has been left.
|
|
 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
 |
Node: cash_register_report_summary |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Description: A summary about a printed cash register report.
|
|
 |
|
|
|
|
|
 |
Tag: amount |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
0 - 999 999 999
|
|
Nillable: |
no |
|
Description: The amount of money that should be inside the cash drawer.
|
|
 |
|
|
|
|
|
|
|
|
 |
Node: non_sales_mode_user |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Description: Information about a NSM user.
|
|
 |
|
|
|
|
|
 |
Tag: user_id |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
string |
|
Range: |
max. 20 characters
|
|
Nillable: |
no |
|
Description: Description about the code type. Following code types are definied: Administrator Code 4444 Code 333 Code 22 Code 99 Code 8 Code 1 Code 7 Code 77 Code 999 Code 666666
|
|
Notes:
User ID |
definition |
Administrator |
all NSM menus |
Code 4444 |
configuration |
Code 333 |
turnovers |
Code 22 |
intermediate turnovers |
Code 99 |
keyboard configuration |
Code 8 |
price changes |
Code 1 |
data maintenance |
Code 7 |
cash register functions |
Code 77 |
cash register reports |
Code 999 |
service alerts |
Code 666666 |
receipt void |
|
|
 |
|
|
|
|
|
 |
Choice: |
|
|
|
|
|
|
 |
Node: password |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Description: A new password has been assigned to the NSM user identified by user_id.
The password is for security reasons not listed at this place.
|
|
 |
|
|
|
|
|
|
|
|
|
|
|
|
 |
Node: default_password |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Description: The default password defined by Mettler-Toledo has been assigned to the NSM user identified by user_id.
|
|
 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
 |
Node: operator_recording |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Description: Information about logon/logoff of an operator.
|
|
Notes: This tag is supported with version 1.18.0 and higher.
|
|
 |
|
|
|
|
|
 |
Choice: |
|
|
|
|
|
|
 |
Node: logon |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Description: The operator has done a logon on a device. This event might occcur several times for the same operator with different floating clerk groups and/or application types.
|
|
 |
|
|
|
|
|
|
|
 |
Tag: operator_key_no |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
1 - 999
|
|
Nillable: |
no |
|
Description: The number of the operator key the operator is logged on.
|
|
 |
|
|
|
|
|
|
|
 |
Tag: floating_clerk_group |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
1 - 9 999
|
|
Nillable: |
no |
|
Description: The number of the floating clerk group the operator has done a logon.
|
|
 |
|
|
|
|
|
|
|
 |
Tag: application_type |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
0 - 4
|
|
Nillable: |
no |
|
Description: The application type.
Value |
Description |
0 |
Sales application |
1 |
Cash register application |
|
|
 |
|
|
|
|
|
|
|
 |
Tag: operator_no |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
1 - 999 999
|
|
Nillable: |
no |
|
Description: The number of the operator. See <operators>
|
|
 |
|
|
|
|
|
|
|
|
|
|
|
|
 |
Node: logoff |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Description: The operator has done a logoff on a device. This event might occcur several times for the same operator with different floating clerk groups and/or application types.
|
|
 |
|
|
|
|
|
|
|
 |
Tag: operator_key_no |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
1 - 999
|
|
Nillable: |
no |
|
Description: The number of the operator key the operator has logged off.
|
|
 |
|
|
|
|
|
|
|
 |
Tag: floating_clerk_group |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
1 - 9 999
|
|
Nillable: |
no |
|
Description: The number of the floating clerk group the operator has done a logoff.
|
|
 |
|
|
|
|
|
|
|
 |
Tag: application_type |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
0 - 4
|
|
Nillable: |
no |
|
Description: The application type.
Value |
Description |
0 |
Sales application |
1 |
Cash register application |
|
|
 |
|
|
|
|
|
|
|
 |
Tag: operator_no |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
1 - 999 999
|
|
Nillable: |
no |
|
Description: The number of the operator. See <operators>
|
|
 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
 |
Node: manual_price_change |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Description: Information about price changes that have been done manually on a scale.
|
|
Notes: This node is supported with version 1.22.0 and higher.
|
|
 |
|
|
|
|
|
 |
Tag: department_no |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
1 - 9 999
|
|
Nillable: |
no |
|
Description: The number of the department the article/item is belonging to.
|
|
 |
|
|
|
|
|
 |
Tag: plu_no |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
1 - 999 999
|
|
Nillable: |
no |
|
Description: The number of the article/item.
|
|
 |
|
|
|
|
|
 |
Tag: price1_old |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
-9 999 999 - +99 999 999
|
|
Nillable: |
no |
|
Description: Previous price 1 of the article/item before changing it. The price is stored as an integer value. The number of decimal places is stored in the countrysettings (22,55 Euro = 2255).
|
|
 |
|
|
|
|
|
 |
Tag: price2_old |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
-9 999 999 - +99 999 999
|
|
Nillable: |
no |
|
Description: Previous price 2 of the article/item before changing it. The price is stored as an integer value. The number of decimal places is stored in the countrysettings (22,55 Euro = 2255).
|
|
 |
|
|
|
|
|
 |
Tag: price1 |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
-9 999 999 - +99 999 999
|
|
Nillable: |
no |
|
Description: Price 1 of the article/item after changing it The price is stored as an integer value. The number of decimal places is stored in the countrysettings (22,55 Euro = 2255).
|
|
 |
|
|
|
|
|
 |
Tag: price2 |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
-9 999 999 - +99 999 999
|
|
Nillable: |
no |
|
Description: Price 2 of the article/item after changing it The price is stored as an integer value. The number of decimal places is stored in the countrysettings (22,55 Euro = 2255).
|
|
 |
|
|
|
|
|
|