Page tree
Skip to end of metadata
Go to start of metadata

 

 

Icon

Once you have downloaded and installed Kiuwan Local Analyzer (KLA) (see Installing and configuring the Analyzer Agent), you can execute it :

 

If you are experiencing problems whith KLA execution please visit Troubleshooting Kiuwan Local Analyzer.

And, do not forget that for any kind of doubt or question, you can contact KiuwanTechnical Support

 

Graphical User Interface (GUI)

GUI start-up

 

Kiuwan Local Analyzer (KLA) can be run through a Graphical User Interface (GUI).

Icon

It works with Linux, UNIX, MacOS and Windows.

You need to choose the correct command line script :

  • $(AGENT_HOME)/kiuwan.cmd (Windows)
  • $(AGENT_HOME)/kiuwan.sh (Unix-like and MacOs)
 

Note: In UNIX systems, please check kiuwan.sh has proper u+x permission attributes

 

GUI login and analysis set-up

GUI window of the agent is the following.

Please make sure you log in with your Kiuwan account user credentials (see Setting your credentials)

 

 

Icon

If you are using an Internet Proxy and/or you need to integrate with a Local Authentication system, click on Advanced button and visit Installation and Network Configuration for instructions.

 

 

Analysis set-up allows you to define basic analysis configuration:

  • Application name (name of the software package to be analyzed)
  • Folder to analyze (root directory where source files are located)
  • Analysis scope (please visit Analysis Scope)
  • Baseline label (custom label to identify this specific analysis from others)

 

Advanced Configuration (Analysis Model and Source Code Filters)


Clicking on Advanced button, Analysus setup advanced configuration dialog will be displayed.

 

In this dialog, you are able to assign a Model.

  • Automatic means that Kiuwan will use the Model associated to the application, 
  • By selecting any other, that model will be associated to the application for future analyses.

 

Kiuwan provides Source Code Filters to specify the exact fileset you want to analyze.

This mechanism is based on Include and Exclude Patterns. Please visit Source Code Filters for further info.

By hovering the mouse over the question mark, contextual help will be shown, defining the patterns to include or exclude, as you can see in the image below.

 

 

Analysis Set-up

Clicking on Continue button will display the next screen where you could set-up your analysis

 

 

 

Product section displays the available products (according to your Kiuwan Account), letting you to select which ones will be executed.

Clicking on the gear icon  let's you to further configure the analysis. 

 

 

In case there were files whose extension matches more than one technology, you will be asked to select one. Please visit Kiuwan Supported Technologies for further information.

You can also decide what technologies will be analyzed by checking/unchecking the Analyze? checkbox.

By clicking on the Files column you will see the full list of files to be analyzed.

 

After configuration is done, clicking on OK button will take you back to Analysis set-up window.

 

 

 

Advanced Analysis Configuration

 

Clicking on Advanced button, you will access the Advanced Analysis Configuration window.

 

Analysis Configuration tab

You can expand the Select block menu, where you will be able to select the technology whose options you would wish to configure.

Configuration settings will be taken into account in the subsequent analyses you run, either from the GUI or through command line.


 

Icon

Most important configuration settings are:

  • Encoding: encoding of the application's files. 
  • Analysis timeout (minutes): Maximum time for every analysis step. 
  • Max memory size: Maximum memory (heap) used by the analysis.

 

Extensions editor

On Extensions editor tab, you will be able to modifiy the configured extensions of source files.

Also, you can modify (adding or deleting) currert extensions. Please visit Kiuwan Supported Technologies for further info.


Porfolios tab

The Portfolios tab will allows you to configure the current application to be clasiffied under the available portfolios.

 

Please notice that changing the portfolio of the analysis will change the portfolio of the application itself.


Scope of configuration changes

Once you have changed the settings, notice that the configuration you establish could affect :

  • just only the application whose analysis you are about to run, or 
  • for all of your applications.

 

 

Kiuwan also provides the option to change/override configured values at time of analysis.

Please visit Command Line Interface (CLI) - Configuration scopes and precedence for a full explanation of configuration scopes and precedence.

 

Running the Analysis

After saving the changes and pressing the Analyze button, a screen with the log of what is making the analyzer will be shown:

 

While the analysis is running (or when it finishes), you can click on Progress icon to open the log of the execution.

 

 

Once the analysis finishes, you will be notified about its status (sucessful or fail), you will be also notified by email. 

 

 

Clicking on View results will open a browser window to access the analysis results within your kiuwan account (at www.kiuwan.com).

 

Troubleshooting

If you are experiencing problems whith KLA execution please visit Troubleshooting Kiuwan Local Analyzer