Skip to main content

How to publish dashboards with Open Access

Catherine
  • Updated

Dashboards can be made a made available as Open Access for anyone to view without the need to log in to SquaredUp. Perspectives cannot be made available as Open Access directly, but a pinned perspective can. Only administrators have permissions to make globally viewable dashboards available as Open Access.

Users with author or owner permissions on a Team Folder can make dashboards within that Team Folder available as Open Access. Any dashboard shared as Open Access will potentially be viewable by anyone, and viewing will no longer be controlled by the Team Folder permissions.

For information about configuring Open Access see Enabling Open Access.

This article covers:

The Open Access Navigation Bar

The Open Access navigation bar is visible to anyone, and allows them to view any Open Access dashboard which has been added to it.

mceclip0.png

You can choose not to use the Open Access navigation bar, and just create Open Access URLs as described in this article.

The Open Access navigation bar is shown at the top of the screen for all Open Access dashboards, even if they themselves have not been added to the Open Access navigation bar.

When using the Open Access navigation bar, dashboards can be accessed from http://SquaredUpServer/SquaredUpv4/openaccess/

where SquaredUpServer is the server where SquaredUp is installed.

mceclip1.png The SquaredUp logo takes you to the default Open Access page, which is the first on the navigation bar. The sort order of the pages on the navigation bar can be changed from the right-hand menu ☰ > system > Open Access.

Open Access theme

The theme for all Open Access dashboards is set from the right-hand menu ☰ system > Open Access.

Open Access dashboards in SquaredUp for Azure default to dark theme. This can be changed to light theme on the Open Access settings page to light theme by toggling the dark theme button to off.

OpenAccessDarkThemeOffDM.png

This is a global setting which controls the theme for all Open Access dashboards, not just for the user who changes the setting. It is different to the individual user personalisation theme setting.

How to create an Open Access URL without adding it to the Open Access navigation bar, for example for Sharepoint

  1. After a dashboard has been published click on the share this dashboard button:

    ShareThisDashboardDM.png

  2. Click generate to create an Open Access URL. If the user does not have permission to manage Open Access or you are not licensed for Open Access, then Open Access mode cannot be selected. A link can still be created to the dashboard in normal mode.
  3. Click preview to view the dashboard in Open Access mode.

The image of the dashboard is created and the dashboard is given an Open Access URL which you can then distribute, use in Sharepoint etc.

After a dashboard is updated the changes are usually displayed on the Open Access dashboard in just a few minutes, but it may take up to 20 minutes.

How to add a dashboard to the Open Access navigation bar

  1. Browse to the right-hand menu ☰ > system > Open Access

  2. In the Navigation Bar section click on the plus button:

    AddDashboardToNavigationBar.png

  3. Start typing the name of the dashboard you wish to add to the Open Access navigation bar. SquaredUp will return all dashboards matching the text you have typed. Select the dashboard you're looking for and it will be added to the Open Access navigation bar. If the dashboard was not already enabled for Open Access mode it will be automatically enabled.

  4. To create a folder on the Open Access navigation bar, type a name that does not match a dashboard and a folder will be created. You can then drag dashboards into the folder.

    EditOANavBar.png

It's worth noting that the Open Access navigation bar is shared across all users, and a user that is viewing any Open Access dashboard will be able to open any other Open Access dashboards that have been placed on the navigation bar.

How to disable Open Access for individual dashboards

  1. Browse to the right-hand menu ☰ > system > Open Access
  2. Dashboards which are enabled for Open Access are listed and you can click remove to stop a dashboard being available in Open Access mode.

If you stop a dashboard being available in 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.

FAQs

How can I best design a dashboard for Open Access?

  • As Open Access 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 (iframes) are not officially supported with Open Access, because in many cases they do not work:

    • Slow webpages will show as blank in Open Access.
    • Webpages requiring authentication will not work on an Open Access page because Open Access does not use any authentication.
    • Open Access displays the Web Content tile using a built in browser, that may support different features from your client browser.

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

You may see this message if you are not licensed for Open Access.

Can I set a different refresh interval for my Open Access dashboards?

By default Open Access dashboards use the same refresh rate as normal dashboards, refreshing every 60 seconds, and the last updated time can be seen at the bottom right of the Open Access dashboard. If required, Open Access dashboards can be given a different the refresh rate.

  1. Run Notepad as administrator (Start, 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 replace it with the following, specifying the value you require in seconds:

    {
    "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 to look something like this:

    {
    "oa-loopback-base-url": "https://SquaredUpURL",
    "oa-refresh-interval": 120
}
  4. Save the file.

  5. 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.

If I share a dashboard within a Team Folder as Open Access will it still be controlled by the Team Folder permissions?

No. If you share a dashboard within a Team Folder as Open Access by generating an Open Access URL, this URL will potentially be viewable by all users, and viewing will not be controlled by the Team Folder permissions.

Related articles