The contents of the generated model reports are determined by the defined inspections.
All reports are written to the Reports
directory for the project. The report file is named with the following standard format.
Model Report for project name – time.html
value indicates the project name. The time
value indicates the date and time on which the report was generated. Several of the default inspections also generate CSV files that contain builder usage statistics from the report. Using these CSV files, you can sort and rearrange the data to suit your own needs. All the report files have the same time so that you can identify those generated during the same run.
Interpreting report contents
The inspections help you quickly identify models that may not be following best practices or that are built so that they can be hard to maintain and understand. The set of default inspections focus on some of the most common problems the WebSphere® Portlet Factory engineering team encounters when it reviews customer models. For example, a common problem is the mixing of user interface (UI) and data access builders in a single model rather than separating those types of builders into provider (data access) and consumer (UI) models.
The default set of inspections is based upon the best practices documented in WebSphere Portlet Factory product wiki.
The model reporting tool provides multiple default inspections, but it cannot provide every possible inspection required for a project. The tool is designed to be customized and extended. The following types of customization and extension are possible.
- Changing the configuration properties of an existing inspection to alter the process or criteria used when models are inspected
- Defining a new inspection based upon an existing implementation.
- Defining a new Java-based inspector and a corresponding inspection definition.
Before you can successfully customize the report, you need to understand how the tool configuration files are used to define and control the set of inspections performed on models. The tool uses two configuration files.
- The basic_inspections.xml file defines the set of inspections.
- The basic_builder_types.xml file assigns sets of builders to various types. Among other purposes, types enable inspections to discover whether a model contains user interface (UI), data access, or other kinds of builders.
These files are found in a path from the root of the WebSphere Portlet Factory installation folder. The following is the path for the 7.0.1 release.
For more information about creating custom inspections, refer to the WebSphere Portlet Factory product wiki.
Parent topic: Generating a model report