Report snapshots - SmartPlant Foundation - IM Update 46 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

You can create a snapshot of a report, which captures data at a specific date and time. The snapshot creates a report based on the values of a set of properties for a set of objects maintained in a register. The snapshot is then attached to a new register document version. You can create a comparison report between snapshots from different versions, such as the latest version and previous version. The snapshot comparison report highlights any changes in the common column data.

Register definition

A register definition is a grouping object that relates the document classification from an existing ad hoc report to a register document you want to create. The register definitions are created by your administrator at the start of a project, so there can be a standard register definition for all available report types, such as for a document list, method list, tag list, or a transmittal list.

Register document

A register document contains data for a number of register items, such as a tag list or method list. A register document uses the document classification hierarchy from a saved report as the basis to create the document required.

Each register document created can be configured to create an initial snapshot of the data in .xml format at the specific date and time it is created. As the data changes, you can create additional snapshots, related to newer versions of the document, with updated views of the data. The register document can store multiple snapshots of the report from different points in time. The snapshots are saved as different versions, which can be used in comparison reports. The document class stored on the register definition determines if the classification tree is displayed.

Snapshot report

The snapshot functionality is configured to generate a report of data at a particular date and time. Each time a register document is created, a snapshot is also automatically created. A snapshot report can also be created manually at any time, using a shortcut menu command on an existing register document.

If the register document is in a working state, a new snapshot creates a new version of the document and relates the report output .xml data to it. If the register document is in the current state, a new snapshot creates a new revision and version of the document and attaches the .xml file to the new version. If the report output type is .csv file format, the .csv file generated is also attached to the new version.

Historic snapshot report

The historic snapshot functionality selects a past date and time for the report. A version of the report document is automatically created and the selected date shown on the version. The report contains objects available at the selected past date and time and can be used for comparison.

Snapshot comparison report

The snapshot comparison report functionality is available only if there are at least two or more versions of the register document. The snapshot comparison report identifies the common set of columns in both versions being compared and generates a report, in .csv output type file format, of the differences in the data in those common columns between the two versions.

There are two comparison command options available on the register document:

CompareVersions – This command compares two selected versions of the same or different register documents.

CompareAgainstPreviousVersion - This command compares the latest version against the most previous superseded version of the register document. The latest and previous versions are determined based on the creation date.

For more information on configuring the snapshot feature and comparison reports, see the Report snapshot configuration.