Skip to main content

Report Snapshots

A snapshot is the content of a report or report object captured at a specific moment in time.

You can use a snapshot to determine the changes made to a report or a report object over time. If the snapshot output option is selected when a report is generated, CDM saves a snapshot of the report.

PDF and Web objects are not included in a report snapshot and cannot be generated as report object snapshots.

When you generate a filing report, CDM automatically generates a snapshot at the same time. The snapshot contains the XBRL file and an Excel document with the validation result as a separate worksheet.

Add a Snapshot

You can use a snapshot to represent the content of a report, report objects grouped in a section, or report object captured at a specific moment in time.

Important: When you generate a filing report, CDM generates the snapshot automatically, and you do not need to perform the following procedure.

To add a snapshot in a report:

  1. Open the report that you want to work with.
  2. In the report tree on the left, select the report, a section containing report objects, or one or more report objects.
  3. Right-click the selection and select Generate Selection.
  4. In the generation window, select a format, for example Microsoft Word.
  5. Under Additional Preferences, select the Save as Snapshot option and enter a description.
  6. Select other options as required.
  7. Click OK.

Add a Snapshot from the Section Tab

  1. Open the report that you want to work with.
  2. In the report tree, double-click the report or a section containing report objects. The report or section opens in the work area and the Section Tools area containing the Section tab displays on the ribbon.
  3. In the Section tab, click Save as Snapshot.
  4. In the Save as Snapshot Description dialog, enter a description for the snapshot you are saving.
  5. Click OK. The snapshot is saved.

View a Snapshot

You can view a snapshot of a report, a single report object, or multiple report objects, if the Save as Snapshot option was selected when a report was generated.

Ensure that the report contains the snapshot that you want to view. The report or report objects must be generated with the Save as Snapshot option.

To view a snapshot of a report:

  1. Open the report that you want to work with.
  2. Click Home > View Snapshots.
  3. Select a snapshot, and then click View. The snapshot opens in a specific viewer based on the format that was selected for the snapshot when it was generated. For example, if you selected Microsoft Word as the format, the snapshot will open in Microsoft Word for viewing. The View Snapshots window contains the following information about each snapshot:
    • Report Name - The name of the report used to generate the snapshot.
    • Generation Type - The format of the snapshot.
    • Description - Any text entered in the Description field when the snapshot was generated.
    • Date Created - The date that the snapshot was created.
    • User - The user who created the snapshot.
  4. You can sort any column in the View Snapshots window by clicking a column header. Or, for any column, click the column filter icons to edit your view of the table.
  5. When you are finished with the View Snapshots window, click Close.

Use Snapshots to Compare Versions of a Report or Report Object

You can use snapshots to compare two versions of a report or report object. When you compare snapshots, you can see any changes made over time. For example, you can see what was deleted from an earlier version or what was added to a later version.

To compare versions of a report or report object using snapshots:

  1. Ensure that the report contains the snapshots that you want to view. The report or report object must be generated with the Save as Snapshot option.
  2. Open the report that you want to work with.
  3. Click Home > View Snapshots.
  4. Select any two snapshots by pressing CTRL and clicking each snapshot. You can sort any column in the View Snapshots window by clicking a column header. Or, for any column, click the column filter icons to edit your view of the table.
  5. Click Compare.
  6. The snapshots open in Microsoft™ Word or your PDF viewer, based on the format of the snapshot when generated.
    • If you compare two Microsoft Word snapshots, the first selected snapshot is compared to the second selected snapshot. The second selected snapshot displays with any differences identified.
    • If you compare two PDF snapshots, each snapshot displays in the PDF viewer. You can visually inspect the two snapshots for differences.
    • If you compare a Microsoft Word snapshot and a PDF snapshot, the snapshots open in Microsoft Word or your PDF viewer. You can visually inspect the snapshots for differences.

Delete a Snapshot

If you do not need a snapshot of a report or report object, you can delete the snapshot.

Important: If you delete a snapshot, you cannot undo your action. The deleted snapshot is no longer present in the View Snapshots window, and it is removed from CDM. Proceed with caution.

To delete a snapshot:

  1. Ensure that the report contains the snapshot that you want to view.
  2. Open the report that you want to work with.
  3. Click Home > View Snapshots.
  4. Select the snapshot you want to delete, and click Delete.
  5. In the confirmation message, click Yes.

Was this article helpful?

We're sorry to hear that.