Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel

On this page:

Table of Contents


Info
Summary: this page explains how to reload the dashboard cache to display the most up-to-date snapshot data.

Introduction

The CAST dashboards feature a data cache to improve the speed at which data is displayed. This means that when requesting data, the dashboard may return data direct from the cache rather than fetching it from the Measurement or Dashboard Service. In turn, this means that data displayed in the dashboard may not be up-to-date. This is particularly true in the following situations:

  • if you have very recently generated a snapshot and were expecting to see this new data
  • if you have run a manual consolidation with GUI/CLI admin tools
  • if you have deleted an existing snapshot

To see the new data, you can manually force the cache to reload data from the Measurement or Dashboard Service, rather than waiting for it to do so automatically.

Info
Note that you must login with a user that has the ADMIN role in order to action this task.

Via the RestAPI interface

Browse to the following URL replacing server/port/dashboard with the details of your environment:

Code Block
languagetext
http://server:port/dashboard/static/default.html

if you are already logged in, click the Test button to ensure you have an active session:

You will get a response as follows:

Logged inNot logged in

If you are "logged in" you can proceed as below, otherwise, enter your user name and password and then click Login:

Once logged in, expand the Help section, you may click any of the following buttons: 

  • Sync clients with new snapshots - Refresh of the server memory cache in the background with no interruption for HD clients, and reduced interruption for ED clients
  • Sync clients with new domains - Reload the domain properties configuration file and refresh the server memory cache
  • Sync clients with new authorizations - Invalidate the browser cache of all clients and refresh cache of authorizations

The cache will then be reloaded with the most up-to-date data from the Dashboard or Measurement schemas.

Info

The Reload server memory cache option (available in ≤ 1.23) has been replaced with the following options/buttons:

  • Sync clients with new snapshots
  • Sync clients with new domains
  • Sync clients with new authorizations

Via a command line for automation

You can also reload the cache via a command line - this enables you to automate the process if you are using CAST's command line interface to automate an analysis, snapshot generation and upload of data to the Measurement Service. You can use a tool such as cURL to do so, for example, replacing "server:[port]/<dashboard>" with the details of your environment. Choose the appropriate option as shown below:

Code Block
languagetext
curl http://server:[port]/<dashboard>/rest/server/refresh -u admin:cast -H "Accept: application/json"
curl http://server:[port]/<dashboard>/rest/server/reload -u admin:cast -H "Accept: application/json" 
curl http://server:[port]/<dashboard>/rest/server/reset -u admin:cast -H "Accept: application/json" 


Info

You can also specify a domain using the command line, for example:

curl http://server:[port]/<dashboard>/rest/server/refresh?domain=AAD -u admin:cast -H "Accept: application/json"

Actions using command line 

Below table details the actions that you can perform using command line.

Use Case

Action

Add a new DataSource

Update context.xml and Restart Tomcat

Make a new application available in ED

http://server/:[port]/<dashboard>/rest/server/reload?domain=ED

Make a new application available in HD

http://server/:[port]/<dashboard>/rest/server/refresh?domain=AAD

Make a new snapshot available in HD/ED

http://server:[port]/<dashboard>/rest/server/refresh?domain=AAD
http://server:[port]/<dashboard>/rest/server/refresh?domain=ED

Apply new authorizations

http://server/:[port]/<dashboard>/rest/server/reset

Anchor
apikey
apikey
Using an API Key

In ≥ 1.11.0 of the CAST Dashboard Package, an API Key feature has been introduced to allow connection without using standard login/password credentials or when SAML authentication is in operation. You can therefore use the API Key with curl as follows:

  • X-API-KEY: the API Key matching the key defined in the security.properties file
  • X-API-USER: a defined user name to obtain a CAST dashboard/RestAPI role and data authorization
Code Block
languagetext
curl https://localhost:8080/RestAPI/rest/server/reload -H "X-API-KEY: G]MauT-9/*<dev8r" -H "X-API-USER: admin"


Info
If you are using ≤ 1.10.0 the API Key is not available, therefore then it is not possible to use the curl command line as described above. Some additional steps may be required (this third-party documentation may provide some hints about how to do this with a simple username/password, however, this is beyond the scope of CAST documentation).

What to Expect 

When refresh service is executed 

Server cache is refreshed, when a new snapshot is taken or when a new application is added to the existing central/measure (ED/HD) base. 

Following user notification is displayed to the Dashboard users when a new application is added.

Following user notification is displayed when a new snapshot is taken.

When reload service is executed

The server reloads from cache, when a new application is added to central base (ED), and blocks the user activity on Dashboard until the server is reloaded.

Following pop-up message is displayed to the Dashboard users as shown in the below screen. 

When reset service is executed 

Server cache is reset, only when the authorization file is changed.

Following user notification is displayed to the Dashboard users when an authorization file/configuration is changed.