AutoLab4j Dataset CSV: Difference between revisions

From Commander4j
← Older edit
No edit summary
Updated by push_wiki.py
 
Line 1: Line 1:
[[Category:AutoLab4j]]
When an operator assigns a [[Process Orders|Process Order]] to a production line in Commander4j, a CSV data file is written to the dataset directory monitored by AutoLab4j. This file contains all the product and order information AutoLab4j needs to generate and print labels.
The example CSV data shown below is automatically exported when someone assigns a Process Order to a Production line in the Pallet Label screen within Commander4j.  
 
== File Naming ==
 
The CSV filename follows the format:
 
LINE_NAME_PRINTER_NAME.CSV
 
For example, a production line named <code>LINE 1</code> with a printer named <code>PRINTER 1</code> produces:
 
LINE 1_PRINTER 1.CSV
 
AutoLab4j monitors the configured dataset directory and loads this file as soon as it appears. If a new file arrives while production is active, it replaces the previous data immediately.
 
== File Format ==
 
The file contains a header row followed by a single data row. Fields are comma-separated. The column headers are used to map values to named variables in the label template and print configuration.
 
== Fields ==
 
=== Order and Product ===
 
{| class="wikitable"
|-
! Field !! Description
|-
| PROCESS_ORDER || The process order number from Commander4j
|-
| MATERIAL || The material/product code
|-
| DESCRIPTION || Product description
|-
| CUSTOMER_ID || Customer identifier, used to look up batch format patterns in config.xml
|-
| LANGUAGE || Language code for label content
|-
| REPORT_FILENAME || Filename of the ZPL label template to use (looked up in the <code>labels/</code> directory)
|}
 
=== Batch and Expiry ===
 
{| class="wikitable"
|-
! Field !! Description
|-
| BATCH_FORMAT || Batch number format pattern (overrides the customer default in config.xml if present)
|-
| BATCH_NUMBER || Pre-calculated batch number (used directly if BATCH_FORMAT is not specified)
|-
| BATCH_PREFIX || Optional prefix prepended to the calculated batch number
|-
| DATE_OF_MANUFACTURE || Manufacturing date, used as the base for expiry date calculation
|-
| EXPIRY_DATE || Pre-calculated expiry date (used directly if shelf life fields are not present)
|-
| SHELF_LIFE || Numeric shelf life value
|-
| SHELF_LIFE_UOM || Shelf life unit of measure (D = days, M = months, Y = years)
|-
| SHELF_LIFE_RULE || Rule for how the expiry date is calculated from the manufacture date and shelf life
|}
 
=== Barcodes and Identifiers ===
 
{| class="wikitable"
|-
! Field !! Description
|-
| EAN || EAN-13 barcode value for the product (trading unit barcode)
|-
| PROD_EAN || EAN used specifically for the production label barcode (may differ from EAN)
|}
 
=== Pallet Configuration ===
 
{| class="wikitable"
|-
! Field !! Description
|-
| SSCC_PER_PALLET || Number of SSCCs (pallet labels) to generate for a full pallet
|-
| LABELS_PER_SSCC || Number of label copies to print for each SSCC
|}
 
=== Printer Destination ===
 
{| class="wikitable"
|-
! Field !! Description
|-
| IP_ADDRESS || IP address of the Zebra printer for this line
|-
| PORT || TCP port of the Zebra printer (typically 9100)
|}
 
== Field Substitution in Label Templates ==
 
All fields in the CSV are available as placeholders in the ZPL label template using the syntax <code>&lt;*FIELD_NAME*&gt;</code>. For example:
 
* <code>&lt;*MATERIAL*&gt;</code> is replaced with the MATERIAL field value
* <code>&lt;*SSCC*&gt;</code> is replaced with the generated SSCC
* <code>&lt;*EXPIRY_DATE*&gt;</code> is replaced with the calculated expiry date


AutoLab4j expects the filename of the CSV to be constructed from the name of the production line and printer separated by an underscore.
The <code>fieldNamesLookup</code> section in <code>config.xml</code> can map CSV field names to different template placeholder names if the CSV field names do not match the placeholder names in the template. The <code>clone</code> section can copy a field value under an additional name, and the <code>formats</code> section can apply numeric formatting to a field before substitution.


===CSV Dataset===
== SSCC Field ==
'''LINE 1_PRINTER 1.CSV'''
<syntaxhighlight lang="xml">
"LINE","MODIFIED","UNIQUE_ID","LABEL_TYPE","PRINTER_ID","ENABLED","PRINTER_TYPE","IP_ADDRESS","PORT","GROUP_ID","LANGUAGE","PRINTER_DPI","PROCESS_ORDER","MATERIAL","MATERIAL_TYPE","MATERIAL_DESCRIPTION","SHELF_LIFE_UOM","SHELF_LIFE","SHELF_LIFE_RULE","BATCH_NUMBER","REQUIRED_RESOURCE","PLANT","LOCATION_ID","DATE_OF_MANUFACTURE","EXPIRY_DATE","PROD_EAN","PROD_VARIANT","BASE_QUANTITY","PROD_UOM","BASE_EAN","BASE_VARIANT","PROD_QUANTITY","BASE_UOM","CUSTOMER_ID","CUSTOMER_NAME","PRINT_COPIES","MODULE_ID","OVERRIDE_MANUFACTURE_DATE","OVERRIDE_EXPIRY_DATE","OVERRIDE_BATCH_PREFIX","BATCH_PREFIX","BATCH_SUFFIX","REPORT_TYPE","MODULE_TYPE","REPORT_FILENAME","PART_NO","LAYERS"
"LINE 1","Y","cf2a2bcf-deeb-430b-b13b-e37976004e5b","Pallet","PRINTER 1","Y","Logopak","127.0.0.1","9100","Pallet","LEAP","200","00000001","00000001","FERT","Demo Material 00000001","M","24","+","4115123401","LINE1","1234","FACTORY1","24-Apr-2024 14:28:19","30-Apr-2026 00:00:00","07613030436171","01","336.000","CS","07613030436164","01","84.000","EA","SELF","My Company","1","RPT_PALLET_LABEL","N","N","N","41151234","01","Label","REPORT","zebra_200dpi_pallet_label_a5_cdf_val.lbl","","12"
</syntaxhighlight>


The SSCC is not present in the CSV file — it is generated by AutoLab4j at print time from the sequence file for the printer. It is available in the label template as <code>&lt;*SSCC*&gt;</code>.


[[file:AutoLab4j_CSV_Dataset.png|link=|800px]]
See also: [[AutoLab4j Operation]], [[AutoLab4j Configuration]], [[Zebra ZPL Label]], [[Label Template Syntax]]


The above image is the same data as the CSV in a format which is a little easier to understand.
[[Category:AutoLab4j]]

Latest revision as of 13:35, 1 April 2026

When an operator assigns a Process Order to a production line in Commander4j, a CSV data file is written to the dataset directory monitored by AutoLab4j. This file contains all the product and order information AutoLab4j needs to generate and print labels.

File Naming

The CSV filename follows the format: 

LINE_NAME_PRINTER_NAME.CSV

For example, a production line named LINE 1 with a printer named PRINTER 1 produces: 

LINE 1_PRINTER 1.CSV

AutoLab4j monitors the configured dataset directory and loads this file as soon as it appears. If a new file arrives while production is active, it replaces the previous data immediately.

File Format

The file contains a header row followed by a single data row. Fields are comma-separated. The column headers are used to map values to named variables in the label template and print configuration.

Fields

Order and Product

Field Description
PROCESS_ORDER The process order number from Commander4j
MATERIAL The material/product code
DESCRIPTION Product description
CUSTOMER_ID Customer identifier, used to look up batch format patterns in config.xml
LANGUAGE Language code for label content
REPORT_FILENAME Filename of the ZPL label template to use (looked up in the labels/ directory)

Batch and Expiry

Field Description
BATCH_FORMAT Batch number format pattern (overrides the customer default in config.xml if present)
BATCH_NUMBER Pre-calculated batch number (used directly if BATCH_FORMAT is not specified)
BATCH_PREFIX Optional prefix prepended to the calculated batch number
DATE_OF_MANUFACTURE Manufacturing date, used as the base for expiry date calculation
EXPIRY_DATE Pre-calculated expiry date (used directly if shelf life fields are not present)
SHELF_LIFE Numeric shelf life value
SHELF_LIFE_UOM Shelf life unit of measure (D = days, M = months, Y = years)
SHELF_LIFE_RULE Rule for how the expiry date is calculated from the manufacture date and shelf life

Barcodes and Identifiers

Field Description
EAN EAN-13 barcode value for the product (trading unit barcode)
PROD_EAN EAN used specifically for the production label barcode (may differ from EAN)

Pallet Configuration

Field Description
SSCC_PER_PALLET Number of SSCCs (pallet labels) to generate for a full pallet
LABELS_PER_SSCC Number of label copies to print for each SSCC

Printer Destination

Field Description
IP_ADDRESS IP address of the Zebra printer for this line
PORT TCP port of the Zebra printer (typically 9100)

Field Substitution in Label Templates

All fields in the CSV are available as placeholders in the ZPL label template using the syntax <*FIELD_NAME*>. For example:

  • <*MATERIAL*> is replaced with the MATERIAL field value
  • <*SSCC*> is replaced with the generated SSCC
  • <*EXPIRY_DATE*> is replaced with the calculated expiry date

The fieldNamesLookup section in config.xml can map CSV field names to different template placeholder names if the CSV field names do not match the placeholder names in the template. The clone section can copy a field value under an additional name, and the formats section can apply numeric formatting to a field before substitution.

SSCC Field

The SSCC is not present in the CSV file — it is generated by AutoLab4j at print time from the sequence file for the printer. It is available in the label template as <*SSCC*>.

See also: AutoLab4j Operation, AutoLab4j Configuration, Zebra ZPL Label, Label Template Syntax

Retrieved from ‘https://wiki.commander4j.com/index.php?title=AutoLab4j_Dataset_CSV&oldid=1800’