Add Comments to a Traceability Matrix

On this page…
Requirements for Adding Comments to a Traceability Matrix How To Retain Comments

Requirements for Adding Comments to a Traceability Matrix

You can add comments to the traceability matrix that you generated using the iec.ExportTraceReport function.

To add comments to the traceability matrix, you must:

• Create new columns for your comments.

• Use unique column headings. Columns that you add must have headings.

• Add at least one entry to the column, other than the column heading.

• Retain the following columns:

  • Model Object Name

  • Model Object Path

  • Model Object Subsystem

  • Code File Location

  • Code File Name

  • Code Function

  • Code Line Number

  • Model Object Unique ID

  • Model Object Optimized

  • Code Comment Checksum

Note   Comments must resolve to a text string. For example, a link to an image resolves to a text string, but a copy of the image does not.

Back to Top

How To Retain Comments

To regenerate a traceability matrix and retain your comments:

1. Navigate to the working folder of the model.

2. Optionally, regenerate code for your model. Regenerating code before generating the traceability matrix increases the likelihood that you have the latest model-to-code traceability information.

3. In the MATLAB Command Window, enter the following command. file_name is the name of the existing traceability matrix that you are regenerating. If the existing traceability matrix is in a different folder, include the full path to that folder in path.

   iec.ExportTraceReport('model_name', 'file_name', 'path')

   The traceability matrix regenerates.

Back to Top

Generate a Traceability Matrix

Traceability Matrix Limitations

© 1984-2012- The MathWorks, Inc.    -   Site Help   -   Patents   -   Trademarks   -   Privacy Policy   -   Preventing Piracy   -   RSS