Skip to main content

 

OutSystems

How to set up Architecture Dashboard

 

How to set up Architecture Dashboard

 

We recently updated this topic. Let us know what you think with a thumbs up or thumbs down.

Pre-requirements

To use Architecture Dashboard, make sure that:

  • Your Environments use OutSystems Platform Server 11, or OutSystems Platform Server 10 (.NET).

  • Lifetime is deployed in a dedicated Environment.

  • The following apps are installed in your LifeTime environment and in your Development environment:

    • ardoHTTP, latest version for OutSystems 11, or version 1.2.0 for OutSystems 10.

    • Time Zone, latest version for OutSystems 11, or version 5.0.0 for OutSystems 10.

    • CryptoAPI, latest version for OutSystems 11, or version 2.0.1 for OutSystems 10.

  • The LifeTime environment must be able to connect to Architecture Dashboard Web Service available at:

    https://architecture.outsystems.com/TrBrk_API/ArchitectureDashboard.asmx
    
  • To collect architecture metrics, the following app must be installed in your Development environment:

    • Discovery, latest version for OutSystems 11, or version 4.0.7 for OutSystems 10.
  • To collect performance metrics, LifeTime Analytics must be enabled on the non-development environments.

Register your factory and download Architecture Dashboard Probes

To apply for the Early Access Program and register your factory in Architecture Dashboard, follow these steps:

  1. In https://architecture.outsystems.com/, select Register for the Early Access and follow the steps to register your factory.

    Registration.PNG

  2. In the registration success screen, download the Development Environment Probe and LifeTime Environment Probe.

Make sure to download the probes within seven days of successfully registering your factory. After that time you won't be able to access the registration success screen and you will need to open a support case to ask for a new link to download the probes.

After successfully registering your factory, an email with a link to the registration success screen is sent to the Installation Contact Emails set during registration.

Install Architecture Dashboard Probes in Development and LifeTime environments

If there's a previous version of the probe installed there's no need to uninstall them, just proceed with the steps below to install the newer version of the probe.
  1. In the Service Center console of the Development environment (https://<development_environment>/ServiceCenter), install the Development Environment Probe in your Development environment by following these steps:

    1. Go to Factory.
    2. Go to Solutions.
    3. Select Upload & Publish a Solution.
    4. Select Choose File and select the Probe file.
    5. Select 1-Click Publish.
    6. Validate if the Solution is successfully published.

  2. In the Service Center console of the Lifetime environment (https://<lifetime_environment>/ServiceCenter), install the LifeTime Environment Probe in your LifeTime environment as you did in the previous step.

Configure Architecture Dashboard Probes

  1. Go to LifeTime (https://<lifetime_environment>/lifetime).

  2. Select Plugins > Architecture Dashboard.

    Plugin.PNG

    If your LifeTime does not have a Plugins menu, select More > Architecture Dashboard.

  3. Select Configuration.

    Configuration.PNG

  4. Confirm that Architecture Dashboard SaaS API URL is set to https://architecture.outsystems.com/...Dashboard.asmx

     

    This is the URL used to connect to Architecture Dashboard SaaS. Do not change the URL otherwise the plugin will stop working.
  5. Activate the Development environment probe by following these steps:

    1. In the Environment Configuration section, select the Configure button for Development environment.

      Env_Configuration.PNG

    2. Select Code Analysis as the Environment Type.

    3. Select Save and Activate probe and confirm.

      Env_Configuration_2.PNG

  6. Activate runtime performance analysis by following these steps:

    1. In the Environment Configuration section, select the Configure button for the environment where you want to analyze runtime performance, usually the Production or Quality Assurance environment.

    2. Select Runtime Performance as the Environment Type.

    3. Select Save and Activate probe and confirm.

You can only set one Type for each Environment.
Furthermore, you can only set each Type once.

The plugin is now configured and will periodically collect data to send to Architecture Dashboard for analysis.