Logs

What This Option Does

Logs module provides technical event/error visibility for troubleshooting.

How Admin Uses This

1. Open Logs viewer.
2. Filter/select relevant log source.
3. Inspect error or warning entries.
4. Use findings to guide issue resolution.

Screenshot Placeholder

Add screenshot file at documentaion/assets/images/backoffice-logs.png

Enterprise Technical Specification

Business Capabilities

• Log list/view/download/delete

API Contract Surface

Primary API endpoints used by this module:

• /api/v1/logs
• /api/v1/logs/{filename}
• /api/v1/logs/{filename}/download
• /api/v1/logs/{filename}

Permission Blueprint

Recommended permission keys for production role design:

• backoffice.log.view
• backoffice.log.download
• backoffice.log.delete

Operational Risk and Control Notes

• Deleting logs removes forensic evidence
• Enable activity logging and include company_id, actor ID, and target entity ID in audit traces.
• Apply least-privilege principle for create/update/delete actions.

QA Verification Checklist

• Validate list API load, empty-state behavior, and pagination consistency.
• Verify create/update/delete response contract (status, message, data).
• Confirm permission denial responses for unauthorized roles.
• Test edge inputs and invalid IDs for safe error handling.