Reports
A report is a file generated from the tenant's asset inventory, for someone outside the console: an Excel workbook for an audit or a steering meeting, or a CSV of an asset list for another tool. Reports are generated on request, in the background, and collected from Reports when they are ready. They are not scheduled and not sent by email.
There are two report types:
| Report type | Output | What it contains |
|---|---|---|
| Excel report | .xlsx | An Excel template filled with live data. What goes where is decided by the template, see Excel templates |
| Asset List Export | .csv | One row per asset of one asset type, one column per field |
Creating a report
On Reports, select Create report and fill in:
- Report type: Excel report or Asset List Export.
- For an Excel report, Template: the workbook to fill. The tenant's system template, marked (system), is selected unless you pick another. Only templates of the Excel report type are offered.
- For an asset list export, Assets: the asset type to export (Endpoints, Subnets, Applications, Users or Licenses). Every asset of that type is exported, with that asset list's default columns.
- Name: required. The file extension (
.xlsxor.csv) is added if you leave it out, and characters that cannot be used in a file name are removed.
Select Generate report. The report appears in the list as Pending and moves through the states below. You can leave the page; the list refreshes itself while a report is generating.
An Excel report covers the whole tenant: each macro in the template carries its own asset type and query, so there is no filter to set when you create it.
Exporting a filtered asset list
To export a search, or a different set of columns, use Export on the asset
list itself (see Assets). It queues an Asset List Export of
exactly what the list shows: the current query and the visible columns. The
report is named <asset type>-export-<date and time>.csv and is collected from
Reports like any other.
In a CSV export, a value that a spreadsheet would read as a formula (one that
starts with =, +, - or @, other than a plain number) is prefixed with an
apostrophe, so opening the file in a spreadsheet shows it as text and never runs
it.
Report states
The list shows each report's Name, Start time, Finished time, Progress, Status and who created it (Created by).
| Status | Meaning |
|---|---|
| Pending | Queued, waiting for the report generator |
| Running | Being generated. Progress shows how far it has got: for an Excel report, the share of the template's macros filled; for an asset export, the share of assets written |
| Completed | Ready to download |
| Failed | Generation stopped. There is no file to download |
Download is only available for a completed report; for the others the action is disabled and says why. Delete report removes the report and its file permanently.
Queue and limits
One report generator serves the whole Organization and builds one report at a time, so a large report can delay the reports queued after it.
- A tenant can have up to 10 reports pending or running at once by default; your deployment can change this. Creating another is refused with a message giving the limit; wait for one to finish.
- An uploaded template can be up to 5 MB by default; see Excel templates.
Retention
By default a generated report is kept until someone deletes it. Your deployment can set a retention period in days; reports that finished longer ago than that are then deleted, with their files, by the platform's hourly housekeeping.
Notifications
When a report finishes, Velum Edge sends a notification to the tenant's notification centre: Report completed (information) or Report failed (error). Both link to Reports. See Notifications.
Report templates
The Manage templates tab lists the tenant's report templates with their Name, Type, Created and Modified dates, and whether each is System or Custom (the Managed column).
The system template
Every tenant has a read-only system template, Asset discovery report, of the Excel report type. It produces a header sheet with the generation time, summary statistics for endpoints (by OS vendor, OS, type, hardware vendor and detecting integration), and the endpoint, user and subnet lists.
The system template can be selected and downloaded, but not edited or deleted. It is provided with each release and refreshed when the platform is updated. Download it to see working examples of every macro, and as a starting point for your own template.
Custom templates
Select Create template to upload your own workbook, or use a template's row menu to Edit template, Download template or Delete template. How to build one, and every macro it can contain, is described in Excel templates.
Permissions
Viewing and downloading reports needs the Reports (Read) permission. Creating or deleting reports (including Export from an asset list) and managing templates needs Reports (Write). See Roles and permissions.
See also
- Excel templates: building a template
- Assets: asset lists, queries and Export
- Scanning: how the inventory a report reads is filled