Field reference
System Health Report
How to use System Health Report in Monitoring & Backups: access, working steps, fields, related records and troubleshooting.
Purpose and access
Review the available system health, logs, scheduled jobs and backup controls. A backup is useful only when its restore procedure and required recovery keys are known and tested.
This page is a settings page in System Admin → Monitoring & Backups. Use the link above to open the configured destination; permissions are checked by the destination service.
ERP links open in a new tab. Sign in with your own account; record visibility, actions and approval authority follow your assigned permissions. Screens can differ by company and configuration.
Before you start
Review the current settings or existing records and prepare the information needed for the change.
Confirm the company, party, dates, units and source references that apply. Select existing links carefully and check for an existing record before creating a duplicate.
Working steps
- Open System Health Report from System Admin → Monitoring & Backups, or use ERP Search.
- Review the existing configuration before editing.
- Complete the editable fields described below. Required fields and validation conditions must be satisfied; read-only values are set by the system or their source records.
- Add the required child rows. Review each row’s identifiers, linked records and values, using the child-table field reference below.
- Save the record and address validation messages. Reload and verify the saved values and relationships.
- Use any additional workflow actions only when the record and your role provide them. Saving this record does not automatically complete a related transaction or external action.
Field reference
These fields come from the installed ERP definition. Hidden fields and password inputs are omitted. Additional conditions, custom scripts and workflow rules can make a field required or read-only in a particular context.
| Field | Type / behavior | How to use it |
|---|---|---|
Total Background Workerstotal_background_workers | Int Optional | Enter a whole-number value. |
Background Jobs Checkbackground_jobs_check | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Queue Statusqueue_status | Table Optional | Add the relevant child rows and review required columns, quantities and references before saving. Linked record: System Health Report Queue |
Background Workersbackground_workers | Table Optional | Add the relevant child rows and review required columns, quantities and references before saving. Linked record: System Health Report Workers |
Scheduler Statusscheduler_status | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Oldest Unscheduled Joboldest_unscheduled_job | Link Optional | Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship. Linked record: Scheduled Job Type |
Failing Scheduled Jobs (last 7 days)failing_scheduled_jobs | Table Optional | Add the relevant child rows and review required columns, quantities and references before saving. Linked record: System Health Report Failing Jobs |
Databasedatabase | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Database Versiondatabase_version | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Storage Usage (MB)db_storage_usage | Float Optional | Enter a numeric value using the required unit and precision. |
Storage Usage By Tabletop_db_tables | Table Optional | Add the relevant child rows and review required columns, quantities and references before saving. Linked record: System Health Report Tables |
Bufferpool Sizebufferpool_size | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Binary Loggingbinary_logging | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Number of keyscache_keys | Int Optional | Enter a whole-number value. |
Memory Usagecache_memory_usage | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
SocketIO Ping Checksocketio_ping_check | Select Optional | Choose one of the configured list values. Status fields may be controlled by the record workflow.Available choices
|
SocketIO Transport Modesocketio_transport_mode | Select Optional | Choose one of the configured list values. Status fields may be controlled by the record workflow.Available choices
|
Public Files (MB)public_files_size | Float Optional | Enter a numeric value using the required unit and precision. |
Private Files (MB)private_files_size | Float Optional | Enter a numeric value using the required unit and precision. |
Number of onsite backupsonsite_backups | Int Optional | Enter a whole-number value. |
Backups (MB)backups_size | Float Optional | Enter a numeric value using the required unit and precision. |
Total Userstotal_users | Int Optional | Enter a whole-number value. |
New Users (Last 30 days)new_users | Int Optional | Enter a whole-number value. |
Failed Logins (Last 30 days)failed_logins | Int Optional | Enter a whole-number value. |
Active Sessionsactive_sessions | Int Optional | Enter a whole-number value. |
Last 10 active userslast_10_active_users | Code Optional | Administrator/integration field. Use a validated configuration or supported script and test its impact before deployment. |
Total Outgoing Emailstotal_outgoing_emails | Int Optional | Enter a whole-number value. |
Pending Emailspending_emails | Int Optional | Enter a whole-number value. |
Failed Emailsfailed_emails | Int Optional | Enter a whole-number value. |
Handled Emailshandled_emails | Int Optional | Enter a whole-number value. |
Unhandled Emailsunhandled_emails | Int Optional | Enter a whole-number value. |
Total Errors (last 1 day)total_errors | Int Optional | Enter a whole-number value. |
Top Errorstop_errors | Table Optional | Add the relevant child rows and review required columns, quantities and references before saving. Linked record: System Health Report Errors |
Child tables
Queue Status — child-row fields
| Field | Type / behavior | How to use it |
|---|---|---|
Queuequeue | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Pending Jobspending_jobs | Int Optional | Enter a whole-number value. |
Background Workers — child-row fields
| Field | Type / behavior | How to use it |
|---|---|---|
Queuesqueues | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Countcount | Int Optional | Enter a whole-number value. |
Utilizationutilization | Percent Optional | Enter the percentage expected by the calculation and verify the resulting amount. |
Failed Jobsfailed_jobs | Int Optional | Enter a whole-number value. |
Failing Scheduled Jobs (last 7 days) — child-row fields
| Field | Type / behavior | How to use it |
|---|---|---|
Scheduled Job Typescheduled_job_type | Link Optional | Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship. Linked record: Scheduled Job Type |
Failure Ratefailure_rate | Percent Optional | Enter the percentage expected by the calculation and verify the resulting amount. |
Storage Usage By Table — child-row fields
| Field | Type / behavior | How to use it |
|---|---|---|
Tabletable | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Size (MB)size | Float Optional | Enter a numeric value using the required unit and precision. |
Top Errors — child-row fields
| Field | Type / behavior | How to use it |
|---|---|---|
Titletitle | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Occurrencesoccurrences | Int Optional | Enter a whole-number value. |
Troubleshooting
- Not permitted: verify the account, role and source-document permission. Do not share an administrator login.
- Missing record or address: inspect the relevant Link or Dynamic Link fields; a matching title alone does not establish a relationship.
- Cannot save or change status: review required fields, read-only values, document status and the configured approval transition.
- Unexpected report or portal result: review company/date filters, source-document submission and the approved party or Employee link.