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 v5 application pool account has read-only access
Many issues can be resolved by rerunning the Open Access configuration to ensure that the SquaredUp application pool account has read-only permissions in SCOM. See Enabling Open Access
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.
"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 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
Missing SCOM Permission
SCOM On-Demand tasks cannot be run on Open Access dashboards, because Open Access is unauthenticated, so you will see the error MISSING_SCOM_PERMISSION.
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.
Enterprise Application perspectives shared with Open Access may not display correctly
Enterprise Application perspectives need a manual Open Access generation carried out if the Enterprise Application is modified.
Browse to the top right-hand menu ☰ system > open access, find the pinned perspective and click the generate link to run the Open Access generate step manually.
Reference - v5 Open Access settings
This table shows the Open Access settings you might see in C:\inetpub\wwwroot\squaredupv5\User\Configuration\openaccess.json.
| 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 and see if your issue is in this list of common problems:
"Error loading dashboard - An error occurred loading this dashboard"
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
- Check that you are using the latest version of SquaredUp. The version number is shown in the bottom right corner of SquaredUp. Download the latest version of SquaredUp here.
- In SquaredUp browse to the right-hand menu ☰ then system and then click on the Open Access perspective. Check you see a message saying SquaredUp is correctly configured for Open Access. If you do not see this message continue to the next step.
- Browse to http://SquaredUpServer/SquaredUpv4/setup?stage=openaccess (where SquaredUpServer should be replaced by the name of the server where SquaredUp is installed). Check you see a message saying that SquaredUp is correctly configured for Open Access. If you do not see this message click next to configure Open Access.
- If SquaredUp is unable to automatically configure Open Access please see the following article How to manually configure Open Access.
- Re-run the SquaredUp permissions tool to ensure the application pool identity has the correct permissions to the SquaredUp directory, see How to check and modify the application pool identity
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:
"An error occurred loading this dashboard" - Checking the Open Access Loopback URL
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:
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:
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.
- SCOM On-Demand tasks cannot be run on Open Access dashboards, because Open Access is unauthenticated, so you will see the error
MISSING_SCOM_PERMISSION.
- When using top n with the time comparison on the Report tile see Why are the time comparison lines showing different objects to those shown on the legend?
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 | http://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 C:\inetpub\wwwroot\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 SCOM default to light theme, but can be changed to darktheme | lighttheme | darktheme (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.