uml4net.Tools

Introduction

uml4net Tools is a commandline application used to process a UML model and generate a report on the contents of that model. The application is distributed as an executable via the Releases as well as a dotnet tool available from https://nuget.org.

The developer documentation of uml4net.Tools is here. This page covers the user manual.

Installation

Windows 64 bit

• Download the executable from the latest release. The filename is uml4net.Tools.exe
• Verify that the hash is the same as is documented on the release notes
  • Open a Power-Shell console
  • Execute the Get-FileHash providing the path the downloaded file uml4net.Tools.exe

Dotnet tool

to install:

dotnet tool install --global uml4net.Tools

to uninstall:

dotnet tool uninstall --global uml4net.Tools

How To

uml4nettools can generate multiple reports.

• Inspection Report: The inspection report is a text based report. It includes the variations of types, multiplicities and a list of classes and properties that lack documentation. This report is used to support template based code generation to determine which classes, properties and enums should be verified during code generation to get good coverage of the variations in the UML model.
• Excel Table Report: An Excel spreadsheet that contains:
  • A list of all classes, their attributes and documentation.
  • A list of all interfaces, their attributes and documentation.
  • A list of all Enumerations, their Enumeration Literals and documentation
  • A list of all Primitive types and documentation
  • A list of all other Data types (non Enumeration, non Primitive Type) and documentation
• HTML Report: An HTML report of all Enums, DataTypes and Classes.

The application supports the following commands and options to generate the reports:

command	description
inspect	Inspects a UML model and generates a text report
excel-report	Generates a tabular report of the UML model
html-report	Generates a html report of the UML model

option	shorthand	description	default
--no-logo		Suppresses the logo	false
--input-model	-i	The path to the UML file	model.xmi
--pathmaps	-m	multiple key=value entries to map a pathmap to a file	-
--output-report	-o	The path to the tabular report file. The extension is required to be .xlsx	tabular-report.xlsx
--auto-open-report	-a	Open the generated report with its default application	false
--use-strict-reading	-s	When Strict Reading is set to true the reader will throw an exception if it encounters an unknown element or attribute. Otherwise, it will ignore the unknown element or attribute and log a warning.	true
--help	-?	shows help information	false

windows executable:

uml4net.Tools.exe -? 
uml4net.Tools.exe inspect -?
uml4net.Tools.exe inspect --input-model <path-to-UML-model> --output-report <path-to-output-report.txt>
uml4net.Tools.exe excel-report -? 
uml4net.Tools.exe excel-report --input-model <path-to-UML-model> --output-report <path-to-output-report.xlsx>
uml4net.Tools.exe html-report -?
uml4net.Tools.exe html-report --input-model <path-to-UML-model> --output-report <path-to-output-report.html>
uml4net.Tools.exe html-report --input-model <path-to-UML-model> --pathmaps "pathmap://UML_LIBRARIES/UMLPrimitiveTypes.library.uml="<path-to-referenced-UML-model> --output-report <path-to-output-report.html>

dotnet tool:

uml4nettools -?
uml4nettools inspect --input-model <path-to-UML-model> --output-report <path-to-output-report.txt>
uml4nettools excel-report --input-model <path-to-UML-model> --output-report <path-to-output-report.xlsx>
uml4nettools html-report --input-model <path-to-UML-model> --output-report <path-to-output-report.html>

Open the file and inspect the contents. In case the --auto-open-report is used the linked application will open the file. Make sure that in the case of the excel report the file is not open in the application.