Help Link Parameters
Use these parameters when linking from WorkBench into Help.
| Parameter | Use | Example |
|---|---|---|
context |
Preferred link target for a WorkBench area. | workbench.export |
topic |
Direct topic target when a specific help page is required. | workbench.fidelity.receipts |
product |
Product identifier for the requesting surface. | data-workbench |
surface |
Optional WorkBench surface identifier. | workbench.header |
format |
Optional active source format. | json, csv, xlsx |
depth |
Optional requested detail level. | overview, guide, reference |
return |
Optional non-sensitive return target. | workbench |
WorkBench Runtime Areas
Operational reference for the local browser-side WorkBench surface.
Parse
JSON, XML, delimited, text, and workbook sources become interpreted sources with diagnostics.
Render
Explorer, Raw, Table, Diff, Diagnostics, Trust, Export, and Jigs present the current source state.
Edit
Raw, Explorer, and table edits update the active source state before export.
Diff
Diff views compare current data against original or exported representations.
Diagnostics
Parse, format, Unicode, delimiter, representation, and conversion risks are reported before output is trusted.
Export
Exports produce target output with a receipt. Preview and copy are review actions, not hidden conversion approval.
Source Locator
JSON, XML, text, CSV, TSV, and OtherSV save-back requires a writable file locator and overwrite confirmation. Without a locator, use download or copy.
Jigs
Jigs store interpretation rules, mapping, validation expectations, export options, and risk expectations.
Escape Tools
Text utilities inspect invisible characters and apply explicit escape, unescape, encode, or decode transforms.
Current Help Contexts
Stable targets used by WorkBench Help links.
| Context | Opens | Use When |
|---|---|---|
workbench.intake |
Loading Sources | Loading files, pasting data, choosing formats, or opening samples. |
workbench.trust |
Trust Summary | Reading safe, warning, blocked, changed, or review-required states. |
workbench.fidelity |
Fidelity Receipts | Checking representation changes, assumptions, loss notes, or receipt state. |
workbench.fidelity.receipts |
Fidelity Receipts | Opening receipt guidance directly. |
workbench.export |
Export Review | Previewing, exporting, copying, downloading, or reviewing output. |
workbench.save-back |
Save-Back Safety | Deciding whether an original file can be overwritten. |
workbench.jigs |
Jigs And Rulesets | Applying, editing, importing, exporting, or explaining Jigs. |
Privacy And Safety
Help links must not carry source data.
Do not place source text, file contents, customer data, local file paths, credentials, tokens, connector payloads, or raw error bodies in Help links.
Use a context or topic identifier instead. The WorkBench source remains in the WorkBench tab; Help only receives the non-sensitive context needed to open the correct guidance.