LabelServer4j Example User Interface - Revision history

Dgarratt: Updated by push_wiki.py

2026-04-05T16:05:04Z

Updated by push_wiki.py

← Older revision		Revision as of 18:05, 5 April 2026
Line 6:		Line 6:

	The native install package includes <code>LabelServer.exe</code>, a service-mode launcher that manages the Windows service directly. All commands must be run from an elevated command prompt (Run as Administrator).		The native install package includes <code>LabelServer.exe</code>, a service-mode launcher that manages the Windows service directly. All commands must be run from an elevated command prompt (Run as Administrator).

			The default service name is '''LabelService'''. A custom name can be passed as an optional second parameter — if used, the same name must be supplied to all subsequent commands.

	{\| class="wikitable"		{\| class="wikitable"
Line 11:		Line 13:
	! Command !! Effect		! Command !! Effect
	\|-		\|-
	\| <code>LabelServer.exe /install</code> \|\| Register ~~the service~~ with automatic startup on boot		\| <code>LabelServer.exe /install</code> \|\| Register as '''LabelService''' with automatic startup on boot
	\|-		\|-
	\| <code>LabelServer.exe /install-demand</code> \|\| Register ~~the service~~ with manual startup only		\| <code>LabelServer.exe /install "My Label Service"</code> \|\| Register with a custom service name
			\|-
			\| <code>LabelServer.exe /install-demand</code> \|\| Register with manual startup only
	\|-		\|-
	\| <code>LabelServer.exe /start</code> \|\| Start the service		\| <code>LabelServer.exe /start</code> \|\| Start the service

Dgarratt: Updated by push_wiki.py

2026-04-05T15:55:53Z

Updated by push_wiki.py

← Older revision		Revision as of 17:55, 5 April 2026
Line 3:		Line 3:
	== Starting LabelServer4j ==		== Starting LabelServer4j ==

	=== Windows ===		=== Windows — Running as a Service ===

	LabelServer4j can be installed as a Windows service so that it starts automatically when the server boots and restarts automatically if it crashes. Once installed as a service it is managed through the standard Windows Services management console (<code>~~services~~.~~msc~~</code>~~) or~~ the command ~~line:~~		The native install package includes <code>LabelServer.exe</code>, a service-mode launcher that manages the Windows service directly. All commands must be run from an elevated command prompt (Run as Administrator).

	~~net~~ start ~~LabelServer4j~~		{\| class="wikitable"
	~~net~~ stop ~~LabelServer4j~~		\|-
			! Command !! Effect
			\|-
			\| <code>LabelServer.exe /install</code> \|\| Register the service with automatic startup on boot
			\|-
			\| <code>LabelServer.exe /install-demand</code> \|\| Register the service with manual startup only
			\|-
			\| <code>LabelServer.exe /start</code> \|\| Start the service
			\|-
			\| <code>LabelServer.exe /stop</code> \|\| Stop the service (waits for graceful shutdown)
			\|-
			\| <code>LabelServer.exe /restart</code> \|\| Restart the service
			\|-
			\| <code>LabelServer.exe /status</code> \|\| Query status (exit code: 0 = running, 3 = stopped)
			\|-
			\| <code>LabelServer.exe /uninstall</code> \|\| Remove the service registration
			\|}

	~~It can~~ also ~~be started directly from a command prompt for testing:~~		Once installed, the service also appears in the Windows Services management console (<code>services.msc</code>).

	~~start_labeller~~.~~cmd~~		=== Windows — Testing in a Console Window ===

			Before installing as a service, use the debug launcher to run LabelServer4j with all output visible in the console:

			LabelServerDebug.exe

			This runs the same application code and is the most convenient way to verify that labellers connect and that the configuration is correct before committing to service deployment.

	=== Linux / macOS ===		=== Linux / macOS ===

Dgarratt: Updated by push_wiki.py

2026-04-01T10:26:18Z

Updated by push_wiki.py

← Older revision		Revision as of 12:26, 1 April 2026
Line 1:		Line 1:
			LabelServer4j is a headless background service — it has no graphical user interface. All interaction with the service is through configuration files, log files, and (on Windows) the Windows Services control panel.

			== Starting LabelServer4j ==

			=== Windows ===

			LabelServer4j can be installed as a Windows service so that it starts automatically when the server boots and restarts automatically if it crashes. Once installed as a service it is managed through the standard Windows Services management console (<code>services.msc</code>) or the command line:

			net start LabelServer4j
			net stop LabelServer4j

			It can also be started directly from a command prompt for testing:

			start_labeller.cmd

			=== Linux / macOS ===

			Start from the terminal using the provided shell script:

			./start_labeller.sh

			Or directly:

			java -cp ./LabelServer.jar:./lib/devonly/i4jruntime.jar com.commander4j.labeller.Service

			The process runs in the foreground. Use a process manager (systemd, launchd, or nohup) for production deployment.

			== Monitoring ==

			Since there is no GUI, the primary monitoring tool is the log file:

			logs/c4jLabelServer.log

			The log records every event in detail:

			* Service startup and configuration loading
			* Each labeller thread starting
			* Every CSV file detected and processed
			* Every command sent to a printer and every response received
			* File operations (upload, download, backup, delete)
			* Errors and exceptions with full context

			Log files rotate at 10 MB and are retained for 14 days.

			=== What to Look For ===

			{\| class="wikitable"
			\|-
			! Situation !! What to check in the log
			\|-
			\| Label not printing \|\| Look for the CSV filename being detected; if absent, check the input path in labellers.xml
			\|-
			\| Printer not responding \|\| Look for TCP connection errors or timeout messages for that labeller's IP and port
			\|-
			\| Wrong data on label \|\| Check the variable substitution log lines to see what values were sent
			\|-
			\| Script error \|\| Look for the script line number and command that caused the failure
			\|-
			\| File stuck in input directory \|\| File renamed to <code>.in</code> means the script is running or failed — check for a <code>.error</code> file
			\|}

			== Configuration Changes ==

			To change a labeller's IP address, port, command script, or input path, edit the relevant <code>labellers.xml</code> file and restart the service. Changes to configuration files are not picked up at runtime.

			To switch site, edit <code>xml/config/config.xml</code> and change the <code>site id</code> attribute, then restart.

			== Thread Architecture ==

			When running, LabelServer4j maintains the following threads:

			* One main service thread (lifecycle management)
			* One server thread (configuration and orchestration)
			* Per enabled labeller: one labeller thread, one TCP receive thread, one TCP transmit thread

			The thread count grows with the number of configured printers. A site with six printers typically runs around 20 threads in total.

			== Graceful Shutdown ==

			Sending a termination signal (Ctrl+C on Linux/macOS, or stopping the Windows service) triggers the shutdown hook. LabelServer4j signals all labeller threads to stop, waits for any in-progress print jobs to complete, then exits cleanly.

			See also: [[Overview LabelServer4j]], [[LabelServer4j Configuration]], [[LabelServer4j Operation]], [[Install Interface Services]]

	[[Category:LabelServer4j]]		[[Category:LabelServer4j]]

	The LabelServer application is designed to run as a background process (Service) and as such does not have a user interface, however you can run is as a Terminal program or view it's activity via the Log files.

Dgarratt at 16:32, 31 August 2024

2024-08-31T16:32:10Z

← Older revision		Revision as of 18:32, 31 August 2024
Line 1:		Line 1:
	[[Category:LabelServer4j]]		[[Category:LabelServer4j]]

			The LabelServer application is designed to run as a background process (Service) and as such does not have a user interface, however you can run is as a Terminal program or view it's activity via the Log files.

Dgarratt: Created page with "Category:LabelServer4j"

2024-08-31T11:12:13Z

Created page with "Category:LabelServer4j"

New page

[[Category:LabelServer4j]]