Creating and generating a report

Creating and generating a report

Reports are made in the Reports workspace. Switch to it with the mode picker in the header.

Generating a report

  1. Click + Report.
  2. Fill in the form. Most fields are already filled with sensible defaults. See What a report contains.
  3. Choose what to include.
  4. Click Generate report.

Generate report is disabled until every required field is filled. If it is greyed, something above is incomplete. The inspection date range is the usual one, since it has no default.

While it generates

Preparing the data takes a few seconds, and a progress overlay covers the form while it runs. The form then closes on its own, and the report appears at the top of the reports list marked Generating….

From that point you can carry on working, switch workspace, close the panel or leave the page. The report keeps generating and is waiting for you when you come back. Larger projects take longer, since every observation's images and screenshots go into the PDF.

When it finishes

Generating… is replaced by the finished report, and it opens in a preview if you are still in the Reports workspace. From there you can download it or open it in a new tab. See Downloading and sharing a report.

A report that could not be generated is listed as Generation failed. Delete it and generate a new one.

Cancelling

Before generating, Cancel, × or Escape all close the form. If you have typed anything you are asked to confirm, so a stray Escape does not lose your work.

Those controls are unavailable for the few seconds the data is being prepared. To remove a report that is already generating, use Delete in its menu.

Regenerating after a change

Reports are a snapshot of the moment they were made. Add observations or fix a screenshot afterwards and the existing PDF does not change. Generate a new one.

Old reports are kept, so a sequence of reports over time is a record of how the asset has changed.

Why can't I generate a report?

What you see What it means
No + Report button You do not have permission to create reports.
Generate report is greyed A required field is empty. The inspection date range is the usual culprit.
The include-sections option is missing You do not have access to this project's sections.
The report stays on Generating… Large projects take several minutes. The list updates on its own when it finishes.
The report says Generation failed The report could not be generated. Delete it and generate a new one.
Too many reports are being generated right now Several reports are being generated at once. Try again in a moment.
My newest observations are not in the report The report was generated before you added them. Generate a new one.

Related