Monitor ERP sync in Omnilinker

Omnilinker shows two kinds of information about an ERP connection:

• Whether the agent is alive. The ERP Sync agent sends Omnilinker a heartbeat every 60 seconds. The connection’s Agent tab shows when the last one arrived.
• What happened to each change. Every change the agent sends is recorded as a sync log entry. The Sync Logs pages and the dashboard summarize these entries.

To see what the agent itself is doing on the machine it runs on, use the tray app.

​

Where to look

Everything is under ERP Integration in the main menu: The ERP Integration menu appears only when the ERP Integration feature is enabled for your organization. See Modules and feature availability.

​

Dashboard

ERP Integration > Dashboard opens the ERP Integration Dashboard. It loads once when you open it. Click Refresh in the Connections Overview card to load it again. The four cards at the top count sync log entries of your active connections, over all time: Connections Overview shows up to six connections as cards. Each card shows the connection name, its provider, an Active or Inactive badge and the time of the last successful sync. The dot before the name is gray for an inactive connection, amber when the connection has never synced or last synced more than 24 hours ago, and green otherwise. Click a card to open the connection. View All opens Connections. The sync button on an active connection’s card does the same as Trigger Sync on the connection page. See the warning below. Recent Activity lists the 10 newest sync log entries across all connections, with Timestamp, Connection, Entity Type, Direction (From ERP or To ERP) and Status. It is hidden when there are no entries. View All opens Sync Logs.

​

Connections

ERP Integration > Connections lists your connections with these columns: Status only tells you whether the connection is switched on. An Active connection whose agent is offline is still Active. To see whether the agent is running, open the connection and check its Agent tab. An Inactive connection does not accept anything from the agent: its heartbeats and changes are rejected until you activate it again. To switch a connection on or off, open the row’s Actions menu and click Activate or Deactivate (requires the Edit ERP Connection permission).

​

Connection details

Click Details in a connection’s Actions menu, or a connection card on the dashboard, to open the connection page. The header card shows the Provider, the Status (Active or Inactive), Last Sync and the description. Below it are the tabs.

​

Agent tab

The Agent tab (On-premise Agent) shows what the agent last reported in its heartbeat. It is Omnilinker’s view of the agent, so it works from any computer. It loads when you open the tab; click Refresh to load it again. Until the agent has connected for the first time, the tab says No agent has connected yet. The agent sends a heartbeat every 60 seconds, so a healthy agent never shows more than about a minute here. When the agent is offline. Offline means Omnilinker has had no heartbeat for more than 3 minutes. The agent may be stopped, unable to reach omnilinker.pl, or rejected by Omnilinker (revoked API key, inactive connection, or an agent version that is too old). Last heartbeat tells you when it stopped. See Troubleshooting. Configuration drift. When you change the connection’s settings, its configuration version goes up. If the agent is still on an older version, the tab shows Configuration drift detected: “The agent is running configuration version <n>, but the current version is <m>.” The agent notices the change at its next heartbeat and downloads the new configuration. If the banner stays for more than a few minutes, the agent is probably offline. When the agent version is too old. Omnilinker can set a minimum supported agent version. An agent older than that is rejected on every request with the error “Agent version <version> is no longer supported (minimum supported version: <minimum>). Please update the ERP Sync agent.” You do not see this message in the web app. What you see is:

• Health turns Offline and Last heartbeat stops moving, because heartbeats are rejected too.
• Agent version still shows the old version, from the last heartbeat that was accepted.

The error message itself is in the agent’s log file. The agent updates itself at night when a newer version is published. If the tab stays Offline, update it by hand. See also Troubleshooting.

​

Local Service tab

The Local Service tab reads the agent’s status directly from the agent’s local API at http://localhost:5555, from the browser you are using. It refreshes every 5 seconds. Because it uses localhost, it shows the agent only when you open Omnilinker in a browser on the computer where the agent is installed. On any other computer it shows Local Sync Service Not Available. That is expected and does not mean the agent is down; use the Agent tab instead. The install steps shown under that message are generic. To install the agent, follow Install the agent. When the agent is reachable, the tab shows:

• Service Status: the agent’s state (Idle, Syncing, Paused, Error, Starting or Stopping), Cloud Connection and ERP Connection (Connected or Disconnected), Last Sync and Next Sync (or Not Scheduled).
• Last Error, when there is one.
• Sync Now, Pause (while syncing), Resume (while paused) and Refresh. These act on the agent on this computer.
• Outbox Statistics: events Pending, Sent, Failed and Retrying in the agent’s local queue.
• Entity Statistics: per entity type, Total, Synced, Pending and Failed events in the queue.
• Recent Activity: the agent’s 10 latest log entries, with Timestamp, Level and Message.
• Service Version: the agent’s version.

The tab expects the local API on port 5555. If LocalApiPort was changed, it cannot reach the agent. See the configuration reference.

​

Sync logs

A sync log entry is created in Omnilinker for each change it processes from the agent. Each entry has: Statuses The tables show no status badge for Skipped entries. Look at the error message to tell them apart. Common reasons for Skipped. The reason is stored as a code: When Omnilinker cannot process a change from the ERP because of an error, it does not record a Failed entry. It rejects the change, and the agent sends it again later. Those errors appear in the agent’s log, not here. See Troubleshooting.

​

Sync Logs page

ERP Integration > Sync Logs lists the entries of all your connections, newest first, 20 per page.

• Connection: All Connections or one connection.
• Status: All Statuses or one status.

The columns are Timestamp, Connection, Entity Type, Operation, Status, Error and Actions. Hover over the Error badge to read the message.

​

Sync Logs tab

A connection’s Sync Logs tab shows only that connection’s entries and has more tools. The summary cards show Total Operations (all time), Completed with the Success Rate, Failed (click it to show only failed entries) and In Progress (pending and processing). Filters and tools:

• STATUS: All, Completed, Failed, Pending or Processing.
• A time range: Last 24 hours, Last 7 days, Last 30 days, Last 90 days or All time (the default).
• Search Entity ID…: finds entries by entity identifier or ERP entity ID.
• Export CSV (download icon): downloads the entries that match the filters as a CSV file.
• Clean Up (requires the Delete Sync Logs permission): deletes entries older than a number of days, 30 by default. Click Preview to see how many will be deleted, then Delete Logs. This cannot be undone.

The columns are Type, Operation, Entity ID, Status, Retries, Time and Actions. For an entry with an error message, click the error icon to open Sync Log Details, with the full Error Message, the Change Payload and buttons to copy them. Select entries with the check boxes to use Retry Selected (for failed entries) or Delete Selected (requires the Delete Sync Logs permission).

​

Retry

Retry is available on Failed entries (requires the Trigger Manual Sync permission), at most 3 times per entry. It sets the entry back to Pending and adds one to Retries.

​

Related pages