Reminder Log

What is the Reminder Log?

The Reminder Log is an immutable audit trail of every reminder the engine attempted to send. Each row represents one notification dispatch attempt — whether successful, failed, or skipped.

Log Fields

FieldDescription
Document TypeThe DocType of the document that triggered the reminder
Document NameThe name/ID of the specific document
Reminder RuleWhich rule generated this reminder
RecipientEmail address of the person notified
Reminder DateExact timestamp when the reminder was processed
StatusSent, Failed, or Skipped
Delivery TypeEmail or System notification
Escalation Level0 for normal reminders; 1, 2, 3… for escalation steps
MessageThe message body sent to the recipient

Status Values

  • Sent — The notification was successfully dispatched (email queued or system notification created)
  • Failed — An error occurred during dispatch (e.g., invalid email address, email server error). The error is recorded in the message field.
  • Skipped — The engine determined the reminder should not be sent (de-duplication, send window, holiday, or max reminders reached)

Permissions

The Reminder Log uses row-level permissions:

  • Regular users — Can only see log entries where they are the recipient
  • Approval Manager role — Can see all log entries
  • System Manager — Full access

Log Retention

A weekly cleanup task automatically deletes log entries older than the Log Retention (Days) value set in Settings (default: 90 days). This keeps the log table lean without requiring manual maintenance.

Was this article helpful?