All docs
Work
Reports
The two kinds of page a Worker pushes to you, and how they are grouped, answered, withdrawn and shared.
A report is a page a Worker pushes for you to read. There are two kinds:
- Review Report: asks you to answer questions or make a decision. You answer on the page, and the answer returns as a message to the session that pushed it.
- Presentation Report: shows you a result as web slides. The last slide can be a comments page.
Grouped by workflow organization
Each workflow organization has at most two reports, named after it: <organization>-R is its Review Report and <organization>-P is its Presentation Report. Whichever run, step or Worker in the organization pushes, the push is appended as a new version of the corresponding report.
The report menu in the UI lists the report names directly; pick one and switch between its versions.
Pushing
All pushes are command-line calls inside a session, and the pusher is the session that calls. The command does not wait for your answer; it returns the report name, the version number and a link.
| Command | What it does |
|---|---|
ail report review <dir or file> --title <title> |
Push a version of the Review Report |
ail report present <dir or file> --title <title> |
Push a version of the Presentation Report |
ail report ask <question.json> |
A question that needs no pictures: no page is built, the Desk presents the question |
ail report preview <dir or file> |
Push a preview, visible only to whoever has the address, kept for 24 hours |
ail report withdraw |
Withdraw the versions this session pushed that are still waiting for an answer |
- The content is one HTML file, or all files in a folder, at most 64 MiB in total.
- Unchanged content produces no new version.
- When a session pushes a new version, its earlier versions that were still waiting for an answer are withdrawn.
The question for ail report ask is a JSON document:
{
"title": "Which columns to export",
"ask": "I will continue the implementation once the scope is fixed.",
"question": "Export every column, or only the visible ones?",
"options": [
{"name": "Every column", "effect": "The file is complete but includes columns the user hid"},
{"name": "Visible columns", "effect": "Matches the page"}
],
"recommend": "Visible columns",
"reason": "It matches what the user sees on the page"
}
Answering
You answer in the bar at the bottom of the Review Report page and submit. The Desk records the answer on that version and queues it for the session that pushed the version; if the session is busy it is delivered when the turn ends. It does not pass through the Router.
If the pusher's run has already ended, the answer still arrives: the session reconnects, and the Worker still has its context.
Waiting and withdrawing
A version of a Review Report waits for an answer from the moment it is pushed until you answer or skip it, it is withdrawn, or the same session pushes a new version. A waiting version is marked in the UI, and its run shows as waiting on the board.
Sharing
Sharing exists only when the Desk was started with --share-listen: it opens a second listener that serves nothing but shared reports. "Share" in the report header creates a link, and "Stop sharing" invalidates it immediately. What reviewers submit goes only to the Desk; you collect it and pass it on to the agent.