Page tree

MagicDraw 19.0 LTR SP3 Documentation

On this page

Displaying element history 

To display the history of an element, do one of the following

  • Right-click the element or its symbol. From the shortcut menu, select History.
  • Select the element or its symbol and press Ctrl + H.
  • Open the Specification window of the element and click the History button History.
  • If it is a diagram, right-click an empty space on the diagram pane. From the shortcut menu, select History.

Stopping collecting changes

If retrieving the element history takes too much time, you can click the Stop button to complete reviewing changes through different versions of the selected element.

The History panel of the selected element then opens at the bottom of the client application window, such as MagicDraw or a Cameo Suite product (i.e., Cameo Systems Modeler). If you select an element in a used project, the corresponding panel title is Usage History. The highlighted row indicates current changes that are not yet committed. To refresh the list of versions, click the  button in the panel's toolbar or perform the same actions as for opening the panel.

A list of project versions in the History panel.

By default, the list of versions is stripped to a a small number of the latest versions. To see more versions, click the Show more results button under the list.

You can compare any two versions of an element to see the differences between them.

To display the history of an element in a used project

  1. Open the element's Usage History panel, as described above.
  2. Select the project version.
  3. In the panel's toolbar, click the  button or right-click the selected version and select the Show History in Used Project command.

Comparing element versions

To compare project versions in the Teamwork Cloud environment, you are required to have a Read Resources permission for every used project in compared versions.

To compare element versions

  1. Hold down Ctrl and select the versions you want to compare.

    You can only compare two versions. Please note that if you select more than two items, only two (the latest and the earliest versions) will be compared.

    If you want to compare subsequent versions, you only need to select the later one.

  2. On the panel's toolbar, click the  button or right-click the selection and choose either:

    • Quick Diff – to inspect changes of element property values (such as documentation, type, or multiplicity) in a compact form
    • Full Diff – to inspect changes of diagrams or element property values in a detailed form, as well as look at the properties of new relationships and directly related elements (such as new or modified attributes and operations).

     You can also choose the same commands from the toolbar of the History panel.

After you select the Quick Diff command, a dialog opens that shows changes in element property values (see the following figure). Different colors help identify new, modified, and deleted values. You can analyze exact changes in the textual value of the selected property in the Text Diff box. If you want to see the original texts of both versions, click the Compare property values button Compare property values on the toolbar of the dialog to open the Compare property dialog and then click Original Texts.

An example of the Quick Diff dialog of an element (class).

After you select the Full Diff command for an element, the Difference Viewer dialog opens, showing changes in element property values, as well as detailed information for directly related elements and new relationships (see the figure below). For more information about using this dialog, see Analyzing comparison results.

An example of the Difference Viewer dialog of an element.

After you select the Full Diff command for a diagram, the Difference Viewer dialog opens, showing all changes in the diagram (see the figure below). For more information about using this dialog, see Viewing and analyzing differences of modified diagrams.

An example of the Difference Viewer dialog of a diagram. 

Be aware that Quick Diff is not available for displaying diagram changes. Diagram changes (as diagram layout changes) can be displayed only in the Full Diff mode. To see these changes you must initiate the comparison of entire project versions. For this, select a couple of project versions in the History panel and on the shortcut menu click Compare Projects. For more information, see Analyzing comparison results.

Generating reports

To generate an element history report

  1. Perform element history as described above.
  2. On the History toolbar, click the Generate Report button.
  3. The Save As dialog opens to specify the location of the report file.