Report Settings
The Settings tab controls what kind of file the report produces and what goes in it, and holds the feed that execution errors are written to.
An Analytic Rule has a Settings tab of its own, holding what the rule declares about itself. A report has none of those settings, because it delivers a file rather than detections.
File Type
| Field | Description |
|---|---|
| File Type | The format of the file the report produces. |
Four formats are available.
| Format | Notes |
|---|---|
|
CSV
CSV
Comma Separated Values is a file format with typically one record per line and fields delimited by a Click to see more details...,. Fields may be optionally enclosed with double quotes, though there is no fixed standard for CSV data, particularly when it comes to escaping of double quotes and/or commas. |
Comma delimited. For something else to read. |
| TSV | Tab delimited. For something else to read. |
| Excel | Includes an additional Info sheet recording the report name, description, and execution times. |
|
Markdown
Markdown
Markdown is a simple markup language for creating rich formatted text using a text editor. Due to the simplicity of the Markdown it is still very readable in its raw form that contains the markup. Markdown is used in Stroom on the Documentation tab of each Document type and in the Documentation Document type. Click to see more details... |
For a person to read. |
Choose Excel or Markdown where a person will read the report, and CSV or TSV where something else will consume it. The Excel Info sheet is worth knowing about, because it is where the recipient can see which period the report actually covers.
Send Empty Reports
| Field | Description |
|---|---|
| Send Empty Reports | Whether a report whose query returned no rows is still delivered. |
There is a real choice here. Delivering empty reports means the recipient knows the report ran and there was nothing to say, rather than being left to wonder whether it failed. Suppressing them avoids a stream of empty files for a report that is usually quiet.
Only emptiness suppresses delivery. A report that returned rows is always delivered however this is set, and a report that is suppressed is still recorded in the execution history as having run.
Note
AI Summary
A report can ask a model to summarise the data it produced and deliver that summary with the report.
| Field | Description |
|---|---|
| AI Summary | Whether to ask a model to summarise the report’s data. |
| AI Summary Model | The model to ask. Where this is not set, the model configured for Ask Stroom AI is used. |
| AI Summary Prompt | What to ask about the data. Where this is not set, a default prompt asks for a short summary of what the data shows and anything worth attention. |
Where the summary ends up depends on the file type, since CSV and TSV cannot carry prose without breaking them for whatever reads them.
| File Type | Where the summary goes |
|---|---|
| Excel | An AI Summary sheet. |
| Markdown | An AI Summary section after the table. |
| CSV, TSV | A separate Markdown file delivered alongside the report. |
The summary is also available to email templates as aiSummary and is recorded as a ReportAiSummary entry in the stream meta where the report is delivered to a feed.
Note
Warning
Use permission on the model document rather than the ability to read it.
See Also
Feed for Errors
| Field | Description |
|---|---|
| Feed For Errors | The
Feed
Feed
A Feed is a means of organising and categorising data in Stroom. A Feed contains multiple Streams of data that have been ingested into Stroom or output by a Pipeline. Typically a Feed will contain Streams of data that are all from one system and have a common data format. Click to see more details... that errors occurring during execution are written to. Use Set Default to use the feed configured for the system. |