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


On this page:

Summary: this page describes the new features and bugs that have been fixed in the CAST Dashboard Package 1.10.0.

Content matrix

VersionSummary of contentComments
1.10.0
  • JIRA integration feature for the CAST Engineering Dashboard (in alpha release)
  • Custom reports in PPTX, XLSX and DOCX formats for the CAST Engineering Dashboard
  • Full Chinese translation available by default for all dashboards
  • Addition of module filter in Trend tiles drill down pages for the CAST Health Dashboard.

Can be used with:

  • 8.3.3 - 8.3.15
Note that starting from release 1.8.0, the CAST Security Dashboard related WAR files are no longer provided.

RestAPI documentation

Resolved issues

Internal IDCall IDDescription
DASHBOARDS-97217128App filter is not listed alphabetically in filter by section of AAD
DASHBOARDS-105517910Duplicated violation details for the results of rule "Avoid cyclical calls and inheritances between packages"
DASHBOARDS-106217881Dashboard Report Generator log shows password in the clear

New features - All dashboards

Chinese language locale now fully translated

All dashboard interface text has now been fully translated in to Chinese (zh_CN) and is available in:

Engineering Dashboard: CATALINA_HOME\webapps\CAST-Engineering\engineering\locales\zh_CN\translation.json
Health Dashboard: CATALINA_HOME\webapps\CAST-Health\portal\locales\zh_CN\translation.json

This means that you can select the Chinese language "out of the box" and all items will now be displayed in the target language. See also Dashboard localization.

New features - CAST Health Dashboard

DASHBOARDS-1016 - Addition of module filter in Trend tiles drill down pages

When drilling down from the Trends tiles to view detailed information, it is now possible to select the module you want to filter on:

Click to enlarge

The module filter is available in the following high level options:

  • Sizing Indicators
  • Health Measures
  • Best Practices

By default All Modules will be selected providing the equivalent of an Application level view. The list of modules available for selection varies with the selected time period: if a module is not present in the selected period then All Modules is be selected by default.

New features - CAST Engineering Dashboard

DASHBOARDS-909 - Atlassian JIRA integration

Note that the JIRA integration:

  • has been released as an Alpha feature in 1.10 as the current version of the feature does not cater to all possible use cases and as such there is no official support provided. Going forward, we would like to test some of our hypotheses with our customers and improve on this. However, we encourage you to test the feature and see how it fits into your organizational needs. We would be extremely thankful if you kindly participate with your feedback and help us refine the feature. Thank you.

  • requires a Dashboard Service schema configured for use with the CAST Engineering Dashboard that has been installed with CAST AIP ≥ 8.3.12. An error will be displayed if this requirement is not met.

The 1.10.0 release of the CAST Engineering Dashboard introduces an Atlassian JIRA integration that allows Atlassian JIRA tickets to be created directly from the interface of the CAST Engineering Dashboard. More specifically, one JIRA ticket can be created per violation that has been added to the Action Plan. Multiple tickets can also be created at the same time.

By default in 1.10.0, this feature is not active and therefore requires configuration before it can be used.

Enabling JIRA integration

Edit the following file:

CATALINA_HOME\webapps\CAST-Engineering\engineering\resources\ced.json

Add a new parameter called "JIRAConfig": true, into the "configuration" section as shown below:

{
	"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,
		"JIRAConfig": true,
		"confirmLogout": true,
		"filterHealthFactor": true,
		"violationsCount" : 5000,
		"reportCategory": [

Save the file and restart the host Apache Tomcat server for the changes to be applied. After the feature is active, the following will now be visible in the Action Plan:

Create JIRA ticket menu option

Ticket ID column

Configuring the JIRA integration

To configure the JIRA integration feature, create a new file called jira.properties in the following location (you can also download a sample jira.properties file with "dummy" data in it):

CATALINA_HOME\webapps\CAST-Engineering\WEB-INF\

Fill in the following information to connect to your own JIRA instance. Save the file and restart the host Apache Tomcat server for the changes to be applied.

jira.url=
jira.userName=
jira.userPassword=
jira.issueType=
jira.projectKey=
jira.url

Enter your JIRA instance RestAPI URL, for example:

https://jira.company.com/rest/api/2/
jira.userNameEnter the name of the JIRA user that will be used to create the JIRA tickets. You may wish to create a "service" type account specifically for this.
jira.userPasswordEnter the password that corresponds to the JIRA user you entered previously.
jira.issueType

Enter the type of JIRA ticket you would like to create. For example:

  • Task
  • Story
  • Epic

You can view the available ticket types in the JIRA project configuration settings, which can generally be found here (change the domain name and PROJECTKEY to suit your own environment):

https://jira.company.com/plugins/servlet/project-config/PROJECTKEY/summary
jira.projectKeyEnter the JIRA project key (not the name) in which you would like the JIRA tickets to be created.

Using the JIRA integration

To create a ticket for one single violation that has been added to the Action Plan, select the violation and choose Create JIRA ticket for selected violations:

The ticket will then be created and if successful a popup will be displayed:

You can create multiple tickets by selecting multiple violations and then choosing the Create JIRA ticket for selected violations. By default a maximum of 10 tickets can be created in one go - if you attempt to create more than this, a popup will be displayed:

If you attempt to create a ticket for a violation and the corresponding ticket already exists in JIRA, the following message will be displayed:

JIRA ticket fields populated by CAST

The following fields in the JIRA ticket are auto populated by CAST as follows:

Ticket title/summary

<CAST RULE NAME> - <OBJECT NAME>

E.g.:

Avoid empty catch blocks - C:\CAST\DEPLOY\APPLICATION\JEE\com\castsoftware\util\io\Recorder.java

TypeIssue type is set in the jira.properties file in jira.issueType.
StatusTo Do
ResolutionUnresolved
Assignee
Project lead as configured in JIRA. You can view the Project lead in the JIRA project configuration settings, which can generally be found here (change the domain name and PROJECTKEY to suit your own environment):
https://jira.company.com/plugins/servlet/project-config/PROJECTKEY/summary
ReporterThe user defined in the jira.properties file in jira.userName.
Priority/WorkflowSet to the default value for the ticket type.
DescriptionThis will be populated with information to help identify the violation.

Modifying the ticket creation limit

By default, a maximum of 10 tickets can be created in one go. If you would like to change this limit, edit the following file:

CATALINA_HOME\webapps\CAST-Engineering\engineering\resources\ced.json

Add a new parameter called violationsCountForJIRA into the configuration section and specify the limit you want to use - for example 20 has been chosen below. Save the file and restart the host Apache Tomcat server for the changes to be applied.

{
	"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,
		"JIRAConfig": true,
		"confirmLogout": true,
		"filterHealthFactor": true,
		"violationsCount": 5000,
		"violationsCountForJIRA": 20
		"reportCategory": [

DASHBOARDS-982 - Ability to generate a specific type of custom report (Word, Excel, PowerPoint)

The 1.9.x release of the CAST Engineering Dashboard introduced the notion of report generation direct from the dashboard interface. Custom reports can now be generated based in the presence of Report Generator templates. Up until now, no distinction was made for the type of report (Word, Excel, PowerPoint), however this has now been introduced by the addition of the filetype parameter.

To enable and define the reports for the category, edit the following file:

CATALINA_HOME\webapps\CAST-Engineering\engineering\resources\ced.json

Find the following configuration section:

{
	"id": "custom",
	"label": "Custom Reports",
	"reportTemplates":[]
}

To add your report for a custom template called Executive summary PPT.pptxAEP Sample Report.xlsx and My Custom Template 2019.docx change it as follows. Save the file and restart the host Apache Tomcat server for the changes to be applied:

{
	"id": "custom",
	"label": "Custom Reports",
	"reportTemplates":[
		{
            "templateLabel": "Executive summary PPT",
            "templateId": "Executive+summary+PPT",
            "fileType":"pptx"
		},
		{
            "templateLabel": "AEP Sample Report",
            "templateId": "AEP+Sample+Report",
            "fileType":"xlsx"
		},
		{
			"templateLabel": "My Custom Template 2019",
			"templateId": "My+Custom+Template+2019",
			"fileType":"docx"
		}   
	]
}

DASHBOARDS-966 - Deleted module data in previous snapshot

It is now possible to view data for modules that existed in the previous snapshot but have been deleted from the current snapshot. The data is available in the All Modules drop down when looking at a previous snapshot (previously, any deleted modules were listed in this drop down but were greyed out and could not be accessed):

Improvements to Miscellaneous reports

It is now possible to filter the results of Miscellaneous reports by Health Measure (TQI is selected by default):

Drill down to violation source code is also possible for some reports:

DASHBOARDS-775 - Show More option added to Continuous Improvement violation list

A Show More button has been added to the list of violations displayed in the Continuous Improvement page. By default, only 10 violations are displayed to improve performance. You can choose to display more using the various options (+10, +100 etc.). By default an upper maximum of 5000 violations is set when the "All" option is clicked. You can change the upper maximum if required (see the violationsCount option in Engineering Dashboard json configuration options).

  • No labels