Create Vault Report actions write the contents
of a Vault to an HTML report. Each report generated by the action is stored
in a folder underneath the LiveCompare user data directory. If the Create
Vault Report action’s ‘Fixed’ parameter is set to ‘false’, its reports
are stored in the following time-stamped directory:
<LiveCompare user data dir>\public\Reports\<Workspace
Name>\<Report Name>_YYYYMMDD_HHMMSS
If the Create Vault Report action’s Fixed
parameter is set to ‘true’, its reports are stored in the following directory,
which does not include a time stamp:
<LiveCompare user data dir>\public\Reports\<Workspace
Name>\<Report Name>
Action Property
Description
Filter
A Table parameter
or dataset with NAME and TYPE columns,
where the NAME column is set to the name of a table in the Vault, and
the TYPE column is set to TABC. If this parameter is set, the Vault report
is filtered to contain only the tables specified in the filter. The report
hierarchy is pruned so that empty branches are not shown.
To filter a
Vault report based on an IMG Specification, use the Convert
Data action’s InIMGSelectList and OutTable properties to convert
the IMG Select List to a Table dataset. The Table dataset may be used
as the value of the Filter property.
Fixed
A Boolean
parameter which indicates whether the Create Vault Report action will
generate fixed location reports. If this parameter is set to ‘true’, the
action stores its report in the <Report Name> directory; this directory will be removed and then recreated each time the
action is run. If the Fixed parameter is set to ‘false’, a new report
will be generated in its own time-stamped directory each time the action
is run.
Each fixed location
report in a workspace should normally have a different value for its Report
Name parameter. This will ensure that each workflow’s Report URL dataset
points to the expected report.
From Revision
A String parameter
which indicates the first revision number to compare for each of the objects
in the Vault. If the specified revision number does not exist for an object,
the first revision number that is greater than the specified value is
used. If this parameter is not set, then the lowest revision number for
each Vault object is assumed.
Include Shelved
If this Boolean parameter is set to ‘true’,
shelved tables will be included in
the report. If this parameter is set to ‘false’, shelved tables will not
be included. The default value is ‘false’.
Object Status to Show
A String
List parameter which stores the table comparison statuses to appear
in the report. The String List parameter may contain the values ‘Same’
or ‘Different’. Objects that do not match the specified comparison statuses
do not appear in the report. The report hierarchy is pruned so that empty
branches are not shown.
Report Name
A String parameter
which stores the name of the report. If the Fixed parameter is set to
‘true’, the generated report is named Report_<Report Name>. If the
‘Fixed’ parameter is set to ‘false’, the generated report name includes
a time stamp indicating when the report was created.
Report URL
A String dataset
which is set to contain the URL of the generated report.
Row Status to
Show
A String
List parameter which stores the row comparison statuses to appear
in the report. The String List parameter may contain the values ‘Same’,
‘Different’, ‘In1’, or ‘In2’. If this action property is
not set, all comparison statuses are shown.
To Revision
A String parameter
which indicates the second revision number to compare for each of the
objects in the Vault. If the specified revision number does not exist
for an object, the first revision number that is less than the specified
value is used. If this parameter is not set, then the lowest revision
number for each Vault object is assumed.
Types for Details
A String
List parameter containing the object types
for which comparison details are to be reported. If this action property
is not set, no comparison details are included in the report.
Vault
A Vault parameter
or dataset which refers to the Vault
to be written to the report.
Each Vault report has a Table of Contents page
which includes a link to each of the objects in the report. The number of rows reported for each table in the report is
determined by the lower of the following values:
The ‘R3CompTConTier2MaxRowsForDisplay’
configuration setting, which has a default
value of 1000.
The ‘Maximum number of rows/objects
to display:’ User Preferences setting
for the current user.
Generated Vault
reports may be accessed by double-clicking the action’s Report URL dataset,
or by choosing ‘View Details’ from the dataset’s context menu. They may also
be accessed from a workspace’s Reports folder in the LiveCompare hierarchy.
Choose ‘Reload Children’ from the folder’s context menu to list any newly-generated
reports.
Example:
To examine the details for a Create Vault Report
action, double-click the action node, or select ‘View Details’ from the
node’s context menu. The Details screen displays the number of records
in each of the Source tables and the time taken for the action to complete.