6.2.5.13. Architecture-RhapsodyImporter

Imports an IBM Rhapsody model into the RFG

Required inputs: RFG

This importer uses Rhapsody to read the Rhapsody model. So, all formats Rhapsody can read (*.rpy, *.rpyx) are supported.

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 = 'RH Architecture'

Name of the generated architecture view. Caution: An existing view will be cleared.

 

enable_rhapsody_methods

enable_rhapsody_methods : set[str] = set()

List of Interface.MethodName used for import. This enables methods which are disabled by default.

 

export_warnings

export_warnings : bool = True

Export output messages to the analysis database.

 

ignore_guid_errors

ignore_guid_errors : bool = False

Ignore errors while retrieving the GUID of a Rhapsody node from Rhapsody.

 

ignore_rhapsody_check_error

ignore_rhapsody_check_error : bool = False

Ignore failing Rhapsody tests (correct registration in Windows registry).

 

ignore_rhapsody_methods

ignore_rhapsody_methods : set[str] = set()

Do not call specified Rhapsody methods (e.g. to circumvent bugs). E.g.: [IRPUnit.getCurrentDirectory, IRPModelElement.getIconFileName]

 

ignore_rhapsody_return_code

ignore_rhapsody_return_code : bool = False

Ignore Rhapsody return codes. Without this flag, a return code other than 0 is treated as fatal error. Do use this option with extreme care and only if you experience problems with the Rhapsody process terminating.

 

ignore_rhapsody_stack_overflow_errors

ignore_rhapsody_stack_overflow_errors : bool = False

Ignore stack overflow errors from Rhapsody API calls.

 

keep_flying

keep_flying : bool = False

Do not abort on fatal errors.

 

kill_rhapsody_after_rfg_has_been_written

kill_rhapsody_after_rfg_has_been_written : bool = False

Activates a workaround for a bug in IBM Rational Rhapsody where the Rhapsody process does not terminate after the import: kill Rhapsody directly after RFG has been written. Do use this option with extreme care and only if you experience problems with the Rhapsody process terminating. As a killed Rhapsody process will return with a return code different than 0, the option "ignore_rhapsody_return_code" also needs to be set.

 

loglevel

loglevel : LogLevel = 'WARNING'

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

 

rhapsody_path

rhapsody_path : bauhaus.analysis.config.LayerRelativePath = 'C:Program FilesIBMRationalRhapsody8.3.1RhapsodyCL.exe'

Path to RhapsodyCL.exe (e.g. "C:\Program Files\IBM\Rational\Rhapsody\8.3.1\RhapsodyCL.exe")

 

rhapsody_raw_view_name

rhapsody_raw_view_name : str = 'RH Architecture (raw)'

Name of the view containing the raw rhapsody model. Caution: An existing view will be cleared.

 

rpy_file

rpy_file : bauhaus.analysis.config.LayerRelativePath = 'project.rpyx'

The Rhapsody project file.

 

Option Types

These types are used by options listed above:

LogLevel

An enumeration.

 

• WARNING

• INFO

• DEBUG