6.2.5.33. Architecture-PlantUMLImporter

Imports a PlantUML model into the RFG

Required inputs: RFG

This rule converts a PlantUML diagram into an RFG graph. Currently only Class and Component diagrams are supported with some limitations mentioned below. Diagram type (CLASS or COMPONENT) must be specified by diag_type option. The default diagram type is COMPONENT. The following diagram elements are not supported:

• GUI describing elements like colors, skinparam, stereotypes, spot, scale.
• notes
• keyword as an element name
• non-letters in elements names
• aliases for class diagram
• strings inside edges (left/thickness/hide...)
• separators between lines
• only "." is allowed as namespace separator
• hide/show/remove/unlinked attributes
• splitting files (pages)

Possible Messages

This rule has no predefined messages.

Options

• This rule shares the following common options: exclude_messages_in_system_headers, excludes, includes, justification_checker, post_processing, provider, severity

• The following places define options that affect this rule: Analysis-GlobalOptions

architecture_view_name

architecture_view_name : str = 'PlantUml Architecture'

Name of the view created from input PlantUml file.

 

diag_type

diag_type : PlantUmlDiagramType = 'Component'

Diagram type in the given PlantUml file.

 

export_warnings

export_warnings : bool = True

Export output messages to the analysis database.

 

loglevel

loglevel : LogLevel = 'WARNING'

Logging mode. WARNING only outputs errors and warnings, INFO additionally prints info messages, DEBUG additionally outputs info and debug messages.

 

puml_file

puml_file : bauhaus.analysis.config.LayerRelativePath = 'None (value must be set)'

Input PlantUml file to process.

 

Option Types

These types are used by options listed above:

LogLevel

An enumeration.

 

• WARNING

• INFO

• DEBUG

PlantUmlDiagramType

An enumeration.

 

Component

Parse input file as a PlantUml component diagram

Class

Parse input file as a PlantUml class diagram