API Health State
Table of Contents
Introduction
API Health State provides monitoring and ensures integration of Microsoft services.
This functionality:
- allows the system to track and report the health status of API services including OneDrive, Outgoing Mail Server, Incoming Mail Server, and User Sync.
- records the execution of API calls and maintains logs on connection status for each service.
Navigation
Go to Settings > API Health States.
There are two submenu items: M365 Connection Status and User Sync.
Forms Overview
User Sync
The User Sync page provides a detailed breakdown of each M365 user account, their synchronisation status and categories.
| Field (Column) | Description |
|---|---|
| User name | the name of the ERP user |
| Microsoft365 Email | the M365 email address (as configured in the Preferences tab), |
| State |
user's current connection state: Connected or Not Connected.
This reflects the same status shown in the user’s Preferences. |
| Sync ERP Activities |
a name of the ERP category for synchronisation.
The checkbox gets ticked automatically once it is set in Preferences > Calendar Sync / Mail Sync preferences. |
| Sync Office365 Events |
a name of the ERP category for synchronisation.
The checkbox gets ticked automatically once it is set in Preferences > Calendar Sync / Mail Sync preferences. |
| Sync Holidays |
a name of the ERP category for synchronisation.
The checkbox gets ticked automatically once it is set in Preferences > Calendar Sync / Mail Sync preferences. |
| Lead |
a name of the ERP category for synchronisation.
The checkbox gets ticked automatically once it is set in Preferences > Calendar Sync / Mail Sync preferences. |
| Prospect |
a name of the ERP category for synchronisation.
The checkbox gets ticked automatically once it is set in Preferences > Calendar Sync / Mail Sync preferences. |
| Customer |
a name of the ERP category for synchronisation.
The checkbox gets ticked automatically once it is set in Preferences > Calendar Sync / Mail Sync preferences. |
| Supplier |
a name of the ERP category for synchronisation.
The checkbox gets ticked automatically once it is set in Preferences > Calendar Sync / Mail Sync preferences. |
| Inbox |
a name of the ERP category for synchronisation.
The checkbox gets ticked automatically once it is set in Preferences > Calendar Sync / Mail Sync preferences. |
| Outbox |
a name of the ERP category for synchronisation.
The checkbox gets ticked automatically once it is set in Preferences > Calendar Sync / Mail Sync preferences. |
M365 Connection Status
The M365 Connection Status list view provides a real-time overview of the system’s connection of Microsoft services.
| Field/Column | Description |
|---|---|
| Resource |
It displays the service name:
|
| the connected Office365 email | |
|
displays the current state:
|
| Active |
|
Connection State History
To view Connection State History, open the record in the form view.
In the Connection State History section, you can:
- track when the last health check was performed;
- verify whether the server was successfully synchronised at that time.
When the server status is Not Sync, the Reason section displays:
- either a system-generated comment;
- or the actual Traceback message received from Microsoft with the cause of the issue.
Monitoring Frequency
The monitoring of API Health is performed every hour by the scheduled job (cron) Monitor M365 Connection Status, which automatically checks the connection status of all active servers.
