Create Object Details Report Actions
Create Object Details Report actions perform a Tier2 retrieval of objects from the specified RFC Destination. The action generates an XML report listing details for each of the objects retrieved, which is stored in a folder underneath the LiveCompare user data directory. If the Create Object Details Report action’s Fixed parameter is set to ‘false’ the report files are stored in the following time-stamped directory.
<LiveCompare user data dir>\Reports\<Workspace Name>\<Report Name>_YYYYMMDD_HHMMSS
If the Create Object Details Report action’s Fixed parameter is set to ‘true’, the report files are stored in the following directory, which does not include a time stamp:
<LiveCompare user data dir>\public\Reports\<Workspace Name>\<Report Name>
If the Create Object Details Report action’s Zip parameter is set to ‘true’, the report directory includes an archived copy of the report, stored in a ZIP file named after the action’s Report Name parameter.
| Action Property | Description |
|---|---|
| Adds | A Table parameter or dataset containing values which are used to augment the XML generated for each source object in the report (optional). |
| Fixed |
A Boolean parameter which indicates whether the Create Object Details 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. |
| Object Attribute Filter | An Object Attribute Filter parameter specifying the object attributes to retrieve. |
| Report Name | A String parameter which stores the name used for the generated report. If the Fixed parameter is set to ‘false’, the generated report name includes a timestamp indicating when the report was created. |
| Report URL | A String dataset which is set to the URL of the ZIP file that stores the generated report. |
| RFC Destination | An RFC Destination parameter or dataset referring to the SAP system from which to retrieve object details. |
| Source | A Table parameter or dataset specifying a list of objects to retrieve. The table should have at least a NAME column containing the name of each object, and a TYPE column specifying the type of each object. |
| Zip | A Boolean parameter which determines whether a ZIP archive of will be created for the report. If this parameter is set to ‘true’, the report directory will include a ZIP file containing the report’s contents. |
The retrieval results are stored in a set of XML files in a subfolder of the report directory. The report directory also includes the following top-level files:
| Filename | Description |
|---|---|
| ReportDetails.xml | Stores the execution date and time for the report, and the name of the report’s table of contents. |
| ReportToc.txt | The report’s table of contents. |
| ReportToc.xml | The report’s table of contents in XML format. |
| <Report Name>.zip | The Object Details Report stored in a ZIP file. A ZIP file is created if the Zip parameter is set to ‘true’. |
The contents page for the report includes header information, and a table which lists the following details for each of the objects retrieved:
| Column | Description |
|---|---|
| Column 1 | A subfolder of the report directory in which the object’s XML file is stored. If an exception was raised for the object, this column is set to ‘EXCEP’. |
| Column 2 | The name of the XML file storing the retrieval details for an object. If an exception was raised for the object, this column indicates the type of the exception. |
| Column 3 | The type of each object retrieved. |
| Column 4 | The name of each object retrieved. |
If the Adds property is specified, it should refer to a Table parameter or dataset which has the following columns:
| Column | Description |
|---|---|
| KEY | An object name from the NAME column in the action’s Source table. |
| NAME | The name of an XML attribute to add to the appropriate <OBJECT> node in the generated report. |
| VALUE | A value for the XML attribute. |
The Adds table may be populated by an Execute SQL action which reads object names directly from the Source table. Note that KEY is a reserved word in SQLite. Therefore if you need to refer to the KEY column in an SQL statement, be sure to enclose it in square brackets, as shown in the following example:
INSERT INTO Result ([KEY], NAME, VALUE) SELECT s1.NAME, 'Application', s1.APPL FROM Source1 s1
Generated Object Details 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 Object Details Report action, double-click the action node, or select ‘View Details’ from the node’s context menu. The Details screen displays a summary of the number of objects in the Source Table, the number of XML files generated, and the time taken to for the action to complete.
The progress of a Create Object Details Report action may be monitored by viewing the Details screen while the action is running. Time estimates are available after a sufficient number of objects have been processed, relative to the total number of objects. The following details are shown:
| Item | Description |
|---|---|
| Total objects | The number of objects in the Source table. |
| Remaining objects | The number of objects that have not yet been processed. |
| Elapsed time (seconds) | The time for which the Create Object Details Report action has been running. |
| Estimated total time (seconds) | The estimated total time for which the Create Object Details Report action will run. |
| Remaining time (seconds) | The estimated remaining time for which the Create Object Details Report action will run. |
| Remaining time (hours/minutes) | The estimated remaining time (in hours or minutes) for which the Create Object Details Report action will run. |
| Total elapsed time hh:mm:ss | The time for which the Create Object Details Report action has been running in hours, minutes and seconds. |
Press the F5 key periodically to update the display.
If a Create Object Details Report action is interrupted (for example because its RFC Destination becomes unavailable) choose ‘Continue’ from the action’s context menu to continue the analysis from the point at which it was interrupted.