Portal Community

Review Task UI

Review tasks display the content to be reviewed in a read-only panel. Below the content, an Acknowledge button confirms the employee has read and understood the material. An optional comment field allows the reviewer to note observations.

Q1 Budget Report — Finance Review

Review  |  Workflow: Quarterly Budget Process  |  Requested by: Priya Sharma

Please review the Q1 budget summary below. Your acknowledgment confirms you have read and understood the report.

Q1 Budget Summary — Finance Department

Total Allocated: $450,000  |  Total Spent: $412,300  |  Variance: +$37,700 (under budget)

Marketing: $125,000 spent (budget: $140,000). Engineering: $180,000 spent (budget: $170,000 — over by $10,000). Operations: $107,300 spent (budget: $140,000).

Review Content Types

The content displayed in a review task is configured by the workflow designer in the HIL node. The content can be:

Content TypeDescriptionRendered As
Plain Text / MarkdownFormatted text from the workflow contextRendered Markdown with code blocks, tables
JSON DataStructured data object from upstream node outputSyntax-highlighted, collapsible JSON tree
HTMLRich HTML content generated by a prior node (e.g., report template)Sanitized iframe embed
Document LinkLink to a file stored in the workflow context or file servicePreview pane + download link
Atlas Form (read-only)A completed form rendered in view-only modeFormRenderer with mode="view"

Submit API — Review Acknowledgment

POST /api/executions/{executionId}/resume
Authorization: Bearer {token}
Content-Type: application/json

{
  "taskId": "...",
  "response": {
    "type": "review",
    "acknowledged": true,
    "comment": "Budget figures noted. Engineering overspend will be addressed in Q2 planning.",
    "acknowledgedAt": "2026-05-25T13:00:00Z"
  }
}

// Response: 200 OK
{ "status": "resumed", "taskId": "...", "taskStatus": "completed" }

Scroll-to-Bottom Requirement

For compliance-sensitive review tasks (e.g., policy acknowledgments, legal agreements), the workflow designer can enable a requireScrollToBottom flag. When enabled, the Acknowledge button is disabled until the employee has scrolled to the bottom of the review content. This creates a defensible record that the content was presented in full.

// HIL node config (Flow Studio — designer sets this)
{
  "type": "hil",
  "taskType": "review",
  "requireScrollToBottom": true,  // Acknowledge disabled until scrolled
  "requireComment": false,
  "content": {
    "type": "markdown",
    "source": "{{nodes.policyGenerator.output.policyText}}"
  }
}
Audit Trail

Every acknowledgment is stored with the actor's actorId, acknowledgedAt timestamp, and optional comment. This record is immutable and attached to the execution history — providing a legally defensible audit trail for compliance reviews.

Multi-Reviewer Acknowledgment

Like approvals, review tasks can be assigned to a role group. In this case, all members of the role must acknowledge independently. The workflow does not resume until all required acknowledgments are received. A progress indicator shows "3 of 5 acknowledged".