Created by James Hurrell on Dec 12, 2023
This documentation is not maintained. Please refer to doc.castsoftware.com/technologies to find the latest updates.

Extension ID

com.castsoftware.highlight2mri

What's new?

See Highlight 2 MRI - 1.0 - Release Notes.

Description

The Highlight 2 MRI extension provides a solution for those wishing to view CAST Highlight results directly in CAST Imaging Viewer. This functions as follows:

  • The Highlight 2 MRI extension includes an embedded version of the CAST Highlight agent.
  • When an analysis is launches in CAST Imaging Console, the CAST Highlight agent is also launched and will scan all source code submitted for analysis.
  • The CAST Highlight agent will inject CAST Highlight results as properties of objects generated during the CAST Imaging Console analysis.
  • The application is then exported/imported into CAST Imaging Viewer as normal.
  • The CAST Highlight results can then be visualized throughout CAST Imaging Viewer in various different features (see below).

This extension is only visible in CAST Extend for those Extend users that are also CAST Highlight customers.

Compatibility

ProductReleaseSupported
CAST Imaging Core8.3.x(tick)
CAST Imaging Viewer≥ 2.14.0(tick)
CAST Imaging Console≥ 2.4.0(tick)

Prerequisites

ProductNotes
Java JRE

The CAST Highlight agent requires an installation of the JRE on the node. Java 8 and 11 are supported, depending on the release of the Highlight 2 MRI extension in use:

≥ 1.0.0-alpha4Java 11 required by CAST Highlight agent 5.4.29
1.0.0-alpha1 - 1.0.0-alpha3

Java 8 or 11 required by CAST Highlight agent 5.3.76

Supported technologies

TechnologySupported?
C++

(tick)

C#(tick)
Java(tick)
JavaScript(tick)
Python(tick)
TypeScript(tick)
VB.NET(tick)

Download and installation instructions

Installation of this extension behaves as follows, depending on the release of CAST Imaging Console you are using:

  • in ≥ 2.10, saving the entries in Administration Center - Settings - CAST Highlight Settings will ensure that the extension is automatically added to the Force Installation list - in other words the extension will be automatically installed in all existing applications when the next analysis is run and all new applications by default.
  • in ≤ 2.9, the extension will not be automatically added to the Force Installation list, therefore CAST highly recommends that you either:
    • add it to the Force Install list
    • manually install the extension in all applications that require it using the Application - Extensions interface. 

Configuration

This extension provides various different output results:

  • some results require no further configuration other than performing an analysis and importing into CAST Imaging
  • other results require that CAST Imaging Console is aware of the CAST Highlight connection settings before performing an analysis and importing into CAST Imaging Viewer:

E.g.:

Result typeCAST Highlight Settings configured
in CAST Console		Notes
CloudReady Blockers and Boosters / Containerization Blockers data(error)This data is generated by the Highlight Agent embedded in the extension.
Third Party Components (vulnerabilities/obsolescence/CVEs)(tick)This data is stored in the CAST Highlight SCA database and therefore requires that the CAST Highlight configuration is filled in in CAST Imaging Console.

What results can you expect?

CAST Highlight results can be visualized throughout CAST Imaging Viewer in various different features:

Note that the screenshots shown below may not be an accurate representation of this release.

CloudReady Blockers and Boosters / Containerization Blockers data

Welcome page  - Cloud Migration information tiles

Available in CAST Imaging ≥ 2.14.

Legends panel - Insights

Available in CAST Imaging ≥ 2.15.

Legends panel - Tags

Third Party Components (vulnerabilities/obsolescence/CVEs)

Welcome page  - Third party Components tile

Available in CAST Imaging ≥ 2.15.