 |
Command:
ARTICLES
 |
Node: articles |
|
Mandatory: |
no |
|
max. Occurrence: |
unbounded |
|
Description: This tag is used as container for commands regarding articles.
|
|
 |
|
|
 |
Node: article |
|
Mandatory: |
yes |
|
max. Occurrence: |
unbounded |
|
Supported modes: |
delete Delete the named item. deleteall Delete all items. read Read the named item. read+ Read the following item. read- Read the previous item. readall Read all items from the desired device(s). This doesn't mean comparable reading as in the L2 protocol. write Write the named item.
|
|
Description: This command is used for creating, manipulating or deleting articles.
|
|
Notes: For the mode ''readall'' the following information can be helpful: The table below shows values for the mandatory elements.
<department_no> |
<plu_no> |
Comment |
0 |
0 |
All articles/items of all departments will be returned. |
0 |
unequal 0 |
All articles/items of all departments whose plu numbers are greater or equal than the value of <plu_no> will be returned. |
unequal 0 |
0 |
All articles/items that are belonging to the desired deparment number will be returned. |
unequal 0 |
unequal 0 |
All articles/items of the desired department whose plu numbers are greater or equal than the value of <plu_no> will be returned. |
For the mode ''deleteall'' the following information can be helpful: The table below shows values for the mandatory elements.
<department_no> |
<plu_no> |
Comment |
0 |
0 |
All articles/items of all departments will be deleted. |
0 |
unequal 0 |
All articles/items of all departments will be deleted. |
unequal 0 |
0 |
All articles/items that are belonging to the desired deparment number will be deleted. |
unequal 0 |
unequal 0 |
All articles/items that are belonging to the desired deparment number will be deleted. |
If an article/item is deleted then its entries set by the listed commands will be deleted too
<articles_per_special_offers>,
<articles_per_forward_prices>,
<articles_ingredients>,
<article_images>,
<article_specific_labels>,
<article_promotions>,
<article_special_offers>,
<article_forward_prices>,
<quantity_dependent_prices>
|
|
 |
|
|
|
 |
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.
|
|
Notes: The manual plus , manual minus hand and enter unit price operations are treated as plu's. By default (desribed in customer.ini) the PLU no 999 999 is used as manual plus, 999 998 as manual minus and 999 997 as enter
unit price. Its number can be changed in the file customer.ini.
|
|
 |
|
|
|
 |
Tag: uan |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
string |
|
Range: |
max. 13 characters
|
|
Nillable: |
no |
|
Description: The unique article number. Necessary to identify the article
|
|
 |
|
|
|
 |
Tag: name |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
string |
|
Range: |
max. 100 characters
|
|
Nillable: |
no |
|
Description: The name of the article/item.
|
|
 |
|
|
|
 |
Tag: shortname |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
string |
|
Range: |
max. 40 characters
|
|
Nillable: |
no |
|
Description: A short version of the name. It can be useful for printing the article/item name on labels, buttons, ...
|
|
Notes: If this information is missing then you get with the Read-Modes NOT the value 0 but an EMPTY Tag
|
|
 |
|
|
|
 |
Tag: matchcode |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
string |
|
Range: |
max. 100 characters
|
|
Nillable: |
no |
|
Description: A string that identifies an article/item. It will be used wenn selecting items not only by its PLU number but also by characters.
|
|
Notes: The range of values has been increased from 20 to 100 characters with version V1.15.0. This information is not used by the ETICA. It will only be stored.
|
|
 |
|
|
|
 |
Tag: customer_id |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
string |
|
Range: |
max. 20 characters
|
|
Nillable: |
no |
|
Description: A string for the customer to identify the article/item by its own 'number'.
|
|
Notes: This information is not used by the ETICA. It will only be stored.
|
|
 |
|
|
|
 |
Tag: customer_article_number |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
string |
|
Range: |
max. 20 characters
|
|
Nillable: |
no |
|
Description: Customer specific article number that allows a customer to identify an article/item by its own definition.
|
|
Notes: This tag is supported with version 1.15.2 and higher.
|
|
 |
|
|
|
 |
Tag: customer_article_number_2 |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
string |
|
Range: |
max. 20 characters
|
|
Nillable: |
no |
|
Description: Second customer specific article number that allows a customer to identify an article/item by its own definition.
|
|
Notes: This tag is supported with version 1.19.1 and higher.
|
|
 |
|
|
|
 |
Tag: price1 |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
-9 999 999 - +99 999 999
|
|
Nillable: |
no |
|
Description: The first price of the article. 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: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
-9 999 999 - +99 999 999
|
|
Nillable: |
no |
|
Description: The second price of the article. The price is stored as an integer value. The number of decimal places is stored in the countrysettings (22,55 Euro = 2255).
|
|
Notes: The second price can be used by configuring a 'Price2Key' on the
<keyboard_layout_configurations>.
This information is not used by the ETICA. It will only be stored.
|
|
 |
|
|
|
 |
Tag: article_group_no |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
1 - 9 999
|
|
Nillable: |
no |
|
Description: The number of the article group the article/item is belonging to.
|
|
 |
|
|
|
 |
Tag: vat1_no |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
0 - 9 999
|
|
Nillable: |
no |
|
Description: The number of the VAT for <price1>.
|
|
Notes: This information is not used by the ETICA. It will only be stored.
|
|
 |
|
|
|
 |
Tag: vat2_no |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
0 - 9 999
|
|
Nillable: |
no |
|
Description: The number of the vat for <price2>.
|
|
Notes: This information is not used by the ETICA. It will only be stored.
|
|
 |
|
|
|
 |
Tag: purchase_price |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
-9 999 999 - 99 999 999
|
|
Nillable: |
no |
|
Description: The purchase price of the article/item.
|
|
Notes: If this information is missing then you get with the Read-Modes NOT the value 0 but an EMPTY Tag This information is not used by the ETICA. It will only be stored.
|
|
 |
|
|
|
 |
Tag: price_flag |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
flagType |
|
Range: |
(0/1)
|
|
Nillable: |
no |
|
Description: Allow or disallows price change in the application.
Value |
Description |
0 |
It is not allowed to change the price.
|
1 |
It is allowed to change the price. |
|
|
Notes: This information is not used by the ETICA. It will only be stored.
|
|
 |
|
|
|
 |
Tag: locked_flag |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
flagType |
|
Range: |
(0/1)
|
|
Nillable: |
no |
|
Description: Locks or unlocks the article/item. If an article/item is locked then it can't be used for registrations.
Value |
Description |
0 |
The item is not locked.
|
1 |
The item is locked. |
|
|
Notes: If this information is missing then you get with the Read-Modes NOT the value 0 but an EMPTY Tag This information is not used by the ETICA. It will only be stored.
|
|
 |
|
|
|
 |
Tag: discount_flag |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
flagType |
|
Range: |
(0/1)
|
|
Nillable: |
no |
|
Description: Allows or disallows the assignment of markups or discounts.
Value |
Description |
0 |
A discount is not allowed.
|
1 |
A discount is allowed. |
|
|
Notes: This information is not used by the ETICA. It will only be stored.
|
|
 |
|
|
|
 |
Tag: smiley |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
0 - 3
|
|
Nillable: |
no |
|
Description: Displays a smiley on the display of the operator.
Value |
Description |
0 |
No smiley. |
1 |
laughing smiley :-). |
2 |
wheeping smiley :-(. |
3 |
The face of the smiley is depending on the margin. |
|
|
Notes: Right now the value 3 is not supported by UC3. This information is not used by the ETICA. It will only be stored.
|
|
 |
|
|
|
 |
Tag: smiley_limit_high |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
1 - 9 999
|
|
Nillable: |
no |
|
Description: The limit between laughing and neutral smiley in %. The value is always stored with 2 decimal places, e.g. 23.45% is 2345.
|
|
Notes: If this information is missing then you get with the Read-Modes NOT the value 0 but an EMPTY Tag This information is not used by the ETICA. It will only be stored.
|
|
 |
|
|
|
 |
Tag: smiley_limit_low |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
1 - 9 999
|
|
Nillable: |
no |
|
Description: The limit between wheeping and neutral smiley in %. The value is always stored with 2 decimal places, e.g. 23.45% is 2345.
|
|
Notes: If this information is missing then you get with the Read-Modes NOT the value 0 but an EMPTY Tag This information is not used by the ETICA. It will only be stored.
|
|
 |
|
|
|
 |
Tag: extratext_mode |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
0 - 3
|
|
Nillable: |
no |
|
Description: Select a mode how to deal with the extratext of the article/item.
Value |
Description |
0 |
Do not use extratext. |
1 |
Show extratext. |
2 |
Show and print extratext. |
3 |
Let the operator decide. |
|
|
Notes: This information is not used by the ETICA. It will only be stored.
|
|
 |
|
|
|
 |
Tag: extratext_no |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
1 - 999 999
|
|
Nillable: |
no |
|
Description: The number of the extratext assigned to the article/item.
|
|
Notes: With version 1.1.2 the range changed form "1 - 9 999" to "1 - 999 999" This information is not used by the ETICA. It will only be stored.
|
|
 |
|
|
|
 |
Tag: tare_no |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
1 - 9 999
|
|
Nillable: |
no |
|
Description: The number of the tare that shall be assigned for this article/item.
|
|
Notes: For creating a tare have a look on the command
<tares>.
|
|
 |
|
|
|
 |
Tag: tare_no2 |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
1 - 9 999
|
|
Nillable: |
no |
|
Description: The number of the second tare that shall be assigned for this article/item.
|
|
Notes: For creating a tare have a look on the command
<tares>. This tag is supported with version 1.28.0 and higher.
|
|
 |
|
|
|
 |
Tag: plu_type |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
0 - 14
|
|
Nillable: |
no |
|
Description: 0 = Item sold by weight with standard baseunit (1kg/lb) 1 = Item sold per piece 2 = Fixed weight (ETICA only) 3 = Fixed weight/fixed price (ETICA only) 4 = Fixed Weight 5 = Fixed Weight Override 6 = Fixed Piece 7 = Fixed Piece Override 8 = Fixed Volume 9 = Fixed Volume Override 10 = Piece Convertible to weight (or Bread for singles) 11 = Piece, Fixed Weight 12 = Piece, Fixed Weight, Unit Price calculated 13 = Piece, weighed 14 = Piece, weighed, Unit Price calculated
|
|
Notes: The plu types 2 and 3 are not supported by the UC3. For detailed information have a look at the documentation of ETICA. The plu types 4 - 14 are not supported by the ETICA. If this information is missing then the value 0 will be set automatically when selecting the plu for the first time. The values 4 - 10 are supported by UC3 with version V1.6.0 and higher. The values 11 - 14 are supported by UC3 with version V1.22.0 and higher.
|
|
 |
|
|
|
 |
Tag: traceability_code |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
-1 - 5
|
|
Nillable: |
no |
|
Description: Traceability code.
Value |
Description |
1 or nothing |
Article group rule apply for this PLU. |
0 |
No traceability. |
1 |
Optional in PLU article group. |
2 |
Mandatory in plu article group. |
3 |
Optional in department. |
4 |
Mandatory in department. |
5 |
Fixed (default value selected by PLU). |
|
|
Notes: This information is not used by the UC3. It will only be stored.
|
|
 |
|
|
|
 |
Tag: last_used_lot_reference |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
string |
|
Range: |
max. 40 characters
|
|
Nillable: |
no |
|
Description: Reference to the last used lot when using traceability as provided by the Etica.
|
|
Notes: This information is not used by the UC3. It will only be stored.
|
|
 |
|
|
|
 |
Tag: qrdata |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
string |
|
Range: |
max. 100 characters
|
|
Nillable: |
no |
|
Description: Data that can be encoded into a QR code. This data are used within a data source (value ItemQRData) of a QR code definition.
|
|
 |
|
|
|
 |
Tag: nutrition_no |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
1 - 999 999
|
|
Nillable: |
no |
|
Description: The number (ID) of the nutrition fact information. See nutrition fact definition.
|
|
 |
|
|
|
 |
Tag: delete_date |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
date |
|
Range: |
- |
|
Nillable: |
yes |
|
Description:
Date when the article/item shall be deleted.
As soon as the date becomes valid the article is deleted (except there exists a delete date offset).
CCYY-MM-DD The format is as following: C = Century Y = Year M = Month D = Day
|
|
Notes: This tag is supported with version 1.26.0 and higher.
|
|
 |
|
|
|
 |
Tag: delete_date_offset |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
0 - 999
|
|
Nillable: |
no |
|
Description:
The number of days that will be added to the tag <delete_date> as date when the article/item will be deleted effective.
If no offset is defined the article/item will be deleted at the date set in tag <delete_date>.
Example:
The delete date is set to 2014-05-02 and the offset for the delete date is set to 7.
The effective date to delete the article/item is 2014-05-09.
The necessity to have an offset to the delete date is based on the fact that customers have different sources for the data.
In some cases general article/item maintenance is outsourced to subcontractors. Price management and the control itself is
done by customer.
|
|
Notes: This tag is supported with version 1.26.0 and higher.
|
|
 |
|
|
|
 |
Tag: last_change |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
dateTime |
|
Range: |
- |
|
Nillable: |
yes |
|
Description: 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 = minute s = second
|
|
 |
|
|