Skip to main content

Sync Log

What this menu does

Every time WMS Sync Hub talks to WMS — pushing a picking note, syncing items, receiving a status update, converting PO to ASN — a row gets logged here.

Since v1.6.3: each entry now also stores the complete request + response JSON, so you can see exactly what WMS returned.

Use this menu to answer questions like:

  • Did that picking note actually reach WMS?
  • Why didn't my PO turn into an ASN?
  • What was the exact WMS error?
  • When did WMS mark the order as Shipped?

How to use

  1. Click Sync Log in the left navigation.
  2. The grid shows every transaction, newest first (default last 200).
  3. Click any row to highlight it, then click View Payload at the top — or double-click the row directly — to open a dialog showing the complete request + response JSON.

What the columns mean

ColumnMeaning
# (LogKey)Auto-incrementing ID, biggest = newest
TypeAction type (see list below)
ReferenceThe related AutoCount document — picking note number, PO number, item code, etc.
DirOUT = we pushed to WMS / BAS; IN = WMS pushed to us via webhook
OK✓ success / ✗ failure
ErrorIf failed, the WMS code + message
DateWhen the action occurred

Common Types

TypeDirectionMeaning
ORDER_CREATEOUTPush picking note to WMS (GLINK_CREATE_ORDER_NOTIFY)
ORDER_CANCELOUTCancel picking note (GLINK_CANCEL_ORDER_NOTIFY)
ORDER_STATUSINWMS pushes order status change (webhook)
ASN_CREATEOUTPush PO as ASN (GLINK_CREATE_ASN_NOTIFY)
ASN_CANCELOUTCancel ASN (GLINK_CANCEL_ASN_NOTIFY)
ASN_STATUSINWMS pushes ASN receipt status (webhook, triggers GRN creation)
ITEM_SYNCOUTPush item to WMS GLINK
ITEM_TYPE_SYNCOUTPush Item Type to WMS BAS (creates category)
UOM_PUSHOUTPush UOM description to WMS BAS (Phase 2)

The View Payload dialog

Click View Payload or double-click a row to open the dialog:

  • Header: a summary of this log row (id, type, reference, time, success)
  • Request payload: the complete JSON we sent to WMS / BAS (pretty-printed)
  • Response payload: the complete JSON WMS / BAS sent back
  • Each panel has a Copy button — paste the JSON into a support ticket
Find the exact WMS error for a picking note

To diagnose a failed picking note sync:

  1. Go to Sync Log
  2. Search by PN number
  3. Find Type = ORDER_CREATE + Dir = OUT
  4. Double-click → look at the Response payload's code and message fields

Cleanup & Retention (advanced — Ctrl+Alt+0)

The Sync Log table grows over time, especially since one 200-row picking note × many SKUs = several KB of JSON per row. WMS Sync Hub provides two cleanup mechanisms:

Automatic cleanup (enabled by default)

Once an hour, the API automatically NULLs out RequestPayload + ResponsePayload columns on rows older than N days (the row's metadata — refNo, time, success, error — is preserved; only the verbose JSON is dropped).

Default retention: 90 days. Adjustable via the Ctrl+Alt+0 panel (PayloadRetentionDays; 0 = disable auto-cleanup).

Manual cleanup (by date range)

Press Ctrl + Alt + 0 to open the Sync Log — Cleanup & Retention dialog:

  • From / To date pickers + Type filter
  • Clear Payloads button: clears the payload columns on matching rows (keeps the row)
  • Delete Rows button (red): deletes rows entirely (loses the metadata too) — use cautiously
  • Auto-clear payloads after [N] days input: adjust auto-cleanup retention
  • Save Retention button: saves to Z_WmsSyncSetting.PayloadRetentionDays
Delete Rows is irreversible

Clear Payloads is gentle (preserves the audit row + metadata), while Delete Rows is a hard delete. Unless you're sure you don't need history, use Clear.

Reading failed entries

For rows showing , double-click or View Payload to see specifics:

  • "INVALID_DATA: Item ABC-123 not exists" — go to Item Code Sync, sync the item, then Retry Failed.
  • "ORDER_NOT_EXIST" — cancelling something already processed; usually harmless.
  • "INSUFFICIENT_INVENTORY" — WMS is out of stock; check with the warehouse.
  • "出库模式配置异常" (outbound mode configuration error) — the warehouse's outbound mode isn't fully provisioned (warehouse address, carrier route, etc.) — Solution Provider needs to coordinate with WMS team.
  • Cryptic codes — copy the entire row + payload and send to your Solution Provider.

FAQ

  • Q: There are too many Sync Log rows — what now? Auto-cleanup is already running (every hour, NULLs out payloads older than 90 days). If still too much, press Ctrl+Alt+0 and manually Clear Payloads for an older date range.
  • Q: After clearing payloads, can I still see that record? Yes — Clear Payloads only nulls out RequestPayload + ResponsePayload; the row stays. You'll still see type, refNo, success, error, just not the full JSON.
  • Q: Double-clicking a row does nothing — why? Make sure you clicked the row first to highlight it before View Payload. If still no luck, check whether that row has a RequestPayload (older versions may not have stored payloads).
  • Q: Can I export to Excel? Yes — right-click the grid → Export To Excel (DevExpress standard feature). But export does not include payload contents, only the column values. For payloads, View one row + Copy button.