Troubleshooting Open Access (v5)
This article describes how to troubleshoot Open Access on Dashboard Server v5. If you are using v4 see Troubleshooting Open Access (v4).
Troubleshooting steps
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 Dashboard Server
2. Re-generate 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 Dashboard Server 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':
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.
"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 - 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
How do I increase the Dashboard Server logging level to log data about Open Access?
Support may ask you to change the Dashboard Server logging level from information to debug. You can do this from the top right-hand menu ☰ system > maintenance
Reference: v5 Open Access settings
The table shows Open Access settings you might see in your openaccess.json
file that you can find in your Dashboard Server folder in the path \User\Configuration\
Changing these settings changes them globally for all Open Access dashboards.
You will need to recycle the application pool for the changes to take effect.
Name of the Dashboard Server folder
The name of the Dashboard Server folder is SquaredUpv
followed by the product version number
.
Location of the Dashboard Server folder
The default location for the Dashboard Server folder is F:\
.SquaredUpv[Version Number]
For example, for Dashboard Server Azure Edition v5 the default location is F:\SquaredUpv5
F:\SquaredUpv4
If you installed Dashboard Server using the installer:
The default location for the Dashboard Server folder is C:\inetpub\wwwroot\SquaredUpv[Version Number]
, but a custom location may have been chosen during the installation.
For example, for Dashboard Server v5 the default folder location is C:\inetpub\wwwroot\SquaredUpv5
C:\inetpub\wwwroot\SquaredUpv4
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 Azure Edition default to light theme, but can be changed to dark theme | darktheme | lightheme (if preferred) |