Quantcast

Documentation Center

  • Trial Software
  • Product Updates

Validate Requirements Links in a Model

Check Requirements Links with the Model Advisor

To make sure that every requirements link in your Simulink® model has a valid target in a requirements document, run the Model Advisor Requirements consistency checks:

  1. Open the example model:

    slvnvdemo_fuelsys_officereqslvnvdemo_fuelsys_officereq
  2. Open the Model Advisor to run a consistency check by selecting Analysis > Requirements Traceability > Check Consistency.

    In the Requirements Consistency Checking category, all the checks are selected. For this tutorial, keep all the checks selected.

    These checks identify the following problems with your model requirements.

    Consistency CheckProblem Identified
    Identify requirement links with missing documentsThe Model Advisor cannot find the requirements document. This might indicate a problem with the path to the requirements document.
    Identify requirement links that specify invalid locations within documentsThe Model Advisor cannot find the designated location for the requirement. This check is implemented for:
    • Microsoft® Word documents

    • Microsoft Excel® documents

    • IBM® Rational® DOORS® documents

    • Simulink objects

    Identify selection-based links having description fields that do not match their requirements document textThe Description field for the link does not match the requirements document text. When you create selection-based links, the Requirements Management Interface (RMI) saves the selected text in the link Description field. This check is implemented for:
    • Microsoft Word documents

    • Microsoft Excel documents

    • IBM Rational DOORS documents

    • Simulink objects

    Identify requirement links with path type inconsistent with preferences

    The path to the requirements document does not match the Document file reference field in the Requirements Settings dialog box Selection Linking tab. This might indicate a problem with the path to the requirements document.

    On Linux® systems, this check is named Identify requirement links with absolute path type. The check reports a warning for each requirements links that uses an absolute path.

      Note:   For information about how the RMI resolves the path to the requirements document, see Document Path Storage.

    The Model Advisor checks to see if any applications that have link targets are running:

    • If your model has links to Microsoft Word or Microsoft Excel documents, the consistency check requires that you close all instances of those applications. If you have one of these applications open, it displays a warning and does not continue the checks. The consistency checks must verify up-to-date stored copies of the requirements documents.

    • If your model has links to DOORS requirements, you must be logged in to the DOORS software. Your DOORS database must include the module that contains the target requirements.

  3. For this tutorial, make sure that you close both Microsoft Word and Microsoft Excel.

  4. Click Run Selected Checks.

    After the check is complete:

    • The green circles with the check mark indicate that two checks passed.

    • The yellow triangles with the exclamation point indicate that two checks generated warnings.

    The right-hand pane shows that two checks passed and two checks had warnings. The pane includes a link to the HTML report.

Keep the Model Advisor open. The next section describes how to interpret and fix the inconsistent links.

Fix Invalid Requirements Links Detected by the Model Advisor

In Check Requirements Links with the Model Advisor, three requirements consistency checks generate warnings in the slvnvdemo_fuelsys_officereq model.

Resolve Warning: Identify requirement links that specify invalid locations within documents

To fix the warning about attempting to link to an invalid location in a requirements document:

  1. In the Model Advisor, select Identify requirement links that specify invalid locations within documents to display the description of the warning.

    This check identifies a link that specifies a location that does not exist in the Microsoft Word requirements document, slvnvdemo_FuelSys_DesignDescription.docx. The link originates in the Terminator1 block. In this example, the target location in the requirements document was deleted after the requirement was created.

  2. Get more information about this link:

    1. To navigate to the Terminator1 block, under Block, click the hyperlink.

    2. To open the Requirements Traceability Link Editor for this link, under Requirements, click the hyperlink.

  3. To fix the problem from the Requirements Traceability Link Editor, do one of the following:

    • In the Location field, specify a valid location in the requirements document.

    • Delete the requirements link by selecting the link and clicking Delete.

  4. In the Model Advisor, select the Requirements Consistency Checking category of checks.

  5. Click Run Selected Checks again, and verify that the warning no longer occurs.

Resolve Warning: Identify selection-based links having description fields that do not match their requirements document text

To fix the warnings about the Description field not matching the requirements document text:

  1. In the Model Advisor, click Identify selection-based links having description fields that do not match their requirements document text to display the description of the warning.

    The first message indicated that the model contains a link to a bookmark named Simulink_requirement_item_7 in the requirements document that does not exist.

    In addition, this check identified the following mismatching text between the requirements blocks and the requirements document:

    • The Description field in the Test inputs Signal Builder block link is Normal mode of operation. The requirement text is The simulation is run with a throttle input that ramps from 10 to 20 degrees over a period of two seconds, then back to 10 degrees over the next two seconds. This cycle repeats continuously while the engine is held at a constant speed.

    • The Description field in the MAP Estimate block link is Manifold pressure failure. The requirement text in slvnvdemo_FuelSys_DesignDescription.docx is Manifold pressure failure mode.

  2. Get more information about this link:

    1. To navigate to a block, under Block, click the hyperlink.

    2. To open the Requirements Traceability Link Editor for this link, under Current Description, click the hyperlink.

  3. Fix this problem in one of two ways:

    • In the Model Advisor, click Update. This action automatically updates the Description field for that link so that it matches the requirement.

    • In the Link Editor, manually edit the link from the block so that the Description field matches the selected requirements text.

  4. In the Model Advisor, select the Requirements Consistency Checking category of checks.

  5. Click Run Selected Checks again, and verify that the warning no longer occurs.

Was this topic helpful?