 |
Command:
PROOF OF ORIGIN TYPE DEFINITIONS
 |
Node: proof_of_origin_type_definitions |
|
Mandatory: |
no |
|
max. Occurrence: |
unbounded |
|
Description: This tag is used as container for commands regarding proof of origin definitions.
|
|
 |
|
|
 |
Node: proof_of_origin_type_definition |
|
Mandatory: |
yes |
|
max. Occurrence: |
unbounded |
|
Supported modes: |
delete Delete the named item. 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: The definition of a proof of origin type. The customer has the possibility to define different proof of origin types, e.g.
for beef, fish, ... that can be assigned to an article/item.
After the definition of the proof of origin type the customer is able to define
<proof_of_origin_lots>
refering this proof of origin type.
|
|
Notes: To use the proof of origin functionality on the device it is necessary to activate it.
"Proof of origin" is an option which needs a license key to be enabled (uc3options.xml).
The XML command will be processed by the device without a license key. The proof of origin functionality itself doesn't work without a license key.
It is possible to delete only one or more fields. For that add for each field the tag <proof_of_origin_child> and the subsequent element <field_no>. Set the value of the desired field(s) that shall be deleted in <field_no>. To delete the complete definition send the command without the tag <proof_of_origin_children> and it subsequent elements.
For the mode ''readall'' the value of the element <proof_of_origin_type> is decisive. The trace type definitions that are arranged subsequent will be returned, e.g. if the value of <proof_of_origin_type>
is 'bee' then beef, chicken, fish and pork are returned. The best way to get all proof of origin type definitions is to the send <proof_of_origin_type> without a value.
If a proof of origin definition is deleted its assigned lots set by the commands
<proof_of_origin_lots>
will be deleted, too. If a proof of origin definition is deleted the assignment of a definition to an article/item set by the commands
<article_proof_of_origin_assignments>
will be deleted, too. This doesn't have influence on the article/items created by using the command
<articles>
.
|
|
 |
|
|
|
 |
Tag: proof_of_origin_type |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
string |
|
Range: |
max. 20 characters
|
|
Nillable: |
no |
|
Description: The proof of origin type. This type will be used for assigning proof of origin lots to the type or for the assigment to an article/item or department.
|
|
 |
|
|
|
 |
Tag: name |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
string |
|
Range: |
max. 100 characters
|
|
Nillable: |
no |
|
Description: The name assigned to the proof of origin type. Sine the string in the tag <proof_of_origin_type> is typically existing out of 3 or 4 characters this name can be used for detailed information.
|
|
 |
|
|
|
 |
Tag: focus_field_no |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
1 - max. number of fields.
|
|
Nillable: |
no |
|
Description: The number of the field that gets the focus when displaying the mask with the proof of origin type data.
|
|
 |
|
|
|
 |
Tag: single_lot |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
0 - 2
|
|
Nillable: |
no |
|
Description:
Value |
Description |
0 |
Multiple lot
It is possible to assign more than one lot to a proof of origin type definition.
The desired lots have to be definied by using the command
Proof of origin lots.
|
1 |
Single lot
For this proof of origin type definition only one proof of origin lot is allowed. The name of the lot id has the same value as the proof of origin type.
Lots with other names will be ignored.
It's not necessary to define the single lot. It will be created automatically when the proof of origin type definition is
displayed in the application.
|
2 |
Auto lot id
For this proof of origin type definition the id of the proof of origin lot is generated automatically by the application when
it's used the first time.
Each scale will generate the lot ID locally by a formula that makes sure that the lot ID is unique in the scales network.
Also for this type, together with the packed-on and best-before date of the article, a date verification
and adjustments to the best-before or sell-by date can be done.
|
|
|
Notes: If this element is not set then the default is 0.
|
|
 |
|
|
|
 |
Node: proof_of_origin_children |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Description: This tags contains the fields defining a proof of origin type.
|
|
 |
|
|
|
|
 |
Node: proof_of_origin_child |
|
Mandatory: |
yes |
|
max. Occurrence: |
20 |
|
Description: Each child contains exactly the information of 1 field.
|
|
 |
|
|
|
|
|
 |
Tag: field_no |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
1 - max. number of fields.
|
|
Nillable: |
no |
|
Description: The number of the field. A mask can have up to 20 fields.
|
|
 |
|
|
|
|
|
 |
Tag: display_text_no |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
1 - 999 999
|
|
Nillable: |
no |
|
Description: The number of the text printed on the display when selecting the proof of origin type mask. It is the designator for the text that will be assigned by a lot, e.g. "Born in:". The number is refering to the texts created with the command <texts> . For that the text type of that command has been extended by the value 11.
|
|
 |
|
|
|
|
|
 |
Tag: label_text_no |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
1 - 999 999
|
|
Nillable: |
no |
|
Description: The number of the text printed on a label. It is the designator for the text that will be assigned by a lot, e.g. "Born in:". The number is refering to the texts created with the command <texts> . For that the text type of that command has been extended by the value 11.
|
|
 |
|
|
|
|
|
 |
Tag: text_type |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
0 - 21
|
|
Nillable: |
no |
|
Description: The type of text The assignment of a text type will be used for offering the customer a selection list of available texts when defining a lot. If no value is assigned the customer doesn't get a list of available texts. In this case he has to enter the text manually
when defining a lot. The number is refering to the texts created with the command <texts> . Therefore the text type of that command has been extended by the values 12 - 21.
|
|
 |
|
|
|
|
|
 |
Tag: overwrite_flag |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
flagType |
|
Range: |
(0/1)
|
|
Nillable: |
no |
|
Description: Defines whether it is allowed to the customer to overwrite the text of this field when showing the content of a lot in an
application mode.
Value |
Description |
0 |
It is not allowed to overwrite the content of this field.
|
1 |
It is allowed to overwrite the content of this field. |
|
|
Notes: If this element is not set then the default is 0.
|
|
 |
|
|
|
|
|
 |
Tag: taf_entry_flag |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
0 - 1
|
|
Nillable: |
no |
|
Description: Decides whether the content of this field will be used as part of the TAF entry.
Value |
Description |
0 |
Do not add the content to the TAF entry.
|
1 |
Add the content to the TAF entry. |
|
|
Notes: If this element is not set then the default is 0.
|
|
 |
|
|
|
|
|
 |
Tag: mandatory_flag |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
0 - 1
|
|
Nillable: |
no |
|
Description: Flag that indicates if it is mandatory to provide a valid content for this proof of origin type field
(traceability field) when a proof of origin lot is created/updated linked to the currently defined
proof of origin type definition.
Value |
Description |
0 |
It is not mandatory to provide data for the current proof of origin type field.
|
1 |
It is mandatory to provide data for the current proof of origin type field. |
|
|
Notes: If this element is not set then the default is 0.
|
|
 |
|
|
|
 |
Tag: show_lot_list |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
0 - 1
|
|
Nillable: |
no |
|
Description: Define whether the application displays lots list first or not.
Value |
Description |
0 |
Does not show lot list first.
|
1 |
Show lot list first. |
|
|
Notes: If this element is not set then the default is 0.
|
|
 |
|
|
|
 |
Tag: allow_create_lot |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
0 - 1
|
|
Nillable: |
no |
|
Description: Define whether it is allowed to the application to create lots by itself.
Value |
Description |
0 |
Does not allow the creation of new lots.
|
1 |
Allows the creation of new lots. |
|
|
Notes: If this element is not set then the default is 1.
|
|
 |
|
|
|
 |
Tag: linked_to |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
0 - 1
|
|
Nillable: |
no |
|
Description: Define which last used lot will be preselected the next time the article is booked.
Value |
Description |
0 |
Last used lot of the article is preselected. |
1 |
Last used lot of the proof of origin type is preselected. |
|
|
Notes: If this element is not set then the default is 0.
|
|
 |
|
|
|
 |
Tag: print_traceability_info |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
0 - 1
|
|
Nillable: |
no |
|
Description: Define whether the application prints proof of origin information on a receipt or not.
Value |
Description |
0 |
Does not print proof of origin information on receipt.
|
1 |
Print proof of origin information on receipt. |
|
|
Notes: If this element is not set then the default is 0.
|
|
 |
|
|
|
 |
Tag: print_traceability_label_info |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
0 - 1
|
|
Nillable: |
no |
|
Description: Define whether the application prints proof of origin information on a label or not.
Value |
Description |
0 |
Does not print proof of origin information on label
|
1 |
Print proof of origin information on label |
|
|
Notes: If this element is not set then the default is 0.
|
|
 |
|
|
|
 |
Tag: lot_date_offset_usage_type |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
0 - 3
|
|
Nillable: |
no |
|
Description: The type of verification for the lot offset:
Value |
Description |
0 |
"No verification" (default value). |
1 |
"Warning when date is within lot offset". |
2 |
"Blocking when date is within lot offset". |
3 |
"Warning within offset, block after lot best-before". |
Defines the behavior in case the packed-on date of the article is within the specified offset of the lot (or even the best-before
date of the lot is exceeded). The offset is used to define a time period prior the best-before date of the lot. In this period the article is booked even though it is
close to the end of its life. So the shelf life might be considered as too short to allow booking or at least to give the
operator a warning.
|
|
Notes: If this element is not set then the default is 0.
|
|
 |
|
|
|
 |
Tag: date_control_type |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
0 - 4
|
|
Nillable: |
no |
|
Description: Type of adjustment for article best-before/sell-by dates:
Value |
Description |
0 |
"No adjustment" (default value). |
1 |
"Adjust article best-before date automatically". |
2 |
"Adjust article sell-by date automatically". |
3 |
"Adjust article best-before date after warning". |
4 |
"Adjust article sell-by date after warning". |
Describes how (or if at all) the best-before/sell-by date of article is to be adjusted in case the lot best-before date is
sooner.
If activated the adjustment sets the best-before/sell-by date of the article to the best-before date of the lot.
|
|
 |
|
|
|
 |
Tag: last_change |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
dateTime |
|
Range: |
- |
|
Nillable: |
yes |
|
Description: The last time when the record was changed. 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
|
|
Notes: If this element is not set then the default is 0.
|
|
 |
|
|