Skip to main content

Prerequisites

Before using WMS Sync Hub, make sure these things are in place. Most are one-time tasks for your Solution Provider — you don't need to do them yourself, but it helps to know they exist.

Client-side checklist​

  • WMS Sync Hub plugin installed: Solution Provider has installed the .app into AutoCount via Plug-in Manager. You should see WMS Sync Hub under the Operation menu.
  • Backend API service installed: WmsSyncHubApi is a Windows Service running on the same PC as AutoCount (or in the same LAN). It handles WMS communication, periodic polling, and webhook reception.
  • Database schema ready: First API startup auto-runs migrations to create all Z_Wms* tables. No manual SQL required.
  • WMS account configured: Qian Yi WMS has issued you partnerId and partnerKey, plus customerCode and warehouseCode. Solution Provider has filled these into the API's appsettings.json.
  • Item master clean: Every stock item you intend to ship should have Item Type filled. Items with empty Item Type land in the GENERAL bucket on WMS, making them hard to track by category.

Auto-update mechanism​

The WMS Sync Hub API self-updates via WmsHubUpdater:

  • In the main window, click About at the bottom-left
  • In the dialog, click Check for Updates
  • If a newer version is available on S3 (latest.json), follow the prompt to download and install
  • After install, the API auto-restarts and runs any pending schema migrations

The plugin .app itself needs to be reinstalled by your Solution Provider via AutoCount's Plug-in Manager.

What you do not need to worry about​

These are Solution Provider concerns, not yours:

  • Database connections, SQL Server config, SQL user passwords
  • .NET Framework 4.8, AutoCount 2.2 SDK
  • DevExpress, firewall rules, API URLs, HTTPS certificates, Cloudflare Tunnel
  • WMS partner key encryption (DPAPI), appsettings.json configuration

If any of these break, the main window's footer or Sync Log will show a clear error message — forward it to your Solution Provider.

note

WMS Sync Hub is designed to run all day. It does not modify your AutoCount documents — it only reads them, sends them to WMS, and writes status updates (like "Shipped") back.