Standard onboarding follows the legacy onboarding workflow where source code is delivered and then immediately analyzed and results published to CAST Imaging/CAST Dashboards. Re-analysis is then possible after consulting the published results. A standard onboarding allows you to get analysis results quickly using the default settings provided in Console. Results should be treated as an initial "baseline" and that settings may need "tweaking" and a subsequent analysis/snapshot run. The steps required are as follows:
Steps to follow
- Check whether the prerequisites for application onboarding are met before using CAST Imaging - Console. Please read Prerequisites - Application onboarding. Make sure that in Admin Center > Global Configuration > Application onboarding is unchecked. Then only you will be able to select the option for Onboarding without Fast scan or Onboarding with Fast scan.
- Click on Add a new application in Application Management panel. You must have an Admin or Application Owner role to add an application. In the dialogue box that opens up provide a name for the applications source code that you want to upload and provide a domain name.
If this is the first Application you are adding, no domain names will exist. if the field is left blank the Application will not belong to any domain and will be listed under 'No Domain'. if you have already added an Application and created a domain at the same time, or you have manually added a domain all existing domains will be offered in a drop down list. Selecting one will assign the new Application to the existing domain.
- Add a version first and then upload the source code that you want to analyze.
- Click the Add version button, found in the row where the application name is displayed.
- Upload the source code file by clicking on the upload cloud icon button or you can drag and drop one .zip or .tar.gz file containing the source code.
If you want to deliver source code containing:.NET source code: you should ensure that you define the location of the .NET Assemblies which is required for a successful analysis. See Configuring source code delivery for .NET.
If you want to deliver source code containing Maven you should ensure that you define the location of the Maven repositories so that any associated JAR files can be automatically discovered and that POM dependencies can also be located - which is required for a successful analysis. See Configuring source code delivery for Maven.
- Decide on the Module strategy. If Run analysis option is not disabled then you can decide on the Module strategy for your results. Modules are a means to configure analysis results into meaningful groups or sets for display purposes. The content of a module is based on source code. When creating a new version modules can be created based on technology which is the default or analysis unit. To know the details of all the above options please refer Add source code
- Click on the 'Next' button if you want to complete the optional Manage Exclusions steps. Manage Exclusions allows you to exclude specific files and/or folders in the uploaded archive file and manage project exclusion rules.
- You can add a new pattern using a glob pattern expression. The pattern matching system uses glob patterns. Enter an expression to match the folders you want to exclude and then click ADD to add the expression to the list of excluded items. For eg entering *.txt will exclude all files with the extension .txt. Please refer Options available for more derails.
- Click on Please refer se the GUI to select items to exclude. You will get a a screen where you can select the files and folder from the uploaded archive file you want to exclude (the archive will be unpacked by AIP Console) - place a check mark in the items that must be excluded, then click SAVE to add them to the list of exclusions. Options available for more derails.
- Administration Center - Settings - Exclusion templates panel under Exclusion Templates. Please refer to use the exclusion template . This option enables you to choose from a template that has been predefined in the Options available for more derails.
Use the Project Exclusion Rules option to configure the "exclusion" rules for specific projects identified during the source code delivery. When an exclusion rule is matched, then the project in question will be ignored. The aim of these rules is to avoid a situation where multiple projects (and therefore Analysis Units) are generated for a given piece of source code when more than one is not needed. If you are unsure, you should leave the default settings as they are and review them before accepting delivery. More details can be found at Project Exclusion Rules
- Click on the 'Next' button if you want to complete the optional step to Choose objectives which is needed to pre-configure an analysis (install specific extensions, set specific settings etc.) based on the results you require. For more details please refer Choose objectives.
- Click on the Finish button to start the scan.
Check the results.
Click the last action status green button in the Application Management panel to check the Progress window for the success message "Last execution ended successfully". The duration it took for the process to complete can also be seen. If you do not have a "success" message at the end of the process (i.e. if one of the steps contains an error/warning, or if the process fails entirely), you can check the individual logs for all the actions that have been performed immediately after they have completed. To check the logs, in the Progress window, click and expand each step to click on the View log option. You can also use the Log Console at Application level to view all logs. More details can be found at Check logs.
- Click on the application name in Application Management panel or use the Application - Overview to view information about the results produced by the analysis/snapshot, including technologies discovered, Function Point information, source code organization, architecture map etc.
- Click the square button on the top right hand side corner. This opens up a panel. Click on the icon for imaging to access your CAST Imaging instance. Similarly clicking on the imaging icon present in the row allocated for each application in the Application Management page listing will also open up CAST Imaging. Please also read Check and configure CAST Imaging
Prior to accessing Imaging check that the version status of your Application in the AIP Console - Application Management screen is Snapshot done - this means that the source code has been analyzed and uploaded to your CAST Imaging instance. Then use the CAST Imaging icon to take you direct to the specific Application data in CAST Imaging.