Skip to content

Sync Dashboard

The Sync Dashboard in HQ Manager provides a real-time overview of all store connections, synchronization status, and any errors that need attention. This is the primary tool for monitoring the health of your multi-store network.

Accessing the Dashboard

Navigate to HQ Manager > Stores. The stores list doubles as the sync dashboard, showing connection status and sync metrics for each store.

Store Connection Status

Each store shows a connection indicator:

  • Green (Connected): The store's server has an active WebSocket connection to HQ. Data is syncing in real time.
  • Red (Disconnected): The store is not connected. This could mean the store server is offline, there is a network issue, or the sync token has been revoked.

The connection status is based on a live WebSocket heartbeat. If the connection drops, the indicator turns red within seconds. Connection status is only available for stores that have an active store server -- it does not reflect whether individual POS Terminals at the store are powered on.

Sync Metrics Per Store

For each connected store, the dashboard displays:

  • Last Sync At: The timestamp of the most recent successful sync operation in either direction. If this timestamp is old despite the store being connected, there may be an issue with the sync queue.
  • Entity Sync Status: A breakdown of sync status by entity type (products, sales, inventory adjustments, etc.). For each entity type, you can see:
    • The direction (push from store to HQ, or pull from HQ to store)
    • The last successful sync timestamp
    • Total records pushed and pulled
  • Sync Error Count: The number of sync operations that have failed. A non-zero error count requires investigation.

Today's Activity

The dashboard also shows each store's activity for the current day:

  • Sales Count: Number of completed sales transactions today.
  • Total Revenue: Gross revenue for the day.
  • Total Tax: Tax collected today.
  • Total Discounts: Discounts applied today.
  • Void Count and Total: Number and total value of voided transactions.
  • Open Registers: Currently open register sessions with their terminal IDs and opening times.

Investigating Sync Errors

When a store shows sync errors, click on the store to see the error details. Common sync errors include:

  1. Network timeout: The HTTP data transfer failed due to a slow or unstable connection. These typically resolve on automatic retry.
  2. Payload too large: A sync batch contained too much data. This can happen after extended offline periods. The sync engine will automatically break large batches into smaller chunks on retry.
  3. Schema mismatch: The store database schema does not match the expected version. This usually means the store server needs to be updated.
  4. Token rejected: The store's sync token is invalid or expired. Generate a new token in the store's settings.

Heartbeat

Each connected store sends a periodic heartbeat to HQ (default interval: 30 seconds). The heartbeat confirms the store is alive and responsive. If HQ does not receive a heartbeat within the expected window, the store is marked as disconnected. The heartbeat also carries lightweight status data (current register sessions, last sale timestamp) that updates the dashboard in real time.

Forcing a Resync

In rare cases, you may need to force a full resync for a store. This re-sends all HQ data (products, departments, tax rates, users, etc.) to the store, regardless of whether the store already has the latest version. Use this only when troubleshooting data inconsistencies, as it generates significant network traffic. The force-resync option is available in the store's detail page under advanced settings.

Best Practices

  • Check the dashboard daily. A quick glance at store connection statuses and error counts can catch problems before they affect operations.
  • Investigate errors promptly. Sync errors mean data is not flowing correctly. Sales from a disconnected store are not lost (they queue locally), but delayed data affects HQ reports.
  • Monitor stores after updates. After deploying a system update, watch the dashboard to confirm all stores reconnect and sync successfully.