Introduction
The Overview section provides detailed information about the Application - information is derived from versions/analyses/snapshot, therefore the section will be empty if no versions/analyses/snapshots exist for a given Application. The section contains several "boxes" each providing different information. Each box is described in detail below.
Click to enlarge
Access
Move to the Console screen if you are not already there:
Locate the Application and click the Application name as highlighted below:
The Overview section will then be displayed:
Layout
The Overview section provides detailed information about the Application - information is derived from an analysis/snapshot, therefore the section will be empty if no analyses/snapshots have been run for a given Application. The section contains several "boxes" each providing different information. Each box is described in detail below.
Application ID card
This box provides a quick ID information about the application:
Name | The name of the application. |
---|---|
Domain | The name of the domain (see Administration Center - Applications) the application is assigned to. If the application is not assigned to a domain then '-' is displayed. |
Number of versions | Number of versions added for the application. |
Onboarding date | The date the application was created in Console. |
Last processing date | The last time any action (job) was processed for the application. |
AIP Core version | The AIP Core release assigned to the application - this is determined by the Node the application is managed on (see Administration Center - Nodes). |
Analysis Configuration
Click to enlarge
This box provides information about how the analysis is configured:
Module Strategy | The module strategy selected for the application. This is set when adding a new version, and can also be modified once the version has been delivered in Application - Config - Modules. Possible values:
|
---|---|
Enhancement measure | The function point enhancement method selected for the application. This is configured in Application - Config - Enhancement Measure. Possible values:
|
Architecture model attached | Number of architecture models attached to the application. Clicking the number will direct you to the Application - Config - Architecture panel where you can view a list of the models attached to the Application. |
Security dataflow | Indicates whether the Security Dataflow option was enabled for this analysis and which technology it was enabled for. Possible values:
|
Advanced customization | Displays any advanced analysis customization options that have been configured for the Application - options are clickable and will take you direct to the relevant configuration panel. Possible values:
|
Version view
This section provides information about a specific version within the application. By default, data for the most recent version is displayed, however, you can manually select a different version:
State & Sizing
This section provides information about the current version selected in the drop down:
Date | Date the version was created. |
---|---|
Status | Status of the current version. Possible values:
|
Lines of code | Total number of lines of code counted during the snapshot. This value is not present if a snapshot has not been generated. |
Functional size | Total Automated Function Points (AFP) identified in the Application during the snapshot. These details can also be seen in Application - Function Points. This value is not present if a snapshot has not been generated. |
Enhancement size | Total Automated Enhancement Points (AEP) identified in the Application during the snapshot. These details can also be seen in Application - Function Points. This value is not present if a snapshot has not been generated. |
Activated extensions | Total number extensions that were installed for the current version. Clicking the number will direct you to the Included tab in the Application - Extensions panel. |
Architecture Map
This section provides information about the architecture of the application in two separate sections:
- Source code architecture
- Technologies
Source code architecture
This section displays, by default, a graphical representation of the Version's source code before an analysis is run. This view is built once the the Version has been delivered and the source code has been "discovered". The view's primary aim is to help check the completeness of the source code that has been delivered.
All links between blocks are based on supposition only. Final architecture from an analysis may be different.
Toggling the Before analysis switch will change the display to show a graphical representation of the source code when an analysis has been run (if an analysis has not been run, this display is not available).
- Items marked in green confirm expected elements (technologies, frameworks, and links).
- Items marked in blue denote an additional element that has been identified during the analysis.
- Items in dashed white show an expected element that has not been found during the analysis.
- Numbers correspond to the number of occurrences of the item that have been found.
- DL refers to "Direct Link".
Technologies
This section displays a treemap of the technologies have been discovered automatically by Console. The size of each rectangle/square is proportionate to the number of files discovered in each technology. If the Set as current version action has not yet been executed, no "discovered" technologies will be displayed.
Frameworks
This section displays a treemap of the frameworks have been discovered automatically by Console. If the Set as current version action has not yet been executed, no "discovered" frameworks will be displayed.
Analysis Reports
This section provides a report on analyzed/not analyzed files for the current version:
Click to enlarge
File Extensions | A list of file extensions found in the delivered source code. Extensions are grouped by technology/language - and the extension that is displayed by default (the primary extension) is the extension with the largest number of files in the delivered source code. Other related file extensions that are found will also be displayed alongside: For the Mainframe - JCL technology, the extension .prc is not considered part of JCL language (in the vast majority of cases, these files do not contain any JCL related code), so files with this extension will be ignored in the analysis report. |
---|---|
Technology/Language | Technology or language of the file as detected by Console. |
CAST Extensions | The CAST Extension Console has used to process the file. Note that some primary file extensions may be listed as processed with multiple extensions. For example the .js file extension will appear twice:
|
Fully Analyzed | The total number of files of this type that were analyzed during the most recent analysis process. This number is taken directly from the analysis schema in which the analysis results are stored, in other words this number reflects the number of files that were saved as part of the analysis process.
|
Not Analyzed | The total number of files of this type that were sent for analysis by CAST Console but were not analyzed during the most recent analysis process (e.g. they were not saved in the results): Click to enlarge Clicking the number will display the following dialog box, providing a list of all the unanalyzed files: Click to enlarge When the Node uses AIP Core ≥ 8.3.52, a reason (where possible) will be given in the Reason column: These reasons correspond to Project Exclusion Rules set via the File Filter button (see above) for onboarding with Fast Scan: ...and via the Project Exclusion Rules screen when using onboarding without Fast Scan.
|
View Logs | Clicking this icon will direct you straight to the "Run analysis" log files. |
The search option allows you to filter for specific text. The search functions on the columns File Extensions, Technology/Language and CAST Extensions: | |
Click to download the report as a .CSV file. When opened in Microsoft Excel (or equivalent), two tabs are available:
|
Clicking a number in the list will open a popup with more details about the files:
To make results easy to use, some files are ignored and are not listed in this report:
- all files with extensions that are not associated directly to a programming language (all resources or data languages for example, or project files like xml, http or json).
- all files with patterns such as .git, .svn, node-modules, org-eclipse, CCAU\.abap, IP\.abap
- special files like package-info.java, *CT.abap, *CP.abap, hh, h++, hpp, hcc, h, hxx, ph
- files resulting from CAST Datbase extractions such as castextraction or uaxdirectory, because they are not currently directly associated with a language or extension.
Delivery Indicators
This section lists any indicators that are generated during the source code delivery for your version. They are designed to help you validate the delivery of the source code:
Click to enlarge
Indicator | See list of available indicators below for more information. |
---|---|
Value | The value generated for the given indicator. Can be a value, ratio or a percentage. |
Status | Status of the indicator - the more stars the better the results. |
Remedy Action | Click to view a suggestion for how to improve the result in the next source code delivery. For example: |
Details | Some indicators store results in a CSV file - click this option to download the CSV file. This can help you work out why a poor result has been produced, for example. CSV files are generated and stored on the node in: %PROGRAMDATA%\CAST\AipConsole\AipNode\snapshot-indicator\{appGuid}\{snapshotGuid} Where details are not available, the option will be greyed out. |
Available Delivery Indicators
Reports
This section will display any report that has been generated during the analysis/snapshot. All reports can be downloaded using the option highlighted below:
Name | Official name of the report. |
---|---|
Value1 | These two values are generated during the snapshot/analysis. These will help understand what information the report is providing. For example, for the ALV Report:
|
Value2 | |
Status | Indicates whether the report was generated correctly. |
Execution date | The date the report was run. |
File type | Resulting file generated by the report. |
Detailed report | Option to download the file containing detailed information about the report. |
Reports are primarily generated by the installation of an extension - for example, in the screenshot above:
- an Unanalyzed Code report has been generated. This is provided through the Unanalysed Code Report extension. Out-of-the box, this extension is set to "force install" - see Administration Center - Extensions Strategy / Administration Center - Settings - Extensions Strategy
- an Automatic link validation report has been generated. This is provided through the Automatic Links Validator extension. Out-of-the box, this extension is set to "force install" - see Administration Center - Extensions Strategy / Administration Center - Settings - Extensions Strategy. In addition, this extension is automatically installed when you choose any Objective when delivering source code.
Analysis Results / Snapshot Indicators
This section displays a set of indicators for a given analysis or snapshot. These indicators are designed to provide basic information quickly so that the snapshot can be validated. The indicators are generated during an analysis or a snapshot in a dedicated step and (from Console ≥ 1.26) can be generated on-demand manually (see below):
This feature is enabled "out-of-the-box" in Console ≥ 1.20.x. A new analysis/snapshot must be generated before any indicators are visible.
- The feature can be disabled if you are using an older release - see Configuring Indicators.
- You can enable and disable individual indicators in Administration Center - Settings - Analysis Results Indicators - this requires the global "Admin" role.
Click to enlarge
Categories filter | This drop down filters the Indicators in the list by category. By default, all categories are displayed in the list. |
---|---|
Show all indicators | By default this toggle switch is disabled, which means only Indicators that have a positive value (displayed in the Value column) will be displayed. All indicators which have "N/A" in the Value column will be hidden. Enable the option to show all Indicators regardless of their Value. |
Snapshot selector | Choose the snapshot you would like to view indicators for. By default the most recent snapshot for the Application will be displayed. |
Search | Use this to search on the Indicator name. |
Recompute indicators | This option enables you to download Microsoft Excel reports containing detailed information about the indicators in each category:
The file name used for the ZIP file and the XLSX files will contain a time stamp using the following format: Excel file report contents
|
Download report | This option is available in Console ≥ 1.26 and enables you to recompute the indicators without needing to generate an entire new snapshot/analysis.
|
Indicator | See list of available indicators below for more information. |
Value | The value generated for the current snapshot. Can be a ratio or a percentage. For some indicators when only one snapshot exists, the value may be N/A, for example:
|
Status | Status of the indicator - the more stars the better the results. Rolling the mouse over the stars will show the thresholds required to improve: |
Justification | Justifications can only be edited for the most recent snapshot. If the snapshot selector is changed to a historic snapshot, the field becomes read-only. A free text field enabling you to enter a justification for the result. Free text is saved and is retained for the next snapshot that is generated. For example:
≥ 2.9 Use the icon to add a new justification explanation:
And enter the justification in the pop-up: The icon changes to indicate a justification has been added: Older releases Enter the justification in the field itself. |
Remedy Action | Click to view a suggestion for how to improve the result in the next snapshot. Any links are clickable. ≥ 2.9 Remedies are displayed in line: If they are larger than the available space, rolling the mouse over them will display the full text in a popup: Older releases Click the icon to display the full text of the remedy: |
Details | Some indicators store results in a CSV file - click this option to download the CSV file. This can help you work out why a poor result has been produced, for example. CSV files are generated and stored in the following locations: ≥ 2.2.0 \\share\aip-node-data\common-data\snapshot-indicator\{appGuid}\{snapshotGuid} ≤ 2.1.0 - on the Node %PROGRAMDATA%\CAST\AipConsole\AipNode\snapshot-indicator\{appGuid}\{snapshotGuid} |
Clickable Indicators
Some Indicators are clickable: clicking the link will take you to the relevant configuration page within Console:
Available Indicators
Technical information about Indicators
- When a snapshot is deleted all the indicators for the snapshot along with the generated CSV files are deleted. In addition, the consolidation action launched when a snapshot is deleted will only deal with Dashboard schema indicators for the next two snapshots if they exist. During consolidation, any justification text is retained for each indicator.
- Snapshot Indicators are also deleted when a version and an application are deleted.
Logging information about Indicators
Technical aspects
The information provided in this panel is generated by internal tools as follows:
- ≥ 2.10: The CAST Profiler (https://profiler.castsoftware.io/) engine is used - this aligns CAST Console with CAST Profiler and brings improved scanning performance over the Framework Detector. Note that CAST Profiler will be silently and automatically updated whenever a new release of CAST Profiler is published. This is achieved as follows: a check for updates will occur roughly 1 minute after the Node service has been (re-)started, then every 24hrs. In addition, a check is made each time the "SAVE" button is pressed in Administration Center - Settings - CAST Extend (whether a field has been changed or not).
- ≤ 2.9: The Framework Detector is used.