/EnterpriseArchitect_hoReverse

ReqIF for EA, reverse Engineering workbench for Enterprise Architect and C/C++

Primary LanguageC#MIT LicenseMIT

hoReverse

The roots

hoReverse is a workbench to ease reverse Engineering of C/C++ into EA (Enterprise Architect). It helps you make a model out of existing C/C++ code. The major focus is to make Activity Diagrams of code and link it to static architecture.

In essence, it helps you to produce a Functional Safety compliant detailed design on the basic of Activity Diagrams, Classes, Interfaces with Operations and Attributes. All the model elements are linked together to make maintainable models.

Because in embedded I like the concept of Ports there are a lot of features to boost the work.

For details see the WiKi.

ReqIF

ReqIF is the standard to exchange Requirements between different tools. hoReverse now supports:

History

In a lot of embedded C/C++ projects with EA I missed functionality to create and maintain:

Especially the requirements of safety (ASIL D or SIL 3) projects forced my to do dull work with a lot of errors and frustrating reviews or to find something to make it run more smoothly.

That was the start of hoReverse. By the time it grows and in current projects I'm able to make a decent detailed design from Code with not too much manual work.

Is this all according to theory or the processes? Can''

Let's discuss it, but it works.

Functions

  • A lot of hoTools functionality
  • Make Activity diagrams from code
  • Link static design and behavior together
  • Extensible

News

3.22 Fix 3.21

  • Linq to 4.* (SQL, LinqPad, ReqIf)
  • correcting Nuget version DocumentFormat.OpenXml to 2.11.3 (error ReqIF formatting with MariGold.OpenXHTML 2.7.0)

3.21 ReqIf import DOORS WMF header format „\pict{*\picprop}\wmetafile8\“

  • SautinSoft migrate to V8 and V7 controlled by macro
  • Nuget packages updated

3.20 Add Setup for EA 16. 64 Bit, only to show how to run 64 Bit

  • See project: _SetupX64 (WIX installation)
    • Procedure to create an X64 environment
      • VS: Create Configuration for x64
      • Copy existing x86 WIX Setup project to a new folder
        • *.WixProj: Change Project GUID to a new value
        • *.WixProj: Change Project Name to a new name
        • *.WixProj: Change EA Registry key Addin to EAAddins64
        • Change Install-Directory (e.g. xxx64)
        • Change Output-Name (e.g. xxx64.msi)
      • Build x64
      • Run new xxx64.msi

3.16 Handle Decision Guard string, fix version

3.15 GUI formatting fixed linq2db drivers updated to 3....

3.14.5 Use text in textfield for constraint and notes Optimize ControlFlow from Decision with "yes"/"no" Fix error: Create Note/Constraint for Diagram Fix error: Correct not set context item by EA (Diagram.cs)

3.13 Fix white spaces in search text

3.12 Improvements generating Activity nodes

  • F Final can also create an Init on the Activity Diagram
    • DiagramObject selected: Create Final node
    • no Diagram selected: Create an Init node
  • ActC Create Activity with beneath Diagram
    • Select a Package,an Element, or a Diagram in the Browser to create only the Activity with the beneath Diagram.
  • Move diagram elements beneath selected browser package/element
    • It don't move elements which have a parent (you have to move the root)
    • don't make itself to a parent
  • bug fixing

3.11 *.msi installer to remove all remnants - Update properties as service - copy properties as service

3.10 Searches and Criticality (project specific)

  • Searches with right Click in text field
    • Simple
    • Quick Search
    • Diagram Search
    • Recently Diagram Modified
  • Criticality (project specific), for ZF Action and ZF Activity
    • QM
    • ASIL-A
    • ASIL B
    • ASIL C

3.9 ReqIF: Allow xml entities like '&'"<>' in ReqIF attributes like names

3.8 ReqIF: Error connection string MySQL (remove LazyLoad=0/1;) - ReqIF: interpret shortcute

3.7 ReqIFSharp Library 2.0 upgrade

3.6 Fix error Bulk change for not existing profile

3.5 Nugut changed to Package Reference

  • Update linq2db library
  • Adapt to VS2019

3.4 ReqIF Handle structured Tagged Values (same name in different structures) - Fix error in handling tagged values (missing some values) - Repeated Tagged Value names are made unique by adding a '.', period 3.3 ReqIF Export fixing and optimizing

  • No Tagged Values starting with 'ReqIF.' are supported (conflicts with existing Attributes)
  • Error fixing

3.2.7 ReqIF Tutorial as *.eap file

3.2.6 ReqIF Deserialize in ReqIF Readonly mode, handle COM Exception

  • ReqIF:
    • Deserialize in ReqIF Readonly mode
    • handle COM Exception
    • Skip package if guid is wrong
    • Skip without error message if ContinueIfNoSpecificationId = true

3.2.5 ReqIF fix error encapsulate SautinSoft converter

3.2.4 ReqIF csharp 1.4.1 (error fixed), liq2db updated to 2.6.4

3.2.3 ReqIF Version '1.2' leads to validation error, changed to '1.0'

3.2.2 ReqIF error formatting OLE objects fixed (DOORS)

  • ReqIF improved error messages to be more meaningful

3.2.1 ReqIF new EA Variables for Export/Roundtrip, Bug fixing

  • BugFix
  • linq2db 2.6.1
  • ReqIF: Support special variable for TaggedValues: EA.Name, EA.Tye, EA.Stereotype for easier traceability
  • Refracturing reqIF (split ReqIf, ReqIfImport, ReqIfExport, ReqIf, Roundtrip)

3.2 ReqIF error fixing

  • ReqIF store LongName and Identifier of Specification in Package
  • Preparation handle Identifier of Specification to identify the correct Specification
  • RelationalGroup: no taget requirement available, improved error message
  • ReqIF Error messages improved
  • ReqIF Sharp Library update to 1.4
  • Update Relationships with ReqIFSharp library improved
  • Generate <> Include from Code snippet

3.1.7 Minor improvements

  • ReqIF underline now supported text
  • Import ReqIF using Mari.Gold.Open.XHTML (free) or Sautinsoft (commercial) to convert XHTML to rtf / Open XML (Linked Document format) (configurable)
  • Possible ReqIF Schema validation with parameter 'ValidateReqIF'
  • If ReqIF deserialization fails with out validation ask to try it once more with validation

3.1.6 ReqIF error handling improved

  • Define which ReqIF is available for Import, Export, Roundtrip ("AllowedOperations": "Import,Export")
  • Error fix: No Tagged Value defined
  • Export ReqIF now supports EA local path

3.1.5 Fix Error EA Tagged Values with Blank in Enum Values (ReqIF)

  • Export Example added

3.1.4 Sautin converter instead of MariGold for import (easily to change back), Error fixing

  • Sautin converter instead of MariGold for import (looks as if better converting results XHTML to DOCX/rtf)
  • Error fixing ReqIF from EA Notes
  • Updated NuGetPackages (MariGold, SQLITE)
  • Do Import/Export only with possible configuration

3.1.3 ReqIF Export, Error fixing

3.1.2 ReqIF Eport from EA

  • Fix error nested AddinQuery (Elements without Tagged Values)
  • linq2db 2.2.0

3.1.1 Add-In Search with LINQ to SQL (rearly fast for recursive search)

3.1 ReqIF import with Links between Requirements

3.0.5

  • Support of *.eapx files
  • Fix copy name to clipboard for empty name

3.0.4 Import preserves roundtrip values

  • error fixing

3.0.3 Enum with multivalue selection support

  • TaggedValue name optional with prefix (per ReqIF module)

3.0.2 Roundtrip/Workflow ReqIF

  • Define columns for roundtrip
  • Supported types: string, xhtml, enum

3.0.1 ReqIF *.pdf, *.wmf files supported

  • Files are stored in the File Section of Requirements
  • error fixing and minor improvements
  1. Import Requirements, Tests (Doors, *.ReqIf, *.reqIfz, *.csv, *.xml)
  • Import requirements into EA Package (ReqIF, DOORS ReqIf, DOORS *.csv, structured *.xml)
  • Bug fixing

2.1.10 Error fixing

  • Create CallBehaviour Action with SQL error fixed
  • Service Copy ID of Element, Package, Diagram, .. copied
  • Improved update behavior create/update activity from Method
  • Exception add note to diagram added

2.1.9 Error fixing

  • No Error message if Settings.Json doesn't contain configuration chapter for Styles, Bulk changes and more
    • Menu entry shows the information of missing configuration

2.1.8 Choose CallBehavior Action or CallOperation Action for a C/C++ function call

  • Entry field allows Enter without starting a query. Start the query with Buttons or use hoTools

2.1.7 Bulk change Elements (Diagram, Browser, Package, Package recursive)

  • Bulk change Elements (Diagram, Browser, Package, Package recursive)
  • Search: in hoReverse Entry field

2.1.6 Bulk Change Diagram elements

  • Bulk change Diagram elements (Stereotype, Tagged Values) -- Configuration in %appdata%roaming\ho\hoReverse\settings.json
  • Error fixes -- - Fixes (e.g.Features, Constraint, Note)

2.1.5 Installaller can handle no admin install for user install

  • Create/Update activity (fix skipped parameter)
  • Install without Admin rights (per user install) -- Click on *.msi -- Advanced!!! -- Use default: Install just for you!!!

2.1.3 Bug fixing, documentation, installation

  • Copy selected Elements to Clipboard and order them
  • Integrate LINQ for SQLite
  • Handle VC Code Symbol DB

2.1.1 Sort Ports optimized

FAQ

Does everything run automatically

No, it's a workbench which helps you. It releases you from a lot of boring work. Instead, you have to think how:

  • to best visualize things
  • to hide complexity without ignoring them
  • Bind static architecture to detailed design

In essence, in my view, the interesting part of reverse engineering.

Do I get an ASIL D or SIL 3 compliant detailed design?

hoReverse helps you. Usually, I have no greate issues with reviews or assessments. But to be honest, hoReverse only helps in transforming code into Activity Diagrams. Making sense in Activity Diagrams is your responsibility.

Can I change or enhance functionality?

Of course, it's open source under the MIT license. You can participate in this project or do your work.

Do you have a method?

hoReverse doesn't stick to any plan. It's just a workbench with different tools I found useful. But of course, I have a clear view of the architecture of System and Software.

Is it SPICE compliant?

It's your work to make it SPICE compatible. In the past, I had no issue with that.

Is it ISO 26262, IEC 61508, Functional Safety compliant?

It's your work to make it compliant. In the past, I had no issue with that.

What are the technical basics of hoReverse?

  • .net with C#
  • EA Add-In
  • VS2017
  • And a lot of open source software

What do you think of AUTOSAR?

I like the concepts of AUTOSAR. Usually, I model Modules, Runnables, Ports the way AUTOSAR does it. hoReverse has no special AUTOSAR functionality but helps you with a lot of small helpers for everyday tasks.