9 minute readApplies to: v4

Troubleshooting Open Access

"The subscription was not found in the list of available subscriptions" or "No entities found"

As no user is logged in when Open Access dashboards are being used, the SquaredUp enterprise application (service principal) is used.

Open Access dashboards will only show resources, resource groups or subscriptions for which the enterprise application has at least the role of Reader.

To allow resources to show on Open Access dashboards you need to give the SquaredUp enterprise application Reader access to the resource, resource group or subscription as described in How to configure Open Access.

Open Access dashboards do not show all the resources on a tile

Open Access dashboards may show less data than you see as an administrator. For example, a Status icon tile may list fewer resources, or a Performance line graph may show fewer lines than you see as an administrator.

This is because the SquaredUp enterprise application may not have been given the same level of access that you as have.

In the Azure portal you can give the SquaredUp enterprise application access to whole subscriptions, resource groups or just individual resources, see How to configure Open Access.

"Error loading dashboard"

If you see the following error, you should set the Open Access loopback URL as described below.

Error loading dashboard An error occurred loading this dashboard, there may be more information available in your log file.

Error Loading Dashboards

When you visit an Open Access URL the rendering software prepares to take a snapshot of the dashboard. It renders the dashboard by acting as a browser and visiting a SquaredUp URL, it takes a snapshot and this image is then served back to the user who originally requested the page.

The SquaredUp URL, known as the Open Access loopback URL, is usually determined programmatically by checking the IIS bindings. With default IIS settings of localhost:443 the loopback URL that the system would automatically try would be https://localhost. Occasionally this default loopback URL can be determined incorrectly, however this problem can be overcome by specifying a oa-loopback-base-url in the openaccess.json file as described below.

  1. First we need to determine what the Open Access loopback URL should be.

    As you are using SSL the loopback URL should be the URL your SSL certificate is signed to, for example https://SquaredUp.Company.com

    If you are unsure what your loopback URL should be take a look at the bindings to see if a hostname is specified. On the server where SquaredUp is installed open IIS Manager and click on Squaredupv4, then on Bindings on the right hand menu under Actions. If there is a hostname and port specified note them down. Do not edit the bindings.

    • If port 443 is shown, then the loopback URL to try is https://hostname
    • If no hostname is specified, but the port is 443, then the loopback URL to try is https://localhost
    • If no hostname or port is specified, but you do use a specific URL to access SquaredUp you should try the hostname from this URL.
    • If you're not sure which settings to use, please contact SquaredUp Support and reply to the automatic response with the output of the SquaredUp Diagnostics.

    Next we need to specify the loopback URL in the openaccess.json file. You may need to try a few different options.

You will need to connect to your SquaredUp server.

  1. On the server where SquaredUp for Azure is installed run Notepad as administrator (File, Run, type notepad, and then right-click and select Run as administrator), and then open the following file:

    squaredupv4\User\Configuration\openaccess.json

    For an Azure Marketplace deployment the squaredupv4 folder will typically be located at F:\squaredupv4.

    For an install using the downloadable installer the default location is C:\inetpub\wwwroot\SquaredUpv4, but a custom location may have been chosen during the installation.

  2. Modify the file to read as follows:

    {
        "oa-loopback-base-url": "LoopbackURL",
        "oa-ajax-complete-wait": 5000
    }

    where LoopbackURL should be replaced with the URL determined above, for example https://localhost or https://CertificateURL

  3. Save the file.
  4. In IIS recycle the SquaredUpv4 application pool for the setting to take effect.

    If you are unable to access SquaredUp ("SquaredUp cannot start due to an error" or "Startup failed for 'Configuration'") after editing openaccess.json then there is an error in the file. Correct openaccess.json and recycle the SquaredUpv4 application pool again.

Some tiles on the Open Access page are not shown

You may need to increase the time between the dashboard being loaded and snapshot being taken.

You will need to connect to your SquaredUp server.

  1. On the server where SquaredUp for Azure is installed run Notepad as administrator (File, Run, type notepad, and then right-click and select Run as administrator), and then open the following file:

    squaredupv4\User\Configuration\openaccess.json

    For an Azure Marketplace deployment the squaredupv4 folder will typically be located at F:\squaredupv4.

    For an install using the downloadable installer the default location is C:\inetpub\wwwroot\SquaredUpv4, but a custom location may have been chosen during the installation.

  2. If openaccess.json is blank or only contains {} then add the following:

    {
        "oa-ajax-complete-wait": 5000
    }
  3. If openaccess.json already contains settings, then you will need to add a comma at the end of the previous line to look something like this:

    {
        "oa-loopback-base-url": "https://hostname",
        "oa-ajax-complete-wait": 5000
    }
  4. Save the file.
  5. In IIS recycle the SquaredUpv4 application pool for the setting to take effect.
  6. You may need to adjust the time in milliseconds. If not specified, the default for oa-ajax-complete-wait is 1000 ms.

Open Access dashboards are cut off or show an unusable fixed scroll bar

If the full length of the Open Access page is not shown or fixed scroll bars are visible then you may need to increase the following settings as shown below.

You will need to connect to your SquaredUp server.

  1. On the server where SquaredUp for Azure is installed run Notepad as administrator (File, Run, type notepad, and then right-click and select Run as administrator), and then open the following file:

    squaredupv4\User\Configuration\openaccess.json

    For an Azure Marketplace deployment the squaredupv4 folder will typically be located at F:\squaredupv4.

    For an install using the downloadable installer the default location is C:\inetpub\wwwroot\SquaredUpv4, but a custom location may have been chosen during the installation.

  2. If openaccess.json is blank or only contains {} then add the following:

    {
        "oa-ajax-complete-wait": 5000,
        "oa-width-resize-wait": 1000,
        "oa-height-resize-wait": 1000
    }
  3. If openaccess.json already contains settings, then you will need to add a comma at the end of the previous line to look something like this:

    {
        "oa-loopback-base-url": "https://hostname",
        "oa-ajax-complete-wait": 5000,
        "oa-width-resize-wait": 1000,
        "oa-height-resize-wait": 1000
    }
  4. Save the file.
  5. In IIS recycle the SquaredUpv4 application pool for the settings to take effect.
  6. You may need to adjust the time in milliseconds. If not specified, the default for oa-ajax-complete-wait is 1000 ms, and for oa-width-resize-wait and oa-height-resize-wait it is 300 ms.

"Error loading dashboard - A valid mapping was not found for the given ID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, there may be more information available in your log file."

This means the dashboard is no longer available on this Open Access URL. It may be that the dashboard is no longer available in Open Access mode, or that the Open Access URL has changed.

If you remove a dashboard from Open Access mode and later re-enable it then the dashboard will be given a different Open Access URL, and any external bookmarks or links will need updating.

"You do not have the required permissions or your current license does not include Open Access"

  1. You may see this message if you are not licensed for Open Access.
  2. A user may see this message if they are not a SquaredUp administrator and they are not an author for the Team Folder.

Some things won't work on Open Access pages

  • Open Access dashboards are non-interactive so users will not be able to hover or drill down for more information. You may wish to design your dashboards slightly differently with Open Access in mind. For example, you should consider adding a key to a performance line graph.
  • Web Content tiles are not supported with Open Access, because in many cases they do not work. Slow webpages may show as blank in Open Access. Webpages requiring authentication will not work because Open Access does not use any authentication.

Reference

Open Access settings

This table shows the most used Open Access settings as described in this article. Most values are in milliseconds (ms), but oa-refresh-interval is in seconds.

Json Description Default value Suggested
oa-loopback-base-url Base loopback URL https://localhost https://CertificateURL
oa-ajax-complete-wait How long to wait after an ajax call before assuming all calls are complete in ms (1000 ms is 1 second) 1000 5000
oa-width-resize-wait Timeout applied before doing the width in ms (300 ms is 0.3 seconds) 300 1000
oa-height-resize-wait Timeout applied before doing the length in ms  (300 ms is 0.3 seconds) 300 1000
oa-engine-logging When this is enabled an OpenAccessEngine.log file is generated in F:\squaredupv4\Transient\Log false true (if troubleshooting)
oa-verbose-logging When enabled SSR will log verbosely false true (if troubleshooting)
oa-refresh-interval Open Access dashboard refresh interval in seconds (not in ms) (60 seconds) 60 60

Once troubleshooting is complete, remove the "oa-engine-logging": true, and "oa-verbose-logging": true lines and remove the comma from the last line.

Open Access

How to publish dashboards with Open Access

How to configure Open Access

Collecting Diagnostic Information

Squared Up Ltd. (c) 2020Report an issue with this article