Reporting
- Mark Juras
This page introduces gmStudio reporting features.
Analysis and Reporting
In addition to batch reporting features, gmStudio has a powerful search-based analysis feature. This allows searching and filtering many of the reports and also generating custom reports from filtered search results.
See the Search Panel
Most reports written as tab-delimited files with a .tab extension. When a report file is generated from the Reports menu, gmStudio attempts to display it by launching the report viewer application specified on the User Defaults panel. Typically the associated application is Microsoft Office Excel.
Sample Source Structure Report data in an Excel Pivot Table
gmStudio Reporting Overview
gmStudio can produce a variety of useful reports to help you plan, execute, and measure the progress of your migration effort. There are four classes of reports:
- Code Scan Reports
- Project Information Reports
- Semantic Model Reports
- Utility Reports
Most reports are driven off selected tasks in the Migration Project. You indicate which migration tasks to include in a report by selecting them in the migration panel.
Most reports are authored as tab-delimited text files with the first record containing the column names of the report. These reports are written to files with a .tab extension. A handful of reports aggregate various log files and other data as free-form text files or html. These reports are written to files with a .txt or .htm extension respectively.
Most reports are written to the report folder in your migration workspace. When the report file is ready, gmStudio will open the file with the associated application.
The gmStudio report titles and output file names are listed below ([MigName] is the Migration Project Name):
| Title | Output File |
| Code Scan Reports | |
| Source Structure | [MigName]-SrcStruct.tab |
| Source References | [MigName]-SrcRef.tab |
| Source Members | [MigName]-SrcMember.tab |
| Source GUI Scan | [MigName]-SrcGUI.tab |
| Source Code Scan | [MigName]-SrcScan.tab |
| Iceberg | [MigName]-Iceberg.tab |
| Project Reports | |
| Project Summary | [MigName]-MigStat.txt |
| Metrics Summary | [MigName]-Metrics.htm |
| Migration Set | [MigName]-MigSet.tab |
| Code Bundles | [MigName]-Bundle.tab |
| .NET Build Logs | [MigName]-BldLog.tab |
| Translation Logs | [MigName]-TranLog.tab |
| All Logs | [MigName]-AllLog.txt |
| Interface File Headers | [MigName]-LibHeaders.tab |
| Interface File ProgIds | [MigName]-LibProgIds.tab |
| Semantic Model Reports | |
| Semantic References | [MigName]-AnaRef.tab |
| Semantic Definitions | [MigName]-AnaDef.tab |
| Semantic Symbols | [MigName]-AnaSym.tab |
| Semantic Audit | [MigName]-Audit.txt |
| Utility Reports | |
| Migration Project List | gmProjects.tab |
| Multi-Unit Script | tran.[MigName]_MultiJob.xml |
| Target Code Scan | [MigName]-BndScan.tab |
| Target Code Chanfges | [MigName]-BndChanges.txt |
| Generate Visual Studio Solution | deploy\[MigName].sln |
| Pre-Processed Source | [MigName]-PrepSource.bnd |
| Generate Project Signature File | [MigName]-ProjectSignature.txt |
Running Reports
There are three ways to run gmStudio reports:
- To run a single report for a set of one of more migration tasks, highlight the desired tasks in the migration panel then select the desired report from the [Reports] menu. The report will only include data for the highlighted migration tasks. The resulting report will be displayed in the associated application (e.g., excel for .tab files, or a text editor for .txt files).
- To run a set of reports in batch, use the Reports Panel. This Panel allows you to perform a variety of reporting-related operations such as selecting a set of reports and running them in batch or viewing all the report files in the report folder. Click the [Reports] tab on the task details panel at the bottom of the main form.
- To run a set of reports from one or more migration projects in batch use the command line scripts supplied with the gmStudio Samples.
See [INSTALLDIR]\samples\batch\run1set.cmd for details.