Troubleshooting Open Access (v5)

This article describes how to troubleshoot Open Access on SquaredUp DS 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 SquaredUp DSenterprise application has at least the minimum of the Reader role. See Sharing Dashboards with anyone - Open Access

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 SquaredUp DS 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 Open Access: You do not have the required permissions or your current license does not include Open Access

How do I increase the SquaredUp DS logging level to log data about Open Access?

Support may ask you to change the SquaredUp DS 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

Global Open Access settings can be set and changed in the openaccess.json file. Global settings affect all Open Access dashboards, but some settings can be overridden on a per dashboard level in Dashboard Settings.

1. On the SquaredUp server, run Notepad as administrator (Start, Run, type notepad, and then right-click and select Run as administrator).

   With Notepad in administrator mode, open the openaccess.json file from the following path in the SquaredUp DS folder:

   ...\User\Configuration\openaccess.json

   Where to find the SquaredUp folder

   Name of the SquaredUp folder

   The name of the SquaredUp folder is SquaredUpv followed by the product version number.

   Location of the SquaredUp folder

   If you deployed SquaredUp DS via the Azure Marketplace:

   The default location for the SquaredUp folder is F:\SquaredUpv[Version Number].
   For example, for SquaredUp DS for Azure v5 the default location is F:\SquaredUpv5 and for v4 F:\SquaredUpv4.

   If you installed SquaredUp DS using the installer:

   The default location for the SquaredUp folder is C:\inetpub\wwwroot\SquaredUpv[Version Number], but a custom location may have been chosen during the installation.
   For example, for SquaredUp DS v5 the default folder location is C:\inetpub\wwwroot\SquaredUpv5 and for v4 C:\inetpub\wwwroot\SquaredUpv4

2. If openaccess.json is blank or only contains {} then enter the setting and the value you require, for example:

   Copy

   {
   "oa-refresh-interval": 120
   }

3. If openaccess.json already contains settings, then you will need to add a comma at the end of the previous line, and then enter your setting and value, to look something like this:

   Copy

   {
   "oa-theme": "darktheme",
   "oa-refresh-interval": 120
   }

4. Save the file.

5. In IIS recycle the SquaredUp DS application pool for the setting to take effect.

   If you are unable to access SquaredUp DS ("Server Error in '/SquaredUpvx' Application", "SquaredUp DS 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 SquaredUp DS application pool again.