Skip to content

Documentation

Reports

Check audit readiness per framework, generate compliance snapshots, create saved reports, generate and download report snapshots, and schedule them.

Overview

The Reports page brings together two kinds of output:

  • Compliance snapshots: a point-in-time evaluation of one framework’s controls. The Audit Readiness ledger shows how fresh each framework’s latest snapshot is and whether it is defensible in an audit.
  • Saved reports: reusable report definitions over your live estate (inventory, asset audit, software, topology, budget and more). Export one on demand, generate stored snapshots of it, or put it on a schedule.

Open it from Govern › Reports in the sidebar.

Screen tour

  1. Readiness sentence: a one-line summary, for example 0 of 6 frameworks are audit-ready. 4 missing. 2 with failing controls.
  2. Framework row: the readiness state, framework name and basis. Click it to open the framework’s compliance side sheet.
  3. Freshness: the age of the latest snapshot against the framework’s re-snapshot cadence, for example 40d ago of 90d.
  4. Generate: generates a fresh compliance snapshot for this framework.
  5. Export PDF: downloads the latest snapshot of this framework as PDF.
  6. Search reports…: filters saved reports by name, description or type.
  7. Export list: downloads the list of saved reports as CSV.
  8. Create report: opens the Create report dialog.
  9. Generate Snapshot: generates a compliance snapshot for a framework you pick from a list.
  10. Quick type filters: Compliance, Inventory, License and Asset Audit.

Below the toolbar, the Saved reports table lists your report definitions. Click Filters to filter them by type and format.

Audit readiness

The Audit Readiness ledger has one row per framework: NIST 800-53, CIS Controls, PCI-DSS, HIPAA, SOC 2 and ISO 27001. Rows are sorted worst first. The header shows how many frameworks are within cadence, how many findings are open, and when the data was loaded (As of time).

Each row shows:

  • State: see the table below.
  • Basis: why the row has that state, for example No open findings, 2 failing or overdue · 3 to review.
  • Freshness: No snapshot, Today or {n}d ago, followed by the cadence (of 90d).
  • Meter: the share of controls passing, failing and awaiting review.
  • Counts: passing and failing controls (for example 4P / 1F), with chips for warnings, accepted gaps and controls that need review.

Readiness states

StateMeaningNext possible state
No snapshotNo compliance snapshot exists for the frameworkDefensible or Open findings after you generate one
OverdueThe latest snapshot is older than the framework’s re-snapshot cadenceDefensible or Open findings after you generate a fresh one
Open findingsThe latest snapshot has failing or needs-attention controls that are not formally accepted, or manual controls that are not attestedDefensible once findings are fixed or accepted and you generate a new snapshot
DefensibleA fresh snapshot with no open findingsOverdue when the snapshot ages past the cadence; Open findings if a new snapshot finds gaps

Freshness and cadence

Each framework has a recommended re-snapshot cadence:

FrameworkRe-snapshot cadence
NIST 800-5390 days
CIS Controls90 days
PCI-DSS60 days
HIPAA60 days
SOC 290 days
ISO 2700190 days
FreshnessRule
FreshThe snapshot is 14 days old or less
AgingOlder than 14 days, but within the cadence
StaleOlder than the cadence; the row reads Overdue
No snapshotNo snapshot exists

When every framework is ready, the readiness sentence reads All 6 frameworks are audit-ready. and tells you when the next re-snapshot is due.

Generate a compliance snapshot

A compliance snapshot re-evaluates every control of one framework against live data and stores the result.

  1. Do one of the following:
    • Click Generate on the framework’s row.
    • Click Generate Snapshot and pick the framework.
    • Press g and the framework’s letter (see Keyboard shortcuts).
  2. Wait while the button reads Generating {framework}….
  3. Read the confirmation, for example NIST snapshot generated. The ledger updates.

  1. Select framework: pick the framework to snapshot.

Generating a snapshot needs compliance:write. If your role requires multi-factor authentication for sensitive actions, you must have signed in with MFA. Snapshots generated here are the same compliance reports you generate on the Compliance page.

The framework side sheet

Click a framework row to open its compliance side sheet.

  1. Framework: the framework name, followed by Pass, Fail, Warning, Needs review and Assets counts from the latest snapshot, and Last snapshot: {age}.
  2. Generate fresh snapshot: generates a new snapshot for this framework.
  3. Export PDF: downloads the latest snapshot as PDF.
  4. Control Breakdown: controls grouped by severity, with pass, fail, warning, not-applicable and to-review counts per group. Failing, warning, not-applicable and unreviewed controls are listed; unreviewed ones carry a Needs review tag.

When the snapshot is older than the cadence, the sheet adds This snapshot is {n} days old. Most teams re-snapshot every {cadence} days. Close the sheet with ×, x or Esc.

Create a saved report

  1. Name: the report name, for example Q2 Asset Inventory. Required.
  2. Description (optional): what the report covers.
  3. Type: what the report contains. A hint under the fields describes the selected type.
  4. Default format: the format used when you don’t choose another one.
  1. Click Create report.
  2. Enter a Name and, optionally, a Description.
  3. Choose the Type and Default format.
  4. Click Create report. The page shows Report “{name}” created.

Create report stays disabled until you enter a name.

Report types and formats

Every report type can be exported in every format.

TypeContentsCSVPDFExcel (.xlsx)XML
Inventory SummaryAsset counts and type breakdown✓✓✓✓
Asset AuditPer-asset detail listing✓✓✓✓
Software Inventory (shown as License in the list)Installed software titles✓✓✓✓
Compliance Report (estate summary)High-level estate summary; per-control results live on the Compliance page✓✓✓✓
TopologyNetwork topology and connectivity map✓✓✓✓
Budget ForecastCost projection and budget analysis✓✓✓✓
Custom (estate summary)Estate summary✓✓✓✓

Excel files are real .xlsx workbooks.

Saved reports

The Saved reports table lists your report definitions.

  1. Name: the report name, with its description underneath. Click the row to open the report side sheet.
  2. Type: the report type, for example Inventory Summary.
  3. Format: the report’s default format.
  4. Export: one button per format, and a delete button.
ColumnContent
NameThe report name, with its description underneath
TypeInventory Summary, Compliance, Asset Audit, License, Topology, Budget Forecast or Custom
FormatThe default format: CSV, PDF, Excel (.xlsx) or XML
UpdatedWhen the definition last changed
ExportOne button per format, and a delete button

Click a column header (or press Enter on it) to sort. The line under the table reads Showing {n} of {total} saved reports, with (filtered) when a filter is active. Before you create your first report, the table shows No saved reports yet. with a Create report button.

Click a row, or press Enter on it, to open the report’s side sheet.

Filter saved reports

  • Type in Search reports… to match the name, description or type.
  • Click a quick type filter: Compliance, Inventory, License or Asset Audit.
  • Click Filters and tick Report Type (Compliance, Inventory Summary, Asset Audit, License, Topology, Budget Forecast, Custom) or Format (CSV, PDF, Excel (.xlsx), XML).

Active filters appear as chips. Click × to remove one, or Clear all. If nothing matches, click Clear filters.

Export a report on demand

Click CSV, PDF, Excel (.xlsx) or XML in a row’s Export column. DeviceQuest renders the report from live data and downloads report-{id}-{timestamp}.{ext}. The page shows Exported: {file name} and remembers the format you used for that report. Press e on a focused row to export it again in that format.

Delete a report

  1. Click the delete button in the row.
  2. In the confirmation, read Delete report “{name}”? This cannot be undone.
  3. Click Delete. The page shows Report “{name}” deleted.

Export the list

Export list downloads the saved-report list as reports-{all|filtered}-{YYYY-MM-DD}.csv with the columns Name, Type, Format, Created and Last Updated.

The report side sheet

The report side sheet shows one saved report: its type and format chips, name and description, Created and Last updated dates, and three panels: Snapshots, Scheduling and Report Filter.

  • Export: opens a list of formats (CSV, PDF, Excel (.xlsx), XML) to export the report from live data, as from the table.
  • Close the sheet with ×, x or Esc.

  1. Snapshot format: the format for Generate now, here Default (CSV).
  2. Generate now: stores a snapshot of the report now.
  3. Snapshot: its date and time, format, size and how it was produced.
  4. Download: downloads the snapshot.
  5. Add schedule: opens the schedule editor.
  6. Schedule: its summary, format, next run and last run.
  7. Edit and Delete: change or remove the schedule.

Snapshots

A report snapshot is a stored copy of the report, generated at a point in time. Snapshots let you hand an auditor exactly what the report said on a given date. DeviceQuest keeps the 50 most recent snapshots per report.

Each snapshot in the list shows its date and time, format, size and how it was produced: Scheduled, Generated now or API.

To generate a snapshot now:

  1. In Snapshots, choose the format: Default ({format}), CSV, PDF, Excel (.xlsx) or XML.
  2. Click Generate now. The button reads Generating…, then the panel shows Snapshot generated.

To download a snapshot, click Download next to it. The file is named report-{id}-{generation time}.{ext}.

Before the first snapshot, the panel reads No snapshots yet. Generate one now, or add a schedule below to produce them automatically.

Scheduling

A schedule generates a snapshot automatically, and can e-mail it. When e-mail delivery is set up on your server, the panel hint reads Each scheduled run stores a snapshot and can e-mail it. Times are UTC. Otherwise it reads Each scheduled run stores a snapshot. Times are UTC. E-mail delivery is not configured on this server, so schedules cannot send e-mail. Before you add a schedule, the panel reads Not scheduled.

  1. Repeat: Daily, Weekly, Monthly or Custom (cron).
  2. Time (UTC): the hour the schedule runs.
  3. Format: the format of the stored snapshot.
  4. Active: the schedule runs while this is ticked.
  5. Add schedule: saves the schedule.

To add a schedule:

  1. In Scheduling, click Add schedule.
  2. Choose how often in Repeat: Daily, Weekly, Monthly or Custom (cron).
  3. Set the time and day:
    • Daily: Time (UTC), on the hour from 00:00 to 23:00.
    • Weekly: Day of week (Sunday to Saturday) and Time (UTC).
    • Monthly: Day of month (1–31) and Time (UTC). For days 29 to 31, months without that day are skipped.
    • Custom (cron): a Cron expression (UTC). See Custom cron schedules.
  4. Choose the Format: Report default ({format}), CSV, PDF, Excel (.xlsx) or XML. Each schedule can use its own format.
  5. If e-mail delivery is set up on your server, optionally enter recipients in E-mail to (optional), separated by commas, for example [email protected], [email protected]. Each run attaches the file; the snapshot is stored either way.
  6. Keep Active ticked.
  7. Click Add schedule.

A new schedule defaults to Daily at 06:00 UTC in the report’s default format.

Each schedule in the list shows a summary such as Daily at 06:00 UTC, Weekly on Monday at 06:00 UTC, Monthly on day 1 at 06:00 UTC or Custom schedule 30 2 * * 1-5 (UTC), then the format and recipients, then Next run {date} and Last run {date}.

  • Pause a schedule: click Edit, clear Active and click Save schedule. The schedule shows Paused and Not running. Tick Active again to resume.
  • Edit a schedule: click Edit, change the fields and click Save schedule. Saving recalculates Next run from the new timing.
  • Delete a schedule: click Delete, then confirm Delete this schedule? with Delete (or Keep). Snapshots the schedule produced are kept.

Custom cron schedules

A cron expression has five fields, or a descriptor such as @daily. All times are UTC:

minute  hour  day-of-month  month  day-of-week

For example, 30 2 * * 1-5 runs on weekdays at 02:30 UTC. A schedule runs at most once an hour: an expression such as */15 * * * * is rejected with *cron expression “*/15 * * * ” runs more often than once an hour.

Other validation messages:

MessageCause
Enter a cron expression.The field is empty
A cron expression has five fields: minute hour day-of-month month day-of-week.Wrong number of fields
invalid cron expression “…”A field has an invalid value
cron expression “…” never firesThe expression matches no date, for example 31 February
"…" is not a valid e-mail address.A recipient is not a valid e-mail address
at most 20 recipients are allowedMore than 20 recipients

Report Filter

The Report Filter panel shows the filter the report was defined with, as JSON, or No filter applied — this report covers the full estate. Click Copy to copy the JSON. The filter is read-only.

Keyboard shortcuts

Shortcuts work when the cursor is not in a text field and no dialog is open. Press ? to see them.

KeyAction
/Focus the search box
eExport the focused report in the last format you used for it
g nGenerate a NIST 800-53 snapshot
g cGenerate a CIS Controls snapshot
g pGenerate a PCI-DSS snapshot
g hGenerate a HIPAA snapshot
g sGenerate a SOC 2 snapshot
g iGenerate an ISO 27001 snapshot
xClose the side sheet
?Show the shortcuts
EscClose the side sheet or shortcut list

Press the second key of a g shortcut immediately after the first.

Permissions

ActionPermission
Open the page, view saved reports, snapshots and schedules, download snapshotsreports:read
Create and delete saved reports, export reports, generate report snapshots, add, edit, pause and delete schedulesreports:write
See the Audit Readiness ledger and framework side sheetscompliance:read
Generate compliance snapshotscompliance:write

Without compliance:read, the ledger is replaced by Compliance snapshots require compliance read permission. By default, the administrator role holds these permissions.