AutoLab4j Folder Structure - Revision history

Dgarratt: Updated by push_wiki.py

2026-04-01T15:28:46Z

Updated by push_wiki.py

← Older revision		Revision as of 17:28, 1 April 2026
Line 29:		Line 29:
	=== AutoLab.jar ===		=== AutoLab.jar ===

	The main application JAR. ~~Start~~ AutoLab4j ~~by running~~ <code>java -jar AutoLab.jar</code>.		The main application JAR. When running from the distribution archive, start AutoLab4j with <code>java -jar AutoLab.jar</code>. If installed using the native package, use the shortcut or service entry created by the installer.

	=== lib/ ===		=== lib/ ===

Dgarratt: Updated by push_wiki.py

2026-04-01T11:35:23Z

Updated by push_wiki.py

← Older revision		Revision as of 13:35, 1 April 2026
Line 1:		Line 1:
			This page describes the directory layout of an AutoLab4j installation and the purpose of each folder.

			== Directory Layout ==

			AutoLab4j/
			├── AutoLab.jar
			├── lib/
			├── xml/
			│ ├── config/
			│ │ ├── config.xml
			│ │ ├── email.xml
			│ │ └── log4j2.xml
			│ └── sscc/
			│ └── PRINTER NAME.xml
			├── labels/
			├── interface/
			│ ├── input/
			│ │ └── dataset/
			│ └── output/
			│ └── ProdDec/
			├── remote_dataset/
			├── remote_labels/
			├── labelary/
			├── logs/
			└── running/

			== File and Folder Descriptions ==

			=== AutoLab.jar ===

			The main application JAR. Start AutoLab4j by running <code>java -jar AutoLab.jar</code>.

			=== lib/ ===

			Third-party library JARs required by AutoLab4j (referenced in the JAR manifest classpath). Do not modify this directory.

			=== xml/config/config.xml ===

			The main configuration file. Defines production lines, Modbus connection details, pallet quantities, batch format patterns, and file paths. See [[AutoLab4j Configuration]] for the full structure.

			=== xml/config/email.xml ===

			SMTP and distribution list settings for email notifications. Used for SSCC warning alerts and service start/stop notifications.

			=== xml/config/log4j2.xml ===

			Log4j2 logging configuration. Controls log file location, rotation size, and retention period.

			=== xml/sscc/ ===

			Contains one XML sequence file per printer, named after the printer (for example <code>PRINTER 1.xml</code>). Each file stores the current SSCC prefix, sequence number, check digit, warning limit, and upper limit. AutoLab4j reads and updates these files atomically each time a new SSCC is generated. Back up this directory regularly — it records how far through the SSCC sequence each printer has progressed.

			=== labels/ ===

			ZPL label template files. The filename of the template to use for each order is specified in the <code>REPORT_FILENAME</code> field of the CSV dataset file. Templates contain ZPL commands with field placeholders such as <code><MATERIAL></code> and <code><SSCC></code>.

			=== interface/input/dataset/ ===

			The directory AutoLab4j monitors for incoming CSV dataset files from Commander4j. When Commander4j assigns a process order to a production line, it writes a CSV file here named <code>LINE_NAME_PRINTER_NAME.CSV</code>. This directory is configured as <code>dataSet path</code> in <code>config.xml</code>.

			=== interface/output/ProdDec/ ===

			Production Declaration XML files are written here after each pallet is printed — one file per SSCC. These files record the SSCC, product, batch, shelf life, and other details for downstream integration. This directory is configured as <code>output path</code> in <code>config.xml</code>.

			=== remote_dataset/ ===

			An optional secondary location for CSV dataset files, used when the dataset files are delivered from a remote source and need to be synchronised locally before processing. Configured as <code>dataSet path</code> if remote synchronisation is in use.

			=== remote_labels/ ===

			An optional source directory for label template files. The LabelSync thread copies label files from this directory into <code>labels/</code> at a configurable interval. Used when label templates are maintained centrally and need to be distributed to multiple AutoLab4j instances. Configured as <code>labelSync path</code> in <code>config.xml</code>.

			=== labelary/ ===

			Cache directory for label preview images fetched from the Labelary API. Each ZPL label that is previewed produces a PNG file here. The cache is used to avoid re-fetching the same label image on repeat prints.

			=== logs/ ===

			Application log files. The main log file is <code>AutoLab.log</code>. Log files rotate at 10 MB and are retained for 14 days. Review this directory when diagnosing Modbus connection issues, print failures, or SSCC sequence problems.

			=== running/ ===

			Temporary runtime flag files created by AutoLab4j while it is running. These files are created on startup and removed on clean shutdown. If they remain after an unexpected exit, AutoLab4j will clear them on the next start. Do not modify or delete these files while the service is running.

			See also: [[AutoLab4j Configuration]], [[Installation AutoLab4j]], [[Overview AutoLab4j]]

	[[Category:AutoLab4j]]		[[Category:AutoLab4j]]

	~~Commander4j AutoLab~~
	~~├── images~~
	~~│ ├── Icons~~
	~~│ │ └── AutoLab4j_Icons~~
	~~│ │ └── MyIcon.iconset~~
	~~│ ├── linux~~
	~~│ ├── mac~~
	~~│ └── windows~~
	~~├── interface~~
	~~│ ├── input~~
	~~│ │ └── dataset~~
	~~│ └── output~~
	~~│ └── ProdDec~~
	~~├── labelary~~
	~~├── labels~~
	~~├── layout~~
	~~├── lib~~
	~~│ ├── devonly~~
	~~│ └── modbus~~
	~~├── licences~~
	~~├── logs~~
	~~├── remote_dataset~~
	~~│ └── Backup~~
	~~├── remote_labels~~
	~~├── running~~
	~~└── xml~~
	~~├── config~~
	~~│ ├── Example Config~~
	~~│ └── Example Email~~
	~~└── sscc~~
	~~└── Example SSCC~~

Dgarratt at 20:36, 27 August 2024

2024-08-27T20:36:01Z

← Older revision		Revision as of 22:36, 27 August 2024
Line 1:		Line 1:
	[[Category:AutoLab4j]]		[[Category:AutoLab4j]]

	Commander4j AutoLab		Commander4j AutoLab
	├── images		├── images
	│ ├── Icons		│ ├── Icons
	│ │ └── AutoLab4j_Icons		│ │ └── AutoLab4j_Icons
	│ │ └── MyIcon.iconset		│ │ └── MyIcon.iconset
	│ ├── linux		│ ├── linux
	│ ├── mac		│ ├── mac
	│ └── windows		│ └── windows
	├── interface		├── interface
	│ ├── input		│ ├── input
	│ │ └── dataset		│ │ └── dataset
	│ └── output		│ └── output
	│ └── ProdDec		│ └── ProdDec
	├── labelary		├── labelary
	├── labels		├── labels
	├── layout		├── layout
	├── lib		├── lib
	│ ├── devonly		│ ├── devonly
	│ └── modbus		│ └── modbus
	├── licences		├── licences
	├── logs		├── logs
	├── remote_dataset		├── remote_dataset
	│ └── Backup		│ └── Backup
	├── remote_labels		├── remote_labels
	├── running		├── running
	└── xml		└── xml
	├── config		├── config
	│ ├── Example Config		│ ├── Example Config
	│ └── Example Email		│ └── Example Email
	└── sscc		└── sscc
	└── Example SSCC		└── Example SSCC

Dgarratt: Created page with "Category:AutoLab4j Commander4j AutoLab ├── images │ ├── Icons │ │ └── AutoLab4j_Icons │ │ └── MyIcon.iconset │ ├── linux │ ├── mac │ └── windows ├── interface │ ├── input │ │ └── dataset │ └── output │ └── ProdDec ├── labelary ├── labels ├── layout ├── lib │ ├── devonly │ └── modbus ├──..."

2024-08-27T20:32:45Z

Created page with "Category:AutoLab4j Commander4j AutoLab ├── images │ ├── Icons │ │ └── AutoLab4j_Icons │ │ └── MyIcon.iconset │ ├── linux │ ├── mac │ └── windows ├── interface │ ├── input │ │ └── dataset │ └── output │ └── ProdDec ├── labelary ├── labels ├── layout ├── lib │ ├── devonly │ └── modbus ├──..."

New page

[[Category:AutoLab4j]]

Commander4j AutoLab
├── images
│ ├── Icons
│ │ └── AutoLab4j_Icons
│ │ └── MyIcon.iconset
│ ├── linux
│ ├── mac
│ └── windows
├── interface
│ ├── input
│ │ └── dataset
│ └── output
│ └── ProdDec
├── labelary
├── labels
├── layout
├── lib
│ ├── devonly
│ └── modbus
├── licences
├── logs
├── remote_dataset
│ └── Backup
├── remote_labels
├── running
└── xml
├── config
│ ├── Example Config
│ └── Example Email
└── sscc
└── Example SSCC