Skip to main content

 

OutSystems

Architecture Dashboard FAQs

 

Architecture Dashboard FAQs

 

Am I eligible to have Architecture Dashboard?

Access to Architecture Dashboard will be given, for the time being, for free and to all customers and partners that have a valid licence and are running a supported version of OutSystems platform. Personal environments are not eligible to use the tool.

The Disclaimer associated with the tool's usage and that must be agreed upon is the following:

" Architecture Dashboard is a SaaS tool which enables developers to create better applications by following best practices for code quality and performance.

Access to the Architecture Dashboard will be given upon request to all OutSystems customers and partners as long as they are running a supported version of OutSystems platform .

OutSystems provides support to the Architecture Dashboard during the Early Access phase on a best effort basis.

OutSystems has the right to change this policy, conditions of access, as well as the nature, features or functioning of the tool.

Architecture Dashboard collects the following data from the customer’s infrastructure:

  • Platform metamodel data, including Infrastructure activation code, environments information (Name and Platform Version), teams and platform configurations;
  • Applications, Modules (eSpaces) for Code analysis and LifeTime Analytics data for Runtime Performance analysis;
  • Discovery snapshot data (Architectural references, applications, and modules) for Architecture analysis;
  • Upon acceptance of the Agreement, Users information: Name, Username, Email address, Last Login date.

Data of each installation is kept isolated from all other installations using the platform's multi-tenant mechanisms. This ensures data from one installation is not accessible by users of other installations.

This data is used exclusively for the operation of the tool, and to provide the reports and dashboards that the user can access, and for nothing else. Aggregated, sanitized information can also be used for statistical purposes. Under no circumstances will specific personal or customer data be used for any other purposes besides platform usage.

Should you have any questions or wish to exercise any rights pursuant to privacy/data protection laws, contact us at dpo@outsystems.com "

How do I access Architecture Dashboard?

To access Architecture Dashboard, your OutSystems Platform installation must first be registered, to do so, click on the " Register for the Early Access " button on the tool's login page https://architecture.outsystems.com/

Follow the steps, and when the registration is complete, refer to the articles How to install Architecture Dashboard _ .

Do I need to give access to the developers in LifeTime so they can associate their users with Architecture Dashboard?

All developers have access to LifeTime, therefore the customer is not "giving access just to use Architecture Dashboard". The reason why all developers always have to access LifeTime is that it is where the platform users are set up.

The Architecture Dashboard Plugin doesn't require the user to have any particular permissions on LifeTime. So, any user that can login to LifeTime (all active users), can see and open Architecture Dashboard Plugin in order to associate his infrastructure user with Architecture Dashboard.

How do I know if I have the latest version of the Architecture Dashboard Probes?

Each time there's a new release, in the Architecture Dashboard Release Notes , is a reference to the latest version of the probes.

If the probes you have installed are not the latest, the Team Leaders (LifeTime "Admin" or "Team Admin" role) will see a link in the Code Analysis tab to download the latest version:

Update probes.PNG

Download the probes and follow the article How to Install Architecture Dashboard to install the probes.

Keep in mind that if there's a previous version of the probes installed there's no need to uninstall them prior to installing the new ones.

How to uninstall Architecture Dashboard Probes?

Removing the Probes from the infrastructure (both LifeTime and DEV environments) is the only necessary step to uninstall Architecture Dashboard. Delete the following applications from both environments:

  • Architecture Dashboard Environment Probe (for older versions of the tool: Trusted Advisor Environment Probe )
  • Architecture Dashboard LifeTime Probe (for older versions of the tool: Trusted Advisor LifeTime Probe )
  • Architecture Dashboard Shared (for older versions of the tool: Trusted Advisor Shared )

By doing this, the LifeTime Plugin will be automatically removed and the installation will be deactivated on Architecture Dashboard end, revoking the user's access.

I can't see any findings when selecting a specific team

For the filter of teams to work it needs that the teams are created in Lifetime, and have Applications associated with them.

Go to Lifetime, and under the Menu “ User Management - > Teams ” make sure the teams are correctly created, then, for each team (click on the team's name to enter that team's detail page) make sure the team has Users and Applications associated with it.

After all the changes are done you’ll have to wait for the next synchronization for the results to be updated.

Can I analyze various dev environments simultaneously?

Currently, you cannot have more than 1 Code Analysis environment (usually development environment) per installation, i.e, with the same activation code.

For each installation, you are only allowed to have:

1 Code Analysis environment (usually DEV environment)

1 Runtime Performance Analysis environment (usually PRD environment)

However, if you have more than 1 environment, each one with different activation codes, you can use Architecture Dashboard in both. Just consider them as 2 separate environments and install Architecture Dashboard in each one.

How often are recommendations updated?

For Release Number R1907 and/or Probes Version: R1907:

If your current Probe Version is R1907 or above , the recommendations are updated twice a day (every 12 hours), for modules that have been changed and published in that period.

For Release Number R1906 and/or Probes Version: R1901:

If your current Probe Version is R1901 or below , the recommendations are updated every 4 hours for modules that have been changed and published in that period.

Can I force a synchronization to update the recommendations?

It is possible to force a synchronization however, there's a limit of times per day that this type of synchronization (not scheduled) can occur.

To force a synchronization, go to *LifeTime* and open the *“Architecture Dashboard” plugin* under the “More” or "Plugins" menu (Step 1) and then click on "Monitor" (step 2):

Force synchronization Step 1.PNG

Next, click " Request Synchronization ":

Force synchronization Step 2.PNG

The request will enter a queue of synchronizations and as soon as there's an available slot the synchronization will take place and the information on the Probes Queues will reflect that.

Can I snooze or dismiss a recommendation?

To snooze a recommendation, click the Snooze icon that appears next to each finding. The snooze time period will be automatically chosen depending on the selected reason. After that time period, the recommendation will reappear. Only Team Leaders (LifeTime Team Admin role) have the possibility to dismiss recommendations within the Maintenance view.

What should I do when I believe that a recommendation is wrong?

Snooze it with the "False Positive" reason and explain in the comments why you believe a specific case is wrong. The Architecture Dashboard team is actively monitoring recommendations marked as "False Positive" to decide and implement corrections where needed.

How do I add a platform installation to "My Platforms"?

In order to associate a new platform installation to your Architecture Dashboard account, you need to connect your LifeTime account with Architecture Dashboard. To achieve this, you can follow the steps described on this page: " How to connect your Lifetime account with Architecture Dashboard ".

What kind of data is being collected in the Plugin?

The communication mechanism between the Plugin and SaaS, including collected data, is detailed in the " How Architecture Dashboard Works " topic.

The bottom line is that no application business data is ever collected and the collected data is the minimum required to perform analysis or allow the usage of Architecture Dashboard’s features

Why are my applications now showing in Architecture Dashboard?

If you face the scenario where, although the infrastructure modules are appearing on the filters, you don't have any application being shown, this can mean that there are synchronization issues between Architecture Dashboard and Discovery.

In order to solve it, please ensure that you installed the Discovery version mentioned on the installation pre-requirements.

"To collect Architecture metrics, Discovery version 3.0.9 or later (for OS 10) / 4.0.2 (for OS 11) or later must be published in the Development environment"

If you have the required Discovery version and the applications still don’t show, please contact the team via Support Portal .

I'm having Synchronization Issues

Synchronization (data sent from Architecture Dashboard Probe to SaaS) is made every 4 hours. This sync is made with any changes applied during that period. The information on the last analysis and the next run can be seen in the Code Analysis Page.
clipboard_e08ba43f72b0a6fb7efc4225d27be6430.png

Possible Solution :

Go to code analysis and verify when the last analysis ran. Was there any sync done in the past? If not, the cause was probably an error or a missing pre-requirement in the Probes installation.

1st Step : Verify if you have installed all the pre-requirements that are mentioned in the How-to Install Architecture Dashboard .

2nd Step : After ensuring that all pre-requirements are correctly installed, reinstall the Probes provided by the Architecture Dashboard Team.

Was there any sync successfully done? Go to LifeTime Service Center and check for errors in the Architecture Dashboard LifeTime Probe. Note that the Plugin installed in the customer infrastructure needs to connect to Architecture Dashboard PaaS.

This connection is done via the Endpoint link to https://architecture.outsystems.co...AdvisorWS.asmx

No error detected yet? Please contact the team via Support Portal with all the details that you have and steps followed to troubleshoot.

Not finding the question you're looking for? Please contact the team via Support Portal .