Dgarratt: Updated by push_wiki.py

2026-04-05T16:05:03Z

Updated by push_wiki.py

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

	All service commands must be run from an elevated command prompt (Run as Administrator).		All service commands must be run from an elevated command prompt (Run as Administrator).

			The default Windows service name is '''Service4j''' (the launcher name defined in the installer). You can specify a different name as an optional second parameter. If a custom name is used at install time, that same name must be passed to every subsequent command.

	{\| class="wikitable"		{\| class="wikitable"
Line 44:		Line 46:
	! Command !! Effect		! Command !! Effect
	\|-		\|-
	\| <code>Service4j.exe /install</code> \|\| Register ~~the Windows service~~ with automatic startup on boot		\| <code>Service4j.exe /install</code> \|\| Register as '''Service4j''' with automatic startup on boot
	\|-		\|-
	\| <code>Service4j.exe /install-demand</code> \|\| Register ~~the service~~ with manual startup only		\| <code>Service4j.exe /install "Commander4j Interface"</code> \|\| Register with a custom service name
			\|-
			\| <code>Service4j.exe /install-demand</code> \|\| Register with manual startup only
	\|-		\|-
	\| <code>Service4j.exe /start</code> \|\| Start the service		\| <code>Service4j.exe /start</code> \|\| Start the service
Line 58:		Line 62:
	\| <code>Service4j.exe /uninstall</code> \|\| Remove the service registration		\| <code>Service4j.exe /uninstall</code> \|\| Remove the service registration
	\|}		\|}

			If a custom service name was used at install time, append it to all subsequent commands:

			Service4j.exe /start "Commander4j Interface"
			Service4j.exe /stop "Commander4j Interface"
			Service4j.exe /uninstall "Commander4j Interface"

	Once installed, the service also appears in the Windows Services management console (<code>services.msc</code>).		Once installed, the service also appears in the Windows Services management console (<code>services.msc</code>).

Dgarratt: Updated by push_wiki.py

2026-04-05T16:01:24Z

Updated by push_wiki.py

New page

The Commander4j Interface Service is a background process that handles all automated integration between Commander4j and external systems. It monitors for incoming XML messages from ERPs and other systems, generates outbound XML messages, triggers scheduled reports, and drives automatic labelling. It is designed to run continuously on a server as a Windows service.

The service is a separate optional component — the main Commander4j desktop application does not need to be running for the Interface Service to operate.

== What the Service Does ==

When started, the Interface Service logs into the Commander4j database using the built-in <code>interface</code> account and starts five background threads:

{| class="wikitable"
|-
! Thread !! Purpose
|-
| '''Inbound Message Thread''' || Monitors the configured inbound directory for XML message files from external systems. Processes each file against the appropriate message handler and writes results to <code>SYS_INTERFACE_LOG</code>.
|-
| '''Outbound Message Thread''' || Picks up XML messages queued in the database for transmission to external systems and writes them to the configured outbound directories.
|-
| '''Recovery Thread''' || Monitors the recovery path for messages that failed processing and re-attempts them on a schedule.
|-
| '''Reporting Thread''' || Fires scheduled reports at their configured times and distributes the output.
|-
| '''Auto Labeller Thread''' || Drives automatic pallet labelling triggers that are not handled by [[AutoLab4j]] or [[LabelServer4j]].
|}

At a configured daily housekeeping time the service gracefully stops all threads, performs maintenance tasks, and restarts. Email notifications are sent on startup, shutdown, and housekeeping if configured.

== Prerequisites ==

=== Host Configuration ===

The Interface Service identifies which database to connect to by looking for a host entry in <code>hosts.xml</code> with a <code>uniqueId</code> of <code>service</code>. This host entry must be created using [[Setup4j]] before the service will start. Without it, the service logs an error and exits immediately.

=== Interface User Account ===

The service logs into Commander4j using the application account <code>interface</code> with password <code>interface</code>. This account must exist and be enabled in the Commander4j user list. It is created automatically when the schema is initialised, but verify it has not been disabled or had its password changed.

== Installing as a Windows Service ==

The native install package includes <code>Service4j.exe</code>, a service-mode launcher built with install4j. This executable manages the Windows service directly — no additional wrapper is required.

All service commands must be run from an elevated command prompt (Run as Administrator).

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

Once installed, the service also appears in the Windows Services management console (<code>services.msc</code>).

=== Testing Before Installing as a Service ===

Before committing to service installation, run the Interface Service in a visible console window using:

Interface4j.exe

This runs the same application code and all log output is written to the console window. Use this mode to confirm that the correct host is found, the <code>interface</code> account logs in, and all threads start successfully.

== Email Notifications ==

If configured, the service sends email alerts at key lifecycle events:

{| class="wikitable"
|-
! Event !! Trigger
|-
| Startup || Service has connected to the database and all threads are running
|-
| Shutdown || Service has stopped all threads and disconnected
|-
| Housekeeping || Daily maintenance cycle has run
|-
| Statistics || Daily statistics summary (if enabled)
|}

Email notification is controlled by the system key <code>INTERFACE EMAIL NOTIFY</code> (true/false) and the recipient list in <code>INTERFACE ADMIN EMAIL</code>. Both are configured in the Commander4j system keys administration screen.

== Monitoring ==

All activity is written to the Log4j log file in the <code>logs/</code> directory. The [[Interface Log]] screen in the Commander4j desktop application provides a searchable view of every message processed — inbound and outbound — including status, error details, and message content.

Failed messages can be resubmitted for reprocessing from the Interface Log screen without re-sending the original file.

See also: [[Interface Log]], [[Interface Message Formats]], [[Setup4j]], [[AutoLab4j]], [[LabelServer4j]]

[[Category:Commander4j]]

Interface Service - Revision history

Dgarratt: Updated by push_wiki.py

Dgarratt: Updated by push_wiki.py