Skip to main content

Theme Personalization

Documentation Team
  • Updated

Theme Personalization

Theme Personalization allows users to view Dashboard Server in either dark theme or light theme.

Azure Edition uses dark theme by default.

Setting your individual theme

You can decide if you want to view Dashboard Server Azure Edition in dark theme or light theme. The individual theme setting only affects the way Dashboard Server looks to you, not how it looks to other users.

  1. Go to the top right-hand menu ☰ > personalization.

  2. Toggle the  dark theme button to on or off.

    When the dark theme button is set to off, you'll see Dashboard Server in light theme. When it is set to on, you'll see Dashboard Server in dark theme.

Setting the theme for all Open Access Dashboards

Open Access dashboards in Azure Edition default to dark theme

By default Open Access dashboards use the same theme, for example dark theme, as normal dashboards, and all users who navigate to any of the Open Access URLs will be affected by this setting. If required, Open Access dashboards can be given a different theme by changing the global setting for all Open Access dashboards, or changing it on a per dashboard level:

ClosedHow to edit the Global Open Access Json 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.

JsonDescriptionDefault valueSuggested
oa-refresh-intervalOpen Access dashboard refresh interval in seconds (not in ms) . Default is 60 seconds, but you might like to change this, for example "oa-refresh-interval": 12060120
oa-themeOpen Access dashboards in Azure Edition can be in light theme or dark theme, for example "oa-theme": "darktheme"

darktheme

lightheme

(if preferred)

oa-interactionOpen Access dashboards allow drilldown by default, and if the user isn't logged in they get the logon screen, to login or request a license. Drilldown can be switched off for all Open Access dashboards by changing this global value to false. Default value: true. Interaction can be changed on a per dashboard basis in System > Open Access (v5.5 and above).  

  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 Dashboard Server folder:

    ...\User\Configuration\openaccess.json

    ClosedWhere to find the Dashboard Server folder

    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

    If you deployed Dashboard Server via the Azure Marketplace:

    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 and for v4 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 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 Dashboard Server application pool for the setting to take effect.

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

ClosedChanging the theme for individual dashboards

System > Open Access

This setting allows you to change the theme on a per Open Access dashboard basis.

This setting overrides the global Open Access theme.

Comments

0 comments

Please sign in to leave a comment.