Report snapshot configuration - 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)

The report snapshot feature creates a saved view of a report, including the values of a set of properties for a set of objects, at a specific date and time, also known as a snapshot of the data. Once you create a register document associated with the report, you can create this snapshot of the data for a comparison report to identify the differences in common columns between two versions at specific dates and times, matching the defined values of a register document. Which object properties are included in the snapshot data report is determined by the document classification used in the register document.

A new classification, Register Documents, has been added into the General documents classification tree to support the creation of the register definitions, register documents, and their snapshots.

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.

The register definitions are created by an administrator using a standard create dialog box with an additional section to select a saved ad hoc report to be used as the basis for a register document. They are created 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. However, they can be created at any time.

For more information on creating a register definition, see Create a register definition.

Register document

A register document contains data for a number of register items, such as a tag list or method list. By creating a snapshot object, you save the state of the data about those objects at a specific point in time. As the data changes, you can create additional snapshots, related to newer versions of the document, with updated views of the data. A register document uses the document classification hierarchy from a saved ad hoc report as the basis to create the document required.

You create a new register document using a shortcut method on a register definition, which already has the document classification hierarchy from the saved report used as the basis. If the saved report is set up to prompt for any criteria, then you can use the Set Criteria section to add the required values. These values are persisted against the new register document master. Whenever a snapshot is saved, the same prompt values are used.

When you create a new register document in a working state, a new register document version is created with the .csv file output result and .xml data file attached. If the document has already been created and the latest revision is in the current state, then generating the report from the register definition creates a new revision with a new working version and attaches both the new .csv result file and the new .xml data file to this new version.

For more information on creating a register document, see Create a register document.

Snapshot argument

The CreateSnapshot argument on the register document creation method automatically generates a snapshot after creating a register document when set to True. This setting is selected by default, so a snapshot is always generated following the creation of a register document. A snapshot can also be generated by right-clicking the register document and clicking Create Snapshot on the shortcut menu. Clicking Create a Historic Snapshot allows you to create a report for a specific date and display objects available on that date for comparison.

For more information on creating a snapshot, see Create a register document.

Comparison report

When running a comparison report, select two versions of a register document. The report compares the lists of columns in each using the .xml files and identifies the differences found in the columns common between the two versions.

The .xml report data file is attached to the register document when a snapshot is taken. When the comparison report result is run it is only displayed in .csv file format if the .csv output format was selected in the original ad hoc report used as the basis.

You can customize the column headers that are used in the comparison report for both of the compare client APIs, CompareVersions and CompareAgainstPreviousVersion.

For example, the RECORD_STATUS, RECORD_MAIN_OBJECT, and the _PREV suffix used for the previous column can all be edited from the default values. You can do this by updating the method and changing the default values provided by the client API.

You can also change the ShowOnlyChanges option for modified rows, so that you see only the values for the columns that have changed. For example, the following sample report has the ShowOnlyChanges set to False.

This example has the ShowOnlyChanges set to True.

For more information on creating a snapshot comparison report, see Create a snapshot comparison report.