Introduction
The Legend panel is displayed in all scopes and views and provides an interactive list of various different types of information about the objects/nodes in the current view. By default, the legend is in "expand mode" with the Objects tab enabled showing information such as object type, any relationships (links) between objects, any tagged objects and any object properties such as external libraries:
Available options
The Legend includes various options:
| 1 | Collapse
| This option collapses the legend - click anywhere in the collapsed legend to expand it to full size. |
|---|---|---|
| 2 | Sub items
| When the are many items in the legend, the list may exceed the browser size. If this is the case, you can use the drop down to navigate direct to the required section. Clicking the item will move the focus to the required section. |
| 3 | Tabs - these tabs function only when an item is selected in the view:
| See the information below. |
| 4 | Search mechanism | Available from 2.14. This option provides a search mechanism on the item name and is available in the Objects tab and functions for Objects, External Objects, Tags, Relationships, and Applications / Objects (in the Application to Application Dependencies scope). In the following example, a search string has been entered to search for a specific object name. Only those items matching the search string are shown in the legend panel and the number of items (the count) is updated:
You can then use the Hide All/Show All toggle to remove from or re-display those matching items in the view. With the matching items shown in the view:
With the matching items hidden from the view:
|
| 5 | Hide All / Show All | This option allows you to hide/unhide specific items. For example if you want to display only a specific type of object, click Hide All - this will hide all objects from the view:
Now click the specific object type you want to see, for example, Java Classes: Click to expand
|
| 6 | Resize
| This option allows the legend panel to be resized as required. Click the icon and drag the pointer to the required size. |
Tabs
Objects
The Objects tab lists the following items:
| Objects | Lists all the object/node types currently visible in the view (available at all levels):
|
|---|---|
| External Objects | External objects are the "third-party" frameworks and libraries present in view, for example:
|
| Relationships | Relationships are the links between items present in the view. In ≥ 2.14, sub-links are displayed:
|
| Tags |
|
| Properties | Lists all the different properties types assigned to objects/nodes in the view. For example, objects may be external (third-party), in which case they have an "External Libraries" property:
Properties can also be seen in the Properties tab (see below):
|
| Status | Lists the Status Property (modified/added/unchanged) assigned to objects/nodes in the view. When you click on a Status, all the objects with that status are highlighted. Clicking on the status tab in the legend will highlight all the matching object/node in the view and also in the graph.
|
Annotations
- Available from 2.13
- Previously known as Documents
Displays a list of View and Object level annotations that are available in the current view. Clicking them will display the corresponding Annotation - see also User Guide - Using the Annotate feature.
Properties
The Properties panel is available in all Scopes and Views. It can be accessed by right clicking an object and choosing the Properties option in the contextual menu:
The Properties tab can also be accessed using the keyboard shortcut ALT+P on a selected object.
Displays object property information:
Levels 1 - 5:
At Object level, more detailed information is provided:
- Object Name
- Object Full Name
- Object Type
- etc.
Configure button
- Available in ≥ 2.14.
- Only available to users with the ADMIN or SUPER ADMIN role.
The Configure option lets you add custom properties to the global search for an object (available at Object level). See Admin Center - Search panel for more information.
Third-party and CVE information
This information is generated by CAST Highlight, therefore these tiles are only displayed if the application meets the following requirements:
- Analyzed with CAST Console ≥ 2.4 (and fields in Administration Center - Settings - Highlight Settings are populated)
- Analyzed with the extension com.castsoftware.highlight2mri ≥ 1.0.0-beta
- When using CAST Imaging in a Docker environment, this feature requires the ≥ 1.2.10-funcrel Docker Installer (Docker Installer) which will need to be installed prior to performing an in-place upgrade.
In ≥ 2.14, specific object property information is displayed for external (i.e. third-party) objects such as Java Classes/Interfaces/JavaScript files etc.: name, version and age of the third-party component and also whether any CVEs are active against the component.
Associated to
Available in ≥ 2.6.
Additional associated information is available at Object level (except in the Application scope), for the selected object, where applicable:
- Associated Transaction(s)
- Associated Data Call Graph(s)
- Saved views
The options are only visible where a corresponding item is available (i.e. if the selected object is not present in an existing Saved view (for example) then the option is not displayed). Selecting the item will navigate directly to that item:
If more than one associated item is available, or the selected object is present in more than one Saved view, the available items are made available for selection:
Source Code
By default, Source Code display is not enabled and must be manually configured. See Configure the source code viewer:
Insights
The Insights tab, available in the Legends panel in ≥ 2.15, functions at Object level and provides an object's vulnerabilities, flaws, blockers and boosters, etc. Upon selecting a specific type of Insight, the objects in the view that have the selected type of Insight are highlighted. Selecting the highlighted object will then display details about the specific Insight in the object.
Note that CloudReady Blockers/Boosters and Containerization Blockers can also be accessed via the Welcome Page - see User Guide - GUI - Welcome Page - Cloud Migration information.
Prerequisites to view Insights of an object:
- Structural Flaws - these are essentially Critical Violations identified during a snapshot, to view them you need:
- A corresponding license for CAST Dashboards
- A snapshot
- Analyzed with the extension com.castsoftware.qualitystandards ≥ 20230206.0.0-funcrel
- Analyzed with Console ≥ 2.7 and a new onboarding
- CloudReady Blockers/Boosters and Containerization Blockers - this information is determined by CAST Highlight, therefore the application must be:
- Analyzed with CAST Console ≥ 2.4 (and fields in Administration Center - Settings - Highlight Settings are populated)
- Analyzed with the extension com.castsoftware.highlight2mri ≥ 1.0.0-beta
In all cases, the application must be re-imported to CAST Imaging after an upgrade to ≥ 2.15.
In versions ≥ 2.16
- CloudReady Boosters toggle is added
- Below warning message is displayed if you attempt to access Structural Flaws for an application that does not have a snapshot.
- Below warning message is displayed if the you attempt to access CloudReady Blockers/Boosters or Containerization Blockers for an application that has not been configured with CAST Highlight
Enable the type of insight you would like to view (1) - all objects with that specific type of insight will be highlighted (2):
Selecting a highlighted object provides details about the specific insight you have selected:
A clickable URL is available to obtain more information about the insight. This URL will lead to the documentation about the insight to help you understand what has been flagged:
Interactivity
All items in the legend are interactive:
| Objects / Relationships | Clicking either of these items in the legend will hide/show any matching object/node in the view. |
|---|---|
| Properties / Tags | Clicking either of these items in the legend will highlight any matching object/node in the view. For example, the tag "TEST" has been clicked and one object is highlighted in the view which has been tagged with this tag:
|
| Properties / Status | Lets you view the Status Property (modified/added/unchanged). When you click on a Status, all the objects with that status are highlighted. Clicking on the status tab in the legend will highlight all the matching object/node in the view and also in the graph.
You may use the option "Search for Objects" to search a Status. |
