Performing an Automated Architecture Review

In high-stakes systems engineering, the quality of your model is just as important as the model itself. Inconsistent definitions or overly complex architectures can lead to expensive errors during the manufacturing or implementation phases. The AI SysML v2 Editor provides a powerful Architecture Review feature that acts as an automated peer reviewer. This tutorial will show you how to use the AI SysML tool to perform a deep analysis of your system architecture.

Objective

By the end of this tutorial, you will have generated a comprehensive Architecture Review for a SysML v2 model, interpreted key performance metrics, and identified areas for improvement within your stable SysML v2 tool project.

Step 1: Select a Model for Review

You can review your own models or use one of the professionally authored examples from our ecosystem.

1. Launch the web-based SysML v2 editor.
2. For this tutorial, let’s use an example to see a comprehensive report. Open the Learning Center (Book icon) and load the EV Charging Station example.
3. Alternatively, open the Structure.sysml file you developed in the previous tutorials.

Step 2: Access the AI Assistant Report Tab

The analytical engine is housed within the AI Assistant panel of the SysML v2 software.

1. Click the AI Assistant (Sparkle) icon in the right-hand panel.
2. Click on the Report tab at the top of the assistant interface.

Step 3: Choose Your Review Parameters

The AI SysML tool offers different types of reports depending on your current engineering focus.

1. In the Report Type dropdown, select Architecture Review.
2. This report type is specifically designed to analyze structural integrity, naming consistency, and the logical flow of your SysML v2 editor project.

Step 4: Generate the Analysis

1. Click the Generate Report button.
2. The AI SysML v2 software will now perform a full scan of your active file, resolving all symbols and cross-references.
3. Wait a few seconds for the AI to process the complex relationships within your SysML software architecture.

Step 5: Interpret the Metrics

The report will appear in a formatted Markdown window. Pay close attention to the Metrics section provided by the SysML v2 tool:

• Complexity Score: An indicator of how deeply nested your parts are. High complexity might suggest a need for better modularization.
• Consistency Rating: Measures how well you follow SysML v2 naming conventions and relationship rules. A low rating here suggests potential syntax or logical “smells” in your stable SysML v2 tool project.
• Warning Count: Highlights potential issues that are not hard errors but could lead to modeling ambiguity.

Step 6: Review Recommendations

The most valuable part of the AI SysML v2 editor‘s review is the list of actionable recommendations.

1. Scroll down to the Recommendations section.
2. The AI might suggest things like: “Consider breaking down the ‘Power Management’ block into smaller sub-parts to reduce local complexity,” or “Ensure all ports have defined types to improve interface rigor.”
3. Take note of these points; they are essential for maintaining a professional SysML tool environment.

Step 7: Act on the Feedback

1. Close the AI Assistant.
2. Use the Model Tree or Go to Definition features to navigate to the problematic areas identified in the report.
3. Update your SysML v2 code based on the AI’s feedback.
4. Pro Tip: Re-run the report after making changes to see your Consistency Rating improve in real-time.

Summary and Next Steps

You have successfully performed an automated architecture review! By integrating AI analysis into your web-based SysML editor, you have added an extra layer of quality assurance to your systems engineering process. This ensure your models are not only visually correct but architecturally sound.

In our final tutorial, “Exploring and Modifying Industry Examples,” we will see how to leverage the full library of pre-built models to master advanced SysML v2 patterns.