Skip to main content

Jama Connect Help

Batch analyze requirement statements (Document View)

When an organization admin has enabled and configured Jama Connect Advisor, you can use it to analyze the requirement's text against industry-standard rules.

Important considerations
  • Jama Connect Advisor behavior aligns with the fundamental INCOSE approach that requirements are authored using a single sentence structure.

  • Jama Connect Advisor analyzes only the first sentence of a requirements statement.

To batch analyze requirement statements in Document View:

  1. From the Jama Connect header, select  Projects > Project.

  2. Select items with requirements to be analyzed using one of these methods:

    • In the Explorer Tree, select a component, set, or folder.

    • Select items within a filter, a release, or a specific category.

  3. In Document View, select the items to be analyzed using one of these methods:

    • Select the individual items.

      In Document View, one item is selected to be analyzed.
    • Select the checkbox to select all items.

      In Document View, the checkbox above the items is selected, so that all items will be analyzed.
  4. Select Batch analyze.

    The Batch analyze button above the list of items is highlighted.

    The "Confirm batch analysis" window opens.

    Note

    If none of the selected items contain fields with Jama Connect Advisor enabled, the following message is displayed: "Analysis unavailable. Jama Connect Advisor is not enabled for any of the fields in the selected items."

  5. Review the information, then select Analyze to continue with the selected items.

    The Analyze button is highlighted on the Confirm batch analysis window.

    The results are displayed in a slide-over panel with the first requirement displayed at the top.

    The slide-over panel displays the results of the analysis, including a score for INCOSE Rules analysis and numbers of errors found for EARS analysis.
  6. Double-click on the first item to open Quick Edit mode and implement the recommended changes.

    When you open an item in Quick Edit mode you can implement the recommended changes.
    1. Edit the text based on recommendations from Jama Connect Advisor.

      The text that was analyzed is highlighted.
    2. (Optional) Highlight the text you edited, then select Analyze selection to ensure your edits improved the analysis results.

      The analyzed text is highlighted, as well as the Analyze selection button.
    3. Select Save & done.

  7. Continue editing each item as needed until all items and fields are updated.

  8. (Optional) If you can't complete all edits in one session or want to use the analysis results as a benchmark, select Generate report to export the analysis results to Excel.

    The Generate report button is highlighted on the analysis report.

    The Excel report contains several worksheets:

    • File Info — Provides a summary of the requirement scores.

    • File Analysis Report — Provides the complete list of all requirements and their INCOSE analysis results.

    • Explanation of Flags — Provides the name of the INCOSE flags and their associated descriptions.

    • Invalid Requirements — Provides a list of any requirements that couldn't be analyzed by Jama Connect Advisor.

      The various worksheet tabs on the Excel report are highlighted.

    Analysis results for Jama Connect Advisor might vary between Single-statement analysis and Multi-statement analysis. When you highlight text with Single-Statement analysis, the manual selection is submitted as-is directly to Jama Connect Advisor. When you send multiple requirements through Multi-statement analysis, rich-text fields are sanitized to locate the first available requirement statement.

    Jama Connect Advisor Multi-statement analysis isn't supported in the following scenarios:

    • Tables or text within tables or images.

    • A single number, a number and "." combination, or an empty field.

    Table (with or without text)

    A table is highlighted and the Jama Connect Advisor report displays an empty Description field and an error message that are highlighted.

    Image

    An image is highlighted and the Jama Connect Advisor report displays an empty Description field and an error message that are highlighted.

    Single number

    A number is highlighted and the Jama Connect Advisor report displays an empty Description field and an error message that are highlighted.

    Number and "." combination

    A series of numbers is highlighted and the Jama Connect Advisor report displays an empty Description field and an error message that are highlighted.

    Empty field

    An empty field is highlighted and the Jama Connect Advisor report displays an empty Description field and an error message that are highlighted.