Commercient Sync Agent (the on-premises agent)

Mirrors the in-app Help. The live copy in your console and `dlake guide help` are always current.

Everything configured through the platform describes what should sync. A Windows agent running on the customer’s own server is what actually reads the ERP — so a setup is only finished once that agent is installed, configured and connecting. The customer downloads it at the end of the registration wizard and runs it on the server their ERP runs on.

Two interfaces manage the same installation and are peers, not alternatives: the desktop application, and CommercientSyncAgentCLI.exe, its scriptable counterpart for unattended installs, remote administration and provisioning pipelines. They share the same registry entries, scheduled tasks and product configuration, so a change made in one is immediately visible in the other.

The machine needs Windows, administrator privileges (the agent manages HKLM registry keys and Windows scheduled tasks), and an account with at least one product licence. Sign-in uses the customer’s Commercient account — the same credential as the portal, so it must satisfy the portal’s password rules.

Products follow one order: products (what is licensed, and what is already installed — the authority for exact product names) → install (download it and create its sync task) → configure (point it at the source; prompts for anything not passed as a flag, so the same command is guided or fully unattended) → test (open and close a connection — configuration only) → run-test (a real sync). test failing is a configuration problem; test passing and run-test failing points at the source’s data or permissions.

CommercientSyncAgentCLI.exe -u you@company.com products
CommercientSyncAgentCLI.exe -u you@company.com install   --product NormalSync
CommercientSyncAgentCLI.exe -u you@company.com configure --product NormalSync
CommercientSyncAgentCLI.exe -u you@company.com test      --product NormalSync

Three things are worth knowing. status reports the agent’s own scheduled tasks, not just its products — a product that is installed and configured still will not sync if its task is missing, and that is where it shows. Every command sets a meaningful exit code (3 authentication, 4 unknown product, 5 already installed, 6 not installed, 8 source connection failed, 9 account not permitted), so automation should branch on the code rather than parse output. And the agent updates itself every four hours, so do not pin an installation and expect it to stay put. The deeper guide is the dlake-syncagent skill.