Page tree
Skip to end of metadata
Go to start of metadata

On this page:

Target audience:

CAST AI Administrators

Summary: This page explains how to configure various advanced options that affect the entire CAST Application Analytics Dashboard (i.e, they are valid regardless of whether your dashboard contains one or multiple Applications). Note that this page does not deal with Tiles (see CAST-AAD - Tile management) nor Categories/Tags (see CAST-AAD - Tag and category management).

Above and beyond the configuration possibilities that are available for Tiles and Categories/Tags, there are additional advanced configuration options as listed below:

  • Configure the page title
  • Configure language
  • Configure scroll direction
  • Configure time period options
  • Configure logout confirmation
  • Configure tag filtering options
  • Configure the number of Applications displayed in Evolution details pages
  • Configure user preference persistence

How to configure the options

The options listed above are governed by a .json file located here (this is the same file that is used to configure Tiles (see CAST-AAD - Tile management) at Multi-application level):

%CATALINA_HOME%\webapps\CAST-AAD\portal\resources\cmp.json

The options are available at the very start of the file:

{
    "title": "Application Analytics Dashboard",
    "language": "dev",
    "horizontalScroll": false,
    "confirmLogout": true,
    "persistNavigationFilters":true,
    "filtering":{
      "filterTags":true
    },
    "period": {
        "shift": true,
        "periods": [
            { "diff": 30, "units": "days" },
            { "diff": 3, "units": "months" },
            { "diff": 6, "units": "months" },
            { "diff": 12, "units": "months", "selected": true },
            { "diff": 2, "units": "years" },
            { "diff": 0, "units": "alltime" }
        ]
    },
    "Evolutions":{
        "selectedApplicationCount":10
    },

To modify the options, edit the cmp.json file with a text editor (Notepad or other similar application). CAST recommends creating a copy of the default cmp.json file that can be used as a replacement if an error occurs during editing.

Viewing the changes in your browser

There is no need to restart the application server or application itself if you edit and save the cmp.json file: changes are immediate on saving the file. However, you may find that the changes are not immediately visible in the CAST Application Analytics Dashboard. This is because the .json file is loaded into the browser's cache, therefore CAST recommends that you empty your browser cache to force the changes to become visible.

If you are using Google Chrome the following tip can be used to automatically empty the browser cache:

  • Tap F12 to open the Developer Tools window at the bottom of the page.
  • Click the Settings icon (a cog) to the right of the Developer Tools window
  • Tick the Disable cache (while DevTools is open) option and close the Settings window.
  • In this state, when you then tap F12 followed by F5 to refresh the page, the browser cache will be automatically emptied.

Option descriptions

Option
Parameter
Example
Description

Configure the page title

title
"title": "Application Analytics Dashboard",

Used to display a title in each landing page:

By default this is set to:

  • cmp.json = Application Analytics Dashboard
  • app.json = Application Level Analytics Dashboard

Note that the app.json file is located here (this is the only dashboard wide option that is available in both the cmp.json and app.json files):

%CATALINA_HOME%\webapps\CAST-AAD\portal\resources\cmp.json

Enables you to choose the language you require

language
"language": "dev",

By default, the CAST Application Engineering Dashboards is delivered with language display set to English: all messages and text displayed in the dashboard is only displayed in English. However, it is now possible to set a specific locale and provided that a translation of the default English text and messages has been configured, the dashboards will then display text and messages in the chosen language.

See CAST AAD-AED - Dashboard localization for more information.

Configure scroll directionhorizontalScroll
"horizontalScroll": false,

Used to determine the scroll direction for the areas within the dashboard pages. By default this is set to "false", as such, areas are placed vertically on top of each other and scrolling is applied vertically.

Change this value to "true" to enable horizontal scrolling - i.e. areas are placed side by side.

Configure logout confirmation

confirmLogout

"confirmLogout": true,

When a user logs out of the CAST Application Analytics Dashboard, a confirmation message will be displayed by default:

If you would like to deactivate this confirmation message, simply change

"confirmLogout": true,

to

"confirmLogout": false,
Configure user preference persistence

persistNavigationFilters

"persistNavigationFilters":true,

During navigation with the CAST Application Analytics Dashboard, you may be selecting filters, grouping or different periods than are configured by default. If the parameter persistNavigationFilters is set to true (the default is false), the web application will try and record your preferences in the browser's cache. By doing so, when you access the dashboard another time, if those parameters are not set in the URL, those from the cache will be used instead, enabling you to pursue navigation with the same filtering/grouping parametrization.

If you access a page with parameters already set in the URL, they will be used instead. Any time you change one of these parameters, the parameters will be saved again in the cache for future use.

The persistence only applies to

  • tags/technology filters
  • group by options
  • period parameters
Configure time period options

period

"period": {
	"shift": true,
	"periods": [
		{ "diff": 30, "units": "days" },
		{ "diff": 3, "units": "months" },
		{ "diff": 6, "units": "months" },
		{ "diff": 12, "units": "months", "selected": true },
		{ "diff": 2, "units": "years" },
		{ "diff": 0, "units": "alltime" }
	]
}

This option enables fine tuning of the time period options for evolution data that are available to users in the top right hand corner of the dashboard:

These options are explained in more detail in CAST Application Analytics Dashboard - CAST AAD (see Time period selection).

  • shift: (true by default) If true then the time period shown ends at the time of the last snapshot (considering all Applications at Multi-application level and the selected Application at Application level) to help focus on the most recent data available rather than the actual time scale. If false then all time period filters end on the current day/time.
  • periods: provides a means to configure the period filter menu:
    • diff: is an integer value representing the period length
    • units: represents the time unit associated to diff (possible values are: "days", "months", "years", "alltime"). If alltime is set, the diff value is not taken into account. 
    • selected: (false by default) set to true on the period you wish to be selected by default when the user opens a page
    • label: represents a custom time period label to be used. Otherwise, the label is based on the diff and units parameters.
Configure tag filtering options

filtering

"filtering":{
	"filterTags":false
},

When set to true:

Users only get access to categories/tags that match the Application's full scope (i.e. tags that do not apply to any Application accessible to the user are not displayed).

When set to false:

Users can see all categories and related tags regardless of whether any Applications are assigned to them. Filtering on visible tags with no Applications will lead to a blank display however.

Configure the number of Applications displayed in Evolution details pagesEvolutions
"Evolutions":{
	"selectedApplicationCount":10
},

This option defines the number of Applications that are included in the Evolution details pages (i.e. the pages accessed when clicking an Evolution tile either at multi or single Application level). The default value is set to 10 Applications - beware when configuring a high number of Applications as it can significantly impact performance. The parameter can be overridden by plugin specific configuration.

  • No labels