Page tree

Versions Compared

Key

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

...

Code Block
languagetext
  "configuration": {
    "defaultLanguage": "English",
    "description": "To configure new language for application, define customLanguages as [{'label': 'languageName', 'value': 'localeFolderName'}]",
    "customLanguages": [],
    "requestAccess": false,
    "confirmLogout": true,
    "filterHealthFactor": truefalse,
    "violationsCount" : 5000,
    "navigation": {
      "pages": [
      ]
    },
    "tag": {
      "shift": true,
      "description": "used to configure tag-list, ActionsOverview column(tagType) and placeholder",
      "placeholder" : "Select a Priority",
      "placeHolderEducation": "Select a Tag for future violations",
      "tagType": "Priority",
      "tag": [
        { "label": "Low" },
        { "label": "Moderate" },
        { "label": "High" },
        { "label": "Extreme" }
      ],

...

OptionParameterDescription
Choose a default languagedefaultLanguage

By default, the dashboard language is set to English. Other languages will be available in the Change Language drop down list when a locale is added (see Dashboard localization for more information). When the Change Language option is used, the new language is configuration is stored in the local browser cache, therefore, if the cache is emptied, then the language will reset to the default (which is set to English out of the box). 

If you would prefer to have a different language as the default for all users, then change this parameter to match the official name of the locale you have added. You need to ensure that the locale exists as described in Dashboard localization).

Configure the ability to request access when not able to log inrequestAccess

Used to determine whether a "Can't access" link is displayed on the login screen. By default this is set to "false" and the link is not displayed. Change this value to "true" to enable the link. This link enables a user who is not able to log in (for example because they have forgotten their login credentials or if they have not yet been granted access) to send an email to the dashboard administrator requesting access:

See Lost password and request access configuration for more information about how to modify the template emails that are sent out when a user uses this option.

Configure log out dialog boxconfirmLogout

When set to true (default position), this option will force a log out warning dialog box to be displayed when a user selects the log out button:

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

Code Block
languagetext
"confirmLogout": true,

to:

Code Block
languagetext
"confirmLogout": false,


Configure the display of all Business Criteria or just Health FactorsfilterHealthFactor

When set to true (default position) only Business Criteria that are categorised as Health Measures will be displayed in the dashboard. All other Business Criteria that are NOT Health Factors will not be displayed:

Setting this option to false will When in false position (default position), it will force the display of ALL Business Criteria whether they are categorised as Health Factors or not:

Define the number of violations displayed when "Show More > All" is clickedviolationsCount

The violationsCount parameter is taken into account when listing violations in various parts of the dashboard. The default value of 5000 is the upper maximum  number of violations that can be displayed. If the number of violations exceeds this value then the "All" option (shown below) is deactivated - this is to prevent a performance hit in the dashboard when a large number of violations exist.

 

Changing the value will change the upper maximum - i.e. if you are experiencing performance issues when you have many violations to list via the "All" button, then you should reduce the default value.

Info
Note that the value must ALWAYS be above 100.


Defines how long the session timeout will operatealertTimeoutInterval

By default the dashboard will listen for GET or POST requests and when none are detected a timeout will occur. When the timeout occurs a dialog box will be displayed - this indicates (in the upper right corner) how many seconds are remaining before a re-login will be required - the default remaining seconds is set to 10. Clicking Continue will return to the session without requiring a login.

To change the remaining seconds, add the following parameter to the file, where xx = the number of seconds:

Code Block
languagetext
"alertTimeoutInterval":xx,

For example, 30 seconds has been defined:

Code Block
languagexml
  "configuration": {
    "defaultLanguage": "English",
    "description": "To configure new language for application, define customLanguages as [{'label': 'languageName', 'value': 'localeFolderName'}]",
    "customLanguages": [],
    "requestAccess": false,
    "confirmLogout": true,
    "filterHealthFactor": truefalse,
    "violationsCount" : 5000,
	"alertTimeoutInterval":30,


Define custom Action Plan prioritiestag

The "tag" section governs the"priorities" used when adding a violation to the Action Plan (see Engineering Dashboard - Action Plan). By default, when adding a violation to the Action Plan, the following dialog box is displayed:

It enables you to select one of four default "priorities" for the violations (Extreme, High, Moderate, Low). These priorities, the "Select a priority" text "placeholder" and the "tagType" can all be customized, for example:

Code Block
languagexml
"tag": {
   "shift": true,
   "description": "used to configure tag-list, ActionsOverview column(tagType) and placeholder",
   "placeholder" : "Select a Rank",
   "tagType": "Rank",
   "tag": [
      { "label": "1" },
      { "label": "2" },
      { "label": "3" },
      { "label": "4" }
	]
},


Info
Note that the "tagType" parameter governs the name of the column displayed in the Action Plan listing the Priority. By default tagType is seto to "Priority".


Add drop down tag filter listruleTag

Use the ruleTag option to configure a list of tags (custom tags or tags provided by the Quality Standards Mapping extension) that can be displayed in a drop down filter in the Risk Investigation view:

Click to enlarge

Use the following configuration:

Code Block
languagetext
"ruleTag": ["tag","tag"],

For example, the following configuration adds two tags (OWASP and CWE):

Code Block
languagexml
{
	"description": "used as a placeholder for as much as possible relevant default application parameters, please do not edit manually",
	"configuration": {
		"defaultLanguage": "English",
		"description": "To configure new language for application, define customLanguages as [{'label': 'languageName', 'value': 'localeFolderName'}]",
		"customLanguages": [],
		"requestAccess": false,
		"confirmLogout": true,
		"filterHealthFactor": truefalse,
		"violationsCount": 5000,
		"ruleTag": ["OWASP", "CWE"],


Info
  • The extension Quality Standards Mapping must be installed prior to generating the snapshot, otherwise no tag data is available and no results will be returned.
  • When drilling down from the Risk Investigation tile, the drop down tag list is not displayed when a Health Measure is selected, instead, you will need to select a child Technical Criteria or the All Rules option.


...