Introduction
The Job Progress panel is displayed when any kind of job is actioned, for example:
- Fast Scan
- Analysis
- Upload to Imaging/Dashboards
- Install Extensions
- Application upgrade
- etc.
It is designed to provide more details about the individual steps that are performed within a single job and give access to logs and alerts for those steps. The panel will display automatically when a new job is started, or, the most recent job information can be re-displayed using the following icon located in the bottom left corner of the screen:
Interface in ≥ 2.9
Click to enlarge
Header
| Item | Description |
|---|---|
| 1 |
|
| 2 | Name of the current job in progress, or the most recent job to be completed (in this case the date and execution time is also displayed). |
| 3 | Progress indicator. |
| 4 | Stop button to halt the current job. When a job has successfully completed, failed, or has been manually stopped no other buttons are available and jobs should be started or re-started from the Application - Overview with Fast Scan page. |
| 5 | Current duration of the job in HH:MM:SS. |
| 6 | Clicking View Logs will take you direct to the log panel displaying logs for the current job. |
Main section
Each "phase" in the job is listed in a distinct "tile" and information about the progress of individual steps is provided. The last three sub-steps are displayed for an ongoing jobs:
Icons are as follows:
| Item | Description |
|---|---|
| Job step to do. |
| Job step in progress. |
| Job step completed successfully. |
| Job step manually interrupted. |
| Job step failed. |
Right hand Alerts panel
This panel displays alerts generated during the current job. In order for some alerts to be displayed here, the separate Log Service is required - see Log Service installation:
Download alerts
The download alerts button will download all alerts in the current list to a CSV file (which can be opened in Microsoft Excel or similar):
Filter/search alerts
Use the filter/search field to display on those alerts that match the string you enter. The entire content of the alert is considered for the filter, i.e. title and body:
Grouped alerts
Where multiple alerts of the same type are present, they will be grouped as shown below:
View Remedy
Clicking the View Remedy button (available for analysis related alerts) will take you to the specific line in the associated log file:
Click to enlarge
Missing dependencies/JAR file alerts
The Alerts panel will list "Missing dependencies/JAR file" type alerts, regardless of whether the separate Log Service is installed (see Log Service installation). These type of alerts are particularly important for the accuracy of the overall JEE analysis results - if JAR files referenced in the source code (for example via a Maven pom.xml file) cannot be found then some objects will not be created, links will be missing, transactions will be incomplete etc. It is therefore crucial to check your configuration to avoid these alerts. See Configuring source code delivery for Maven. Starting 2.10, multiple messages originating from multiple missing dependencies are grouped together in one single alert:
Analysis Indicator alerts
The Alerts panel will list alerts for Analysis Indicators (see Application - Overview with Fast Scan and Application - Legacy Overview) regardless of whether the separate Log Service is installed (see Log Service installation). Currently, the minimum threshold setting is 1 by default (this threshold will be configurable in a future release), therefore when an indicator has 0 stars in its status, a job alert will be raised. Starting 2.10, multiple messages originating from multiple Analysis Indicators are grouped together in one single alert:
Alerts can be raised for both Application and Snapshot Indicators (together known as Analysis Indicators):
- During the prepare analysis data and compute application indicators step -> alerts may be raised depending on the results of application indicators
- During the generate snapshot indicator and compute snapshot indicators step -> alerts may raised depending on the results of snapshot indicators
Non UTF-8 character set identified alerts
When source code is delivered in CAST Console and this source code contains characters whose encoding or character set is not UTF-8, this can cause problems during the analysis phase. CAST Console (when using the Workflow - Application onboarding with Fast Scan) will warn you that the source code contains non UTF-8 encoded characters and provide a list of the files impacted - see Configuring the automatic UTF-8 conversion feature:
Unanalyzed files alerts
When an analysis has been completed, CAST Console provides two alerts about files that have not been analyzed. If you receive these alerts, you should investigate why they have been triggered by examining the analysis log files:
Global alerts
This alert is a "global" alert and by default is triggered when at least 50% of the files sent for analysis were not analyzed. This percentage is calculated using the values for the total number of files sent for analysis and the total number of Not Analyzed files (available in the Analysis Report - see Application - Overview with Fast Scan). These unanalyzed files have been skipped for various reasons:
- The analyzer has skipped them (syntax error, corrupt, are third-party libraries, are generated code etc.)
- They have specifically been excluded by an exclusion rule configured via the File Filter option (see Application - Overview with Fast Scan) - these rules are only applied during the analysis.
Specific "no reason" alerts
Note that if your Node is using AIP Core 8.3.51 or earlier, then CAST Console will ALWAYS have "no reason" why the files were skipped. When using AIP Core ≥ 8.3.52, more information is provided about why the files were skipped.
This alert is more specific and by default is triggered when at least 10% of the files sent for analysis were not analyzed AND CAST Console cannot give a specific reason why they were not analyzed. This percentage is calculated using the values for the total number of files sent for analysis, the total number of Not Analyzed files which have no specific reason for not being analyzed. These unanalyzed files have been skipped by the analyzer and therefore it is very important that you examine the log file to understand why they were skipped, since this could have a negative impact on your analysis results.
Threshold configuration
The percentage threshold for both of these alerts can be configured - see Configuring unanalyzed alert thresholds.
Log panel
This panel displays all logs available in the current job (and all "sub jobs") - the panel is available when jobs are ongoing and when they are completed:
- Logs (including logs from previous jobs) are also available in the Log panel.
- The Configure, Analyze and Upload sections correspond to the different categories of jobs - note that they may not all be displayed since it entirely depends on the type of job you have launched:
- The log list and log panel can be re-sized as required:
- The right hand Alerts panel is displayed by default but can be hidden:
- The log file can be downloaded:
- Text and background colours can be toggled:
Interface in older releases (≤ 2.8)
In older releases (≤ 2.8), the Job Progress panel will slide in from the right hand side of the screen:
Click to enlarge
Logs
Logs can be accessed using the following clickable link:
Missing dependencies/JAR file alerts
These type of alerts are particularly important for the accuracy of the overall JEE analysis results - if JAR files referenced in the source code (for example via a Maven pom.xml file) cannot be found then some objects will not be created, links will be missing, transactions will be incomplete etc. It is therefore crucial to check your configuration to avoid these alerts. See Configuring source code delivery for Maven. These alerts will be indicated by a yellow warning triangle and more information can be obtained by clicking the View Log link:
