Troubleshooting Open Access on v5
This article describes how to troubleshoot Open Access on SquaredUp v5. If you are using v4 see Troubleshooting Open Access on v4 towards the end of this article.
1. Check the SquaredUp enterprise application has the Reader role
Many issues can be resolved by rerunning the Open Access configuration to ensure that the SquaredUp enterprise application has at least the minimum of the Reader role.
2. Rerun generate for the dashboard experiencing issues
If one particular dashboard is experiencing issues with Open Access we recommend you rerun the generate option for that dashboard.
To do this in SquaredUp click the top right-hand menu ☰ system > open access then click the generate link next to that particular Open Access dashboard.
Alternatively, from the dashboard itself you can disable Open Access and re-enable it, by toggling from on to off to on again, which will also run the regenerate option.
You will see the message 'Preparing your Open Access dashboard, please wait':
3. Common errors:
"Unexpected Request" and the Open Access Upgrade step is unexpectedly displayed when an admin clicks an item on the navigation bar
The Open Access Upgrade step can be missed following an upgrade to v5 if a Core dashboard has been modified and shared via Open Access. This results in Open Access dashboards showing a yellow exclamation mark with the error "Unexpected Request" and the Open Access upgrade step being unexpectedly displayed when an administrator clicks an item on the navigation bar. This can be fixed by running through the Open Access Upgrade step that appears or clicking Generate All in system > open access.
"An error occurred" for a Pinned Perspective in Open Access
This can happen if the perspective is pinned and shared with Open Access before the SquaredUp enterprise application is given the Reader role. Ensure the SquaredUp enterprise application has the Reader role for the resource, and then from the top right-hand menu ☰ system > open access click the generate link for this Open Access pinned perspective.
"Error loading dashboard - No open access dashboards were found"
You may see this message when viewing the open access navigation bar if all the dashboards that were on the open access navigation have had Open Access disabled or are removed from the Open Access navigation bar.
"Error loading dashboard - This Open Access ID is expired or relates to a page which no longer exists"
You may see this message when viewing an Open Access URL for a dashboard that was previously enabled for Open Access but has since had Open Access disabled.
Some tiles on the Open Access page are not shown
Rerun the generate option for that dashboard, from the top right-hand menu ☰ system > open access click the generate link next to that particular Open Access dashboard, as described above.
"You do not have the required permissions or your current license does not include Open Access"
See You do not have the required permissions or your current license does not include Open Access
How do I increase the SquaredUp logging level to log data about Open Access?
Support may ask you to change the SquaredUp logging level from information to debug. You can do this from the top right-hand menu ☰ system > maintenance see Maintenance page.
Reference - v5 Open Access settings
This table shows the Open Access settings you might see in \squaredupv5\User\Configuration\openaccess.json
.
For an Azure Marketplace deployment the squaredupv5
folder will typically be located at F:\squaredupv5
For an install using the downloadable installer the default location is C:\inetpub\wwwroot\SquaredUpv5
but a custom location may have been chosen during the installation.
Json | Description | Default value | Suggested |
---|---|---|---|
oa-refresh-interval | Open Access dashboard refresh interval in seconds (not in ms) (60 seconds) | 60 | 60 |
oa-theme | Open Access dashboards in SquaredUp for SCOM default to light theme, but can be changed to darktheme | lighttheme | darktheme (if preferred) |
Troubleshooting Open Access on v4
Check that Open Access is configured correctly, check content that doesn't not work in Open Access and see if your issue is in this list of common problems:
"Error loading dashboard - An error occurred loading this dashboard"
"No resources", "No entities" or "Subscription not found"
Open Access dashboards do not show all the resources on a tile
Some tiles on the Open Access page are not shown
Open Access dashboards are cut off or show an unusable fixed scroll bar
"You do not have the required permissions or your current license does not include Open Access"
1. Check Open Access is configured correctly
Open Access enables easy sharing of dashboards, that do not require authentication to view. As no user is logged in, 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.
2. Common problems
"Error loading dashboard - An error occurred loading this dashboard"
If you see the following error, you should check the Open Access loopback URL:
Checking the Open Access Loopback URL
"No resources", "No entities" or "Subscription not found"
"No resources matched the specified scope."
"No entities found."
"The subscription was not found in the list of available subscriptions."
"There are no Azure subscriptions available: Check the Access Control (IAM) role and scope for the subscriptions you intend to access."
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
See Open Access dashboards do not show all the resources on a tile
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.
See Some tiles on the Open Access page are not shown
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 some settings.
See Open Access dashboards are cut off or show an unusable fixed scroll bar
"You do not have the required permissions or your current license does not include Open Access"
See You do not have the required permissions or your current license does not include Open Access
3. Content that does not work on v4 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 - v4 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 |
oa-theme | Open Access dashboards in SquaredUp for Azure default to dark theme, but can be changed to lighttheme | darktheme | lighttheme (if preferred) |
Once troubleshooting is complete, remove the "oa-engine-logging": true,
and "oa-verbose-logging": true
lines and remove the comma from the last line.