View Report Snapshots

Each run of a Report makes a Report Snapshot, a fixed result for one point in time that holds the Report exactly as it was for that Organization at that moment. This page tells you how to find and read your Report Snapshots.

For how Deepwell makes a Report Snapshot, see Run, Schedule, and Deliver Reports.

Deepwell keeps each Report Snapshot that it makes, and it groups them by Organization and by Report. A Report Snapshot stays available for a long time after its run.

How to find a Report Snapshot

Report Snapshots are part of the Reports page, not a separate destination in the menu.

Go to Reporting → Reports and select Report Snapshots. Two views hold the Report Snapshots:

• Review queue lists each Report Snapshot that nobody has delivered yet, across every Organization. Search it by Report name or by Organization name. This is where a Manual delivery waits, along with any Automatic delivery that Deepwell held back. Select Deliver on a row to send it to the Organization. Undo delivery stays on the row until you leave the page, so you can reverse a delivery you made by mistake. Only an MSP Admin sees the Review queue.
• Snapshot history holds the delivered and previous Report Snapshots.

To use Snapshot history:

1. Select Snapshot history.
2. Search the list by Report name or by Organization name, or select an Organization in the Organization filter.
3. Set Delivery state to All, Delivered, or Undelivered to limit the list.
4. Select View on a row to open the Report Snapshot. Deepwell shows each Report that it ran for that Organization, with the Report Snapshots of each Report under it.

What a Report Snapshot shows

A Report Snapshot shows the Report as it was at its run, not the current data, so each Visualization shows the data of that moment. It keeps the Pages of its Report, in the same order. See Pages.

A part of a run can fail, for example when the Data Source of a Visualization returns an error. The Report Snapshot doesn't hide it. The block shows a warning, for example ⟨Data Source⟩ did not render, so you can identify a Report Snapshot that failed or that isn't complete. For the cause, select View errors, the warning icon next to the Report Snapshot in the list.

With Manual delivery, you find the warning before you deliver the Report Snapshot. With Automatic delivery, Deepwell holds back a Report Snapshot that has a failed block, so your client doesn't see a broken Report. The Report Snapshot goes to the Review queue instead, and Deepwell adds an Alert. Review the warning, then deliver the Report Snapshot yourself if the result is acceptable.

Delivery status

To change the delivery, select Deliver or Undo delivery on its row in the list. In an open Report Snapshot, the same controls are Deliver and Undeliver. You can do this at any time, not only immediately after a run, so you can go back to any Report Snapshot and change whether your client sees it whenever you need.

Each MSP User can read a Report Snapshot. Only an MSP Admin can deliver a Report Snapshot or remove its delivery.

When you select Deliver, Deepwell emails a notice with a link to the Organization Users on the email list for that Report and Organization. If the list is empty, nobody gets an email. See Who gets an email when a Report Snapshot is delivered.

A Report Snapshot stays in Deepwell. There is no export to PDF, no download, and Deepwell doesn't attach it to an email. Your client reads it in your Report portal after you deliver it. See The Report Portal.

If you need your Report Snapshots for your own records, you can request a copy of your data. See A copy of your data.

How to annotate a Visualization

An Annotation marks one point on a chart and explains what happened there. For example, you can mark the day of a firewall replacement so your client knows why the numbers changed.

Deepwell saves each Annotation with one Report Snapshot, so your client sees it on the chart when you deliver that Report Snapshot. It doesn't change the Report or the other Report Snapshots of that Report.

A Visualization Block can take an Annotation when both of these are true:

• The Report Snapshot is Undelivered.
• The Visualization is a Multi-Line Chart that ran without an error.

The chart can use dates or categories along the bottom. Deepwell records the date of an Annotation when the chart maps its points to dates. On a chart of categories, for example one point for each day of the week, the Annotation marks the point and Deepwell records no date.

A delivered Report Snapshot is fixed, so you can't annotate it. To change an Annotation on one, remove its delivery first. See Delivery status. The Report Snapshot is Undelivered again, and you can work on its Annotations.

The Edit annotations control is available later. It isn't in Deepwell yet for any account. When it is, a Block that doesn't show it, or a Report Snapshot that doesn't show it, doesn't meet the conditions above.

You work on the Annotations of one Block in the sidebar, which opens when you select Edit annotations on the Block. The form lists no fields until you select a point on the chart or an Annotation that's already there.

To leave the form, select the back arrow, select the close control, or press Esc, and Deepwell abandons unsaved changes.

How to add an Annotation

1. Open an Undelivered Report Snapshot.
2. Select Edit annotations on the Visualization Block. The form opens on Annotations.
3. Select a point on the chart. The form then shows New annotation.
4. To correct the point, move the marker along the chart.
5. Type a Title.
6. Type a Description if you want one.
7. Select Save annotation.

How to change an Annotation

1. Select Edit annotations on the Visualization Block.
2. Select the marker of the Annotation on the chart. The form shows Edit annotation.
3. Change the Title or the Description. The chart shows your words as you type them.
4. To move the Annotation, move its marker along the chart.
5. Select Save annotation.

A save can fail, for example when another MSP User saves a change to the same Annotation before you. Deepwell then keeps your draft in the form and shows a message, so you can review the chart and try again.

How to remove an Annotation

1. Select the marker of the Annotation on the chart.
2. Select Delete annotation.
3. Deepwell asks you to confirm. Select Delete annotation again.

Deepwell removes the Annotation immediately and keeps the form open. You can't undo the removal, so to get the Annotation back, add it again.

What to do next

This page tells you what you see, and the next tells you what your client sees after they sign in. See The Report Portal.