docs(reporting): document the Report Builder CSV, Excel and JSON formats - #16036
Open
blakeaowens wants to merge 1 commit into
Open
blakeaowens wants to merge 1 commit into
blakeaowens wants to merge 1 commit into
Conversation
A Generated Report can now be produced as CSV, Excel or JSON alongside PDF and HTML. The data formats carry the rows a report is built from rather than the document built around them, which is what makes a report automatable: a script, a spreadsheet or a downstream system can consume one directly. Documents what a reader needs to know before choosing one: - The five formats, split into the Document and Data groups. - That a data format includes only Tabular and Detail blocks, because a cover page, a chart or a widget has nothing to put in a cell, and that the generate dialog names the included and left-out blocks before you generate. - The per-format shape: CSV sections for a multi-block template, one Excel worksheet per block, and the JSON envelope (with a worked example), including why JSON rows are keyed by field path rather than by label. - How truncation is reported in each format. - The `file_format` values on the API, and the Triage Engine report node's Format setting. English only; translated pages are regenerated on the quarterly refresh. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
A Generated Report can now be produced as CSV, Excel or JSON alongside PDF and HTML. This documents the new formats.
The documents (PDF, HTML) are what you send to a reader. The data formats carry the rows a report is built from rather than the document built around them, which is what makes a report automatable: a script, a spreadsheet, or a downstream system can consume one directly, including from a scheduled rule.
What the docs now cover
Report Builder page
# <block header>comment line. Excel gives each block its own worksheet, named after the block header. JSON is one object carrying the report name and generation time, then ablocksarray.Report Builder API page
file_formattable with all five values, and which three are the ones to automate against.FILE_FORMATcomment.Triage Engine node reference
report.generatenode's Format setting, with the same caveat about which blocks a data format carries.Notes
English only. Translated pages are regenerated on the quarterly refresh per
docs/TRANSLATIONS.md, so no.<lang>.mdfiles are touched here.Paired with the Enterprise change that adds the formats; both sit on the
bugfixline.🤖 Generated with Claude Code