Administration
Module "Feedback"
The module Feedback has its own entry in the module menu. Administrators see all feedback there. Editors who may send feedback and have the module granted (see Who may send feedback) see only the feedback they sent themselves, with message, screenshot, collected details and the status; delivery details and all actions stay with administrators.
- List
- Newest first, with date, category, severity, source, sender and their email address, the start of the message, a screenshot marker, the status and the delivery status.
- Search and filter
- Above the list, the search finds feedback whose message, sender name or username, reported URL or page title contains the term. Filters for status, category, severity, source and, for administrators, delivery status narrow the list further. Search and filter stay in the URL, so they survive paging and the way back from the detail view, and can be bookmarked. Reset shows all feedback again. Editors search their own feedback only.
- Detail view
- The full message, the status, the delivery status, the number of delivery attempts and the log, the screenshot (click to open it in full size) and all collected details. For feedback that is Failed or Pending, the button Deliver again starts a new delivery attempt right away; it ignores redeliverMaxAttempts. The result is shown as a message and appended to the log.
- Status
- Every feedback starts as New. Administrators set it to New,
In progress or Closed in the detail view with
Save status. The status is independent of the delivery: it
neither starts nor changes a delivery. Feedback stored before version 1.2
gets the status New when the database schema is updated
(
vendor/or the database analyzer).bin/ typo3 extension: setup - Reported URL
- The detail view and the email show the URL the feedback was sent from
once, below the sender: the browser URL, or the backend module URL when
the browser URL is not collected. It is linked only when it starts with
http://orhttps://; in the detail view it opens in a new tab.
The records live on the root level (pid = 0), are read-only and are not
shown in the List module.
- Delivery status
- Sent when every delivery channel succeeded, Failed when one failed (the log tells why, for example a missing recipient or a mail transport error), Pending while the delivery has not finished, Not delivered when no delivery channel is enabled (see disabledDeliveryChannels). Not delivered feedback is never delivered again.
Deliver feedback again
A feedback stays Failed or Pending when its delivery did not succeed,
for example while the mail server was down. The console command
opinion: delivers these records again, oldest first, through all
enabled delivery channels.
# Failed or pending feedback older than 10 minutes
vendor/bin/typo3 opinion:redeliver
# Include feedback of the last minutes as well
vendor/bin/typo3 opinion:redeliver --min-age=0
# Only report what would be delivered
vendor/bin/typo3 opinion:redeliver --dry-run
Feedback younger than -- minutes (default 10) is skipped, its first
delivery may still be running. Records that reached
redeliverMaxAttempts attempts, counting the first one, are
skipped too. The command exits with a non-zero code when a record is still
undelivered afterwards.
To retry regularly, add a Scheduler task Execute console commands
with the command opinion:, for example every 30 minutes.
Clean up old feedback
The console command opinion: deletes feedback records older than
retentionDays, including their file references and
screenshot files.
# Older than retentionDays of the extension configuration
vendor/bin/typo3 opinion:cleanup
# Older than 30 days
vendor/bin/typo3 opinion:cleanup --days=30
# Only report what would be deleted
vendor/bin/typo3 opinion:cleanup --dry-run
The command exits with a non-zero code when a record or file could not be deleted.
To run it regularly, add a Scheduler task Execute console commands
with the command opinion:.
Data and privacy
- Feedback is only accepted from logged-in backend users who may send feedback, at most rateLimit per user and hour.
- Screenshots are stored in a non-public file storage below
var/, outside the web root. TYPO3 serves them through its file dump URL only, and only to requests with the session of an administrator or of the sender of the feedback.opinion/ - Blacked-out areas are burnt into the screenshot in the browser; the original capture never leaves the page.
- The browser sends a fixed set of details only, the server drops every
other key. Cookies,
localandStorage sessionare never read.Storage - Every detail except the sender can be switched off, see Collected details.
- The IP address is stored anonymised.
opinion:enforces the retention period.cleanup