DV8 Console Commands - Arch Report Configuration File

ArchReport Configuration File Guide

This  archreport.properties file is used by the arch-report command to customize which analysis commands will be executed during the architecture report generation process.

A sample archreport.properties file is included in the installation package, located in the dv8-explorer/sample-configurations folder. 

You can select which analyses to execute and set their parameters by editing and an archreport.properties file. Below, we explain the structure of this file, section by section, using a sample file.

1. Generate a Structure DSM

The first section of the properties file specifies input and output paths, as well as parameters for a converter command that creates a structural .dv8-dsm file. The input path must include all necessary files for the DV8 commands listed in the properties file.

2. Generate History Data

The second section specifies history-related commands to generate a co-change .dv8-dsm file and maintenance cost data in the form of .csv files. These commands are optional and will be executed if the required input files are available.

3. Detect Architectural Anti-Patterns and Roots (Optional)

• The arch-issue command will be executed automatically when the necessary data are available. If parameters are not set in the properties file, default values will be used. For more details, refer to the arch-issue command section.
• Once architectural issues (anti-patterns) are detected, the arch-issue-cost command will automatically calculate the maintenance costs associated with each issue instance, provided the necessary data are available.
• The arch-root command will only be executed if a Target Issue List is provided and all other input data are available. If parameters are not set, default values will be used. Refer to the arch-root command section for more details.
• After detecting architecture roots, the arch-root-debt command will calculate the maintenance costs associated with the roots and generate a Return on Investment (ROI) worksheet, if the necessary data are available.

Executing the Commands

Using this properties file, all specified commands will be executed, and an Architecture Analysis report will be generated automatically. All generated data will be stored in the designated output folder. For an example, refer to the pdfbox report. All generated data for the pdfbox analysis can be downloaded.