...
Browse to the following URL replacing server/port/dashboard with the details of your environment:
| Code Block | ||
|---|---|---|
| ||
WAR 1.x /ZIP/JAR ≥ 2.x http://<server>:<port>/<dashboard>/static/default.html ZIP ≥ 2.xWAR http://<server>:<port>/<dashboard>/static/default.html |
if If you are already logged in, click the Test button to ensure you have an active session:
...
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 Health Dashboard clients, and reduced interruption for ED Engineering Dashboard 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
...
- after a license key change, or snapshot reconsolidation - Reloads the license.key file, the license.xml file (used for authorization definition when using a restricted license.key) and invalidates the browser cache.
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:
|
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 | ||
|---|---|---|
| ||
WAR 1.x / ZIP/JAR ≥ 2.x 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" ZIP ≥ 2.xWAR 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:WAR 1.x / , replace ZIP/JAR ≥ 2.x
ZIP ≥ 2.xWAR
|
...
Below table details the actions that you can perform using command line.
| Info |
|---|
Do not use the command lines exactly as shown below, you will need to replace |
Use Case | Action | User Impact | ||
|---|---|---|---|---|
Add a new DataSource | Update I.e. updating context.xml and Restart Tomcat/ application.properties / domain.properties and restarting the web application. | If users are online, they will be interrupted. | ||
Make a new application available in EDWAR 1.x / Engineering Dashboard (reload action). | ZIP/JAR ≥ 2.x:
WAR:
| If users are online, they will be interrupted with a logout popup window. | ||
Make a new application/snapshot available in HD | WAR 1.x / ≥ 2.x: http://server/:[port]/<dashboard>/rest/server/refresh?domain=AAD http://server/:[port]/rest/server/refresh?domain=AAD | No interruption for online usersHealth Dashboard (refresh action). Make a new snapshot available in HD/EDWAR 1.x / Engineering Dashboard (refresh action). Note that the | ZIP/JAR ≥ 2.x:
WAR 1.x / ≥ 2.x: :
ZIP ≥ 2.x: http://server:[port]/rest/server/refresh?domain=AAD
| No interruption for online users |
Apply new authorizationsWAR 1.x / license key, change license.xml file (used for authorization definition when using a restricted license.key) or reconsolidate a snapshot for Engineering Dashboard (reset action). | ZIP/JAR ≥ 2.x:
ZIP ≥ 2.xWAR:
| No interruption for online users |
...
- 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 | ||
|---|---|---|
| ||
WAR 1.x /ZIP/JAR ≥ 2.x curl https://localhost:8080/<dashboard>/rest/server/reload -H "X-API-KEY: <some_key> -H" "X-API-USER: admin" ZIP ≥ 2.xWAR curl https://localhost:8080/<dashboard>/rest/server/reload -H "X-API-KEY: <some_key> -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). |
...
When refresh service is executed
Server The 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 Dashboard/Measure schema. The following user notification is displayed to the Dashboard users when a new application is added.:
Following The following user notification is displayed when a new snapshot is taken.:
When reload service is executed
The server reloads from cache , when when a new application is added to central base (EDEngineering Dashboard), and blocks the user activity on Dashboard until the server is reloaded. Following The following pop-up message is displayed to the Dashboard users as shown in the below screen. users:
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.The web service reloads the license.key file, the license.xml file (used for authorization definition when using a restricted license.key) and invalidates the browser cache. The following pop-up message is displayed to users:
