Docs

Reports lifecycle

Report status labels, provenance, evidence, archive behaviour, and export options.

A report is a structured deliverable in your workspace — Markdown body, metadata fields, evidence notes, and optional links to workflow sessions.

Reports hold your operational content. WorkCheats stores, renders, and exports report artifacts. It does not execute commands or auto-generate findings from scans or tool output.

Create and edit reports

You can:

  1. Create a report from an active template (structure is snapshotted at creation time)
  2. Create a report without a template (user-created source)
  3. Edit report Markdown, fields, metadata, and evidence while the report is active

Report Studio preview is read-only in the current product slice — editing happens in the Markdown and fields UI.

Report status (metadata)

Reports support manual metadata statuses:

StatusMeaning
DraftWork in progress
ReviewReady for internal review
FinalMarked complete for your workflow

Draft, Review, and Final are metadata labels you set — they are not workflow session run statuses (such as active or completed), and they do not lock editing or export by themselves.

Source template provenance

Reports created from a template retain provenance to the source template:

Source template stateWhat you see
ActiveLink to the template
ArchivedSource template archived: {name} (non-link)
UnavailableSource template unavailable: {name} (non-link)

Archiving the source template does not archive the report.

Evidence and session linking

Reports may include:

  • Fields and Markdown body content you enter
  • Evidence items (including snapshots of note text and attachment metadata)
  • Linked workflow sessions shown on the report detail where available

Use in report (manual, partial)

When a workflow session has a linked report, you can use Use in report on a step to send:

  • Saved output note text, and/or
  • Attachment metadata (filename, type, size — not a substitute for your organisation's evidence handling)

You choose what to send. This is manual evidence capture — not automatic report generation.

If the linked report is archived, the session may still show the link, but the report cannot receive new evidence. Link a different active report to continue sending evidence.

See Sessions for notes, outputs, attachments, and linking a primary report at session start.

User content safety

All report body text, field values, evidence notes, and imported content are untrusted user content:

  • Review before sharing externally
  • Do not store secrets unless workspace policy allows it
  • WorkCheats renders content as safe text — not trusted HTML

See Security & Responsible Use for broader expectations.

Archive a report

When a report is no longer active:

  1. Open the report.
  2. Choose Archive.
  3. The report is hidden from active report lists (soft archive).

After archive:

  • The report cannot be opened for editing from normal active flows
  • Export actions are blocked for archived reports (JSON, Markdown, and PDF)
  • A report favorite shows Archived on the Favorites page with guidance that it cannot be opened from Favorites

Archiving a report does not delete linked session history or workflow records.

Export behaviour (active reports)

The report Export menu (active reports) supports:

FormatWhat you get
JSONManifest with report structure and metadata; sensitive field values redacted where applicable; attachment file bytes excluded
MarkdownRaw Markdown source; {{field_key}} tokens stay unresolved
PDFRendered PDF download; sensitive field values excluded where applicable; exports stay on your device

Exports never include attachment file bytes, signed URLs, or storage paths in the download payload.

Export may warn when required fields are empty. Very large PDF exports may be rejected with a size guard.

Archived or unavailable reports return not found for export actions — export is for active reports you can still open.

Export eligibility may also depend on content provenance and workspace policy (for example, some Marketplace-installed lineage). Details will expand in Import/Export trust docs.

Favorites

You can favorite active reports for quick access. Archived reports remain in favorites when Show archived is enabled but cannot be opened from the Favorites page.