How to Use Architecture Dashboard
How to access Architecture Dashboard?
If the above steps are concluded go to https://architecture.outsystems.com/ and login with your Community Username and Password.
How to use Architecture Dashboard
To work with Architecture Dashboard there are two key concepts you must first understand:
Patterns - The OMLs that encapsulate the created code are converted to XML and that XML is parsed to find code patterns that may indicate the code is not following the best practices, for example, the pattern "Missing description on public element" will search for public elements in the code that don't have a description, if the tool catches at least one occurrence of this, the pattern will be shown in the list of patterns (and only if there's at least one case)
Findings - Each pattern will have an unlimited number of findings, a finding is the actual location on the code where the "problem" was detected, for example, for the pattern above, the finding could be an entity or a parameter.
Below you can see a tutorial video on how to use architecture Dashboard from a developer's perspective:
Some additional information not mentioned in the video above:
- A developer can only unsnooze the findings that were snoozed by him
- Depending on the reason chosen to snooze a finding you will be able to add a comment to it
- The graphs in each category show the evolution of findings in that category, by passing with the mouse over the line you'll be able to see the date and the number of findings on that date
- The teams that appear on the "Teams" filter are the ones created in Lifetime. For the filter to function besides the teams being created they need to have Applications associated, if not, no findings will be shown when selecting a specific team.
In this second part of the tutorial video you will see the features only available for the users that are administrators of the platform or of a team in LifeTime:
Some points to add to the video information:
- The generated PDF Report will only show the Categories scores, the Global Score and the explanation and number of findings in each category. If you need to have the complete list of findings you must use the "Export to Excel" option in the Code Analysis tab.