IBM Support

Purpose and usage of Source Artifact in Rational Rhapsody

Technote (FAQ)


Question

What is Source Artifact and how is it used in IBM Rational Rhapsody?

Cause

The information about Source Artifact is limited since it is not a standard UML element but a special model element specifically used by Rhapsody to preserve the look of your code as original as possible.

Answer

Before version 7.2 of the product, a SourceArtifact was referred to as a Component File. While component files still exist, they now refer to elements explicitly created under the Components folder in Rational Rhapsody.


When component files are located under packages or classes, and so on, they are referred to as Source Artifacts.

Source Artifact and RoundTrip is tightly related. RoundTrip is a powerful feature Rhapsody provides. RoundTrip refers to an activity to reflect changes you made to the source code back into model, and vice versa. Such change includes not only updates to code but also mapping and ordering information. When you make a change to source code, Rhapsody will analyze the source code and determine the type of change you made, and model it correctly. If the change was considered as something that is not appropriate to be modelled, for example a comment, Rhapsody will store that information as a textual information in Source Artifact.

Source Artifact is normally created at the time of round-tripping and used for ordering and various manipulations. It serves the role of information holder. Note that Source Artifact created by Reverse Engineering or RoundTrip are signed as synthesized with the small 's'. If you make changes to the Source Artifact, it stopped to be synthesized ('s' is removed). If it is not synthesized, Rhapsody will treat the particular Source Artifact more carefully, same as it was not automatically added by Reverse Engineering or RoundTrip, and thus Rhapsody will not change its location nor delete it automatically. In general, Source Artifacts are managed by Rhapsody, you can add new Source Artifact in order to affect the generated code, but bear in mind it could be altered by RoundTrip.

For more information about Source Artifact, refer to the IBM Rational Rhapsody Information Center documentation for your installed Rhapsody version in the following topics:


Related information

Difference among annotations
RoundTrip and Parsing error

Document information

More support for: Rational Rhapsody
General Information

Software version: 7.6, 7.6.0.1, 7.6.1, 7.6.1.2, 7.6.1.3, 8.0, 8.0.1, 8.0.2, 8.0.3

Operating system(s): Linux, Windows

Reference #: 1640396

Modified date: 24 July 2013