Skip to content

fix(hitl): document node.outputs block with per-field custom outputs #641

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dushyant-uipath merged 1 commit into from
May 7, 2026
+20 −0
Merged

fix(hitl): document node.outputs block with per-field custom outputs #641

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions skills/uipath-human-in-the-loop/references/hitl-node-quickform.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,12 @@ The node schema uses `fields[]` entries inside `inputs.schema`. Use these concep
]
}
},
"outputs": {
"output": { "type": "object", "source": "=result", "var": "output" },
"status": { "type": "string", "source": "=result.Action", "var": "status" },
"notes": { "type": "string", "source": "=result.notes", "var": "notes", "custom": true },
"decision": { "type": "string", "source": "=result.decision", "var": "decision", "custom": true }
},
"model": { "type": "bpmn:UserTask", "serviceType": "Actions.HITL" }
}
```
Expand Down Expand Up @@ -248,13 +254,25 @@ The HITL node exposes two outputs (`output`, `status`). After adding it, **compl
"id": "invoiceReview1.status",
"type": "string",
"binding": { "nodeId": "invoiceReview1", "outputId": "status" }
},
{
"id": "invoiceReview1.notes",
"type": "string",
"binding": { "nodeId": "invoiceReview1", "outputId": "notes" }
},
{
"id": "invoiceReview1.decision",
"type": "string",
"binding": { "nodeId": "invoiceReview1", "outputId": "decision" }
}
]
}
```

Include entries for **all** nodes in the flow, not just the HITL node. Replace the entire array — do not append.

**Per-field outputs:** When the schema has `output` or `inOut` direction fields, add one entry per field using the output key name from `node.outputs` (the `variable` property value, or the camelCase-derived name when `variable` is omitted). These are also materialized as flow-level globals in `variables.globals` with `direction: "out"`.

---

## Schema Conversion — Examples
Expand Down Expand Up @@ -350,6 +368,8 @@ After the HITL node, downstream nodes can reference:
| `$vars.<nodeId>.output` | object | All `output` and `inOut` fields the human filled in, keyed by **field `id`** |
| `$vars.<nodeId>.output.<fieldId>` | varies | Individual field value using the field's `id` property (e.g. `$vars.invoiceReview1.output.decision`) |
| `$vars.<nodeId>.status` | string | Selected outcome id (e.g. `"approve"`, `"reject"`) |
| `$vars.<nodeId>.<variable>` | varies | Per-field output also exposed as a named node variable (key matches `field.variable` or the derived camelCase name) |
| `$vars.<variable>` | varies | Workflow-global variable (`custom: true` in `outputs`). Accessible without the node prefix in downstream expressions |

> **`fieldId` not `variable`**: The output object properties are keyed by the field's `id` (e.g. `"decision"`), not by the `variable` property. The `variable` property creates a separate workflow-global variable (`$vars.{variable}`) — it does not change the key used in the output object. If a field has `"id": "dec1"` and `"variable": "approvalResult"`, access it as `$vars.nodeId.output.dec1`, not `.approvalResult`.

Expand Down
Loading