Skip to main content
Version: Aeon 7.0

Reporting an Issue

When something in Aeon doesn't behave the way you expect, you can report it without leaving the screen it happened on. The Report an Issue button captures what you were looking at — a screenshot and the technical context behind it — so the report arrives with the evidence already attached instead of a description written from memory an hour later.

Because the capture is a picture of your actual screen, it may include a researcher's name or other patron details. The editor built into the report is where you take those out before you send it.

When you'll use this
  • Something errored, or did the wrong thing, and you want it looked at.
  • A screen is hard to read or work with and you want to say so with a picture rather than a paragraph.
  • You've found a way to reproduce a problem and want to send the exact state it happens in.

Sending a report​

  1. With the problem on screen, click the round bug button in the bottom-right corner of the window. Its tooltip reads Report an Issue.
  2. Your browser asks what to share. Choose the tab Aeon is in — choosing your whole screen captures everything else that's open too. Aeon takes the screenshot and opens the Report an Issue dialog, which explains: "Describe the issue you encountered. A screenshot and context have been automatically captured." If you decline the browser's prompt, the dialog opens without a screenshot or the editor, and you can still send the report.
  3. Edit the screenshot if it needs it — see Editing the screenshot below.
  4. Pick a Severity (Minor is preselected): Cosmetic ("Visual or minor UI issue"), Minor ("Issue with workaround available"), Major ("Impairs workflow significantly"), or Blocker ("Blocks a key workflow entirely").
  5. Fill in What happened? This one is required — the Submit Report button stays disabled until it has text.
  6. Optionally fill in What did you expect?
  7. Click Submit Report. Aeon confirms with the report's number — "Bug report #123 submitted".

Cancel closes the dialog and discards everything, screenshot included.

What gets sent with it​

Below the text boxes, Auto-captured context summarizes the context that travels with your report: the page address and any Route params in it, your username as the reporter, the SignalR (real-time connection) state, how many recent actions and console errors were recorded, how many network requests failed, and how much of the recent system log is included.

The summary shows counts; the report carries the entries behind them — up to 50 recent actions, console errors, and failed requests, and up to 500 system log entries from the last 30 minutes. It also includes details the summary doesn't list: your browser, window and screen size, platform, and language; the Aeon version; how long you've been signed in; a snapshot of the customization values loaded in your session; and a session ID that links the report to the Log Viewer. Response bodies from Aeon's API are removed before the report is sent.

Editing the screenshot​

The toolbar above the captured image has four tools, plus Undo and Reset. A one-line hint under the canvas tells you what the tool you've picked expects.

ToolWhat it doesThe hint it shows
CropTrims the image to a rectangle."Click two corners or drag to draw."
RedactBlacks out a rectangle — this is the one for patron names, emails, and addresses."Click two corners or drag to draw."
AnnotateCircles something, or draws freehand."Click to circle a spot, or drag to draw freehand."
Text LabelAdds a pointed label."Click where the label should point."

Undo removes the last thing you did; Reset puts the image back the way it was captured.

Click-click, or drag — both work​

Crop and Redact don't need a steady drag. Click one corner of the area, move the pointer — a preview follows it so you can see the rectangle you're about to make — then click the opposite corner. Dragging from one corner to the other also works.

Annotate works the same way: a single click drops a circle on the spot, while dragging draws freehand.

If you start a rectangle and change your mind, press Esc. That cancels the pending corner and clears the preview, so nothing uncommitted is left painted on the image. Esc also cancels a text label you haven't finished.

Redact before you send

Aeon's capture is a picture of the screen as it was, so anything visible on it — a patron's name, their email address, the contents of a note — is in the image. Use Redact on those areas before submitting. Once the report is sent, the image goes with it.

Permissions and availability

The Report an Issue button appears only when your role has System Diagnostics configuration access, because a report embeds the recent system log and that log is governed by the same permission. Administrators can also turn the feature off for the whole site with the WebIssueFeedback customization key (Staff Interface → Dashboard), in which case the button isn't there for anyone.