The Model Inspection tool is used to perform static analysis about the models in a project. It generates reports that summarize how models are constructed and whether they follow some of the documented best practices recommended by the Portlet Factory engineering team. The design of the tool allows for customization and extension so that customers can codify their own best practices and include them in the generated reports.
See the attached PDF file for details on how to run and use the tool. The ModelInspection.pkg file contains all the source for this tool as described in the documentation PDF.
Note: As of the 7.0.1 release of Web Experience Factory, this model reporting capability is now built into the Designer IDE. See this 7.0.1 documentation page for more information: Generating a Model Report
There is also an additional static_model_report.zip file attachment below containing a compiled version of this tool. This ZIP can be used to run the model inspection tool without using Designer. This can be run, for example, in a deployed WAR or in any unzipped WAR. It also disables the regen option so it just does the model/builder analysis without attempting regeneration. This ZIP contains:
- JAR with compiled code for the tool
- the XML configuration files with the regen option turned off
- the BAT file, with the JAR added to the classpath.
To run this precompiled and configured version of the tool:
- Unzip to webContent folder of a project or deployed WAR.
- Run WEB-INF/bin/generate_model_report.bat.
- The report files will be in the WEB-INF/model_reports folder.