Generate ICD

Overview

Generates a digital Interface Control Document (ICD) in the form of a HTML report (this is currently in Beta).

Applicable To	Package
Menu Entry	Power Pack  Reporting Tools  Generate ICD
Demonstration	Watch the Video

Operation

The helper first collects all Connector found anywhere in the selected package (recursively). Only those between Proxy Ports are considered.

The port conjugation status and the direction of the elements in the interfaces are parsed to produce an ICD.

Once generated the starting page is opened either in Rhapsody or in an external browser (or both) depending on the value of the following property:

RhapsodyPowerPack.ReportingTools.OpenInBrowser

Note that documentation opened in Rhapsody uses the same tab each time, but Rhapsody does not automatically switch to this tab so if you have selected a different tab (for example a diagram) then you must manually select the report tab again to view the generated ICD.

The ICD contains three tabs:

· Sent Items

· Diagrams

· Interfaces

Sent Items

All items (event receptions, operations, flow properties) are collected on this tab and grouped by their sender:

In the above example, ADAS_Functional sends 5 items to Display and 5 items to SpeedSystem

Clicking one of the links gives the Item details including:

· The source and target classifier

· The source and target port

· The contract (Interface) of the ports

· The item (this is a clickable link to Rhapsody)

· Requirements traced to the item (see below)

Diagrams

Diagrams are automatically included from the references of any of the proxy ports under consideration.

Interfaces

The Interfaces tab lists all interfaces; clicking one shows its items:

Navigation

Interfaces on diagrams and on the Item details page (the Contract) may be clicked to navigate to the Interfaces page of the ICD. All other links provide navigation back to Rhapsody.

Requirements Traceability

Any requirement that has an incoming dependency from an element in the interface is used (regardless of the type of dependency)

Since it is rare for requirements to be traced directly to the elements in an interface, the helper uses the following strategy to try and find linked requirements (in addition to finding them by direct traceability from the interface element):

Event Receptions

The helper:

· Checks the Event that types the even reception for linked requirements.

· Checks all other event receptions of that event for traceability to requirements.

Attributes / Flow Properties

For each attribute in the interface, the helper looks for traceability to requirements:

· In any matching attribute in the sending classifier.

· In any matching attribute in the receiving classifier.

· If the receiving port is not behavioural then any matching attribute in the receiving classifiers children (that is its instances).