-
Notifications
You must be signed in to change notification settings - Fork 357
6. Customized Reports
The reports, regardless of format, are organized using a set of preference files that can be used to customize the way tags are organized for convenience and are customizable. For the HTML report the preferences also affect the report appearance for the Features section Feature Groups and icons. For instance, you may choose to reorder some of them under a "Security" features group.
For the HTML report features page customization is possible by modifying the tagtreportgroups.json file located in the source code directory here. They include changing the icon, display titles etc. and patterns to include with no programming so you can easily change group categories and tags how you want in minutes as described below. It does require a rebuild of the tool however as the resources are embedded into the binaries so that they are easy to package.
Each feature group represents a bucket to associate like features in. Each feature includes a search pattern to locate related matches based on the tag name (See Rules/Tags), a hover display description and icon. Icon values are based on fontawesome. It's not necessary to use the entire tag name if it is distinct enough but you can.
To add a feature, simply locate a rule or tag that you would like to see that is not already shown in the report where desired and duplicate one of the existing entries. Or customize the layout by moving existing entries as needed.
All tags that include value of "Metric" are excluded automatically from the HTML "Features" report page even if they are defined in the tagreportgroups.json and as well as from the detailed matches since this keyword for tags is intended to represent characteristics worth counting but do not qualify as features. They will automatically appear in the Summary Tag Counters area of the HTML report or as tag counters in the other report formats. See tags for more.