Versions Compared

Old Version 9

changes.mady.by.user Giulia di Pietro

Saved on

compared with

New Version Current

changes.mady.by.user Wara Hermosa Fernández

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

How to start your first scan using the Kiuwan GUI

Info
titleCommand Line Interface

If you prefer to use the Kiuwan Solutions via Command Line Interface, go to Kiuwan Local Analyzer CLI - Command Line Interface

Table of Contents

Basic Configuration

Info

These are instructions for plug-and-play. For Advanced Configuration, see below.

  1. Start

Table of Contents

 

GUI Startup

Basic Configuration

Start up
  1. the Kiuwan Local Analyzer.

  2. Enter your Kiuwan account details and

click on

  1. click Login

    Info

    If you are using an Internet Proxy and/or you need to integrate with a Local Authentication system, click

on Advanced button

  1. Advanced and visit 

Installation and Network Configuration for

  1. Configuration for Networks with Proxy or Local Authentication for further instructions.

Image Removed


  1. Image Added

  2. Define your basic analysis configuration on the analysis set-up window:

    • 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
  1. Image Modified

  2. Click
on
  1. Continue to view the analysis configuration window
    Image Modified

  2. Define your basic analysis: 
    • Product: select which Kiuwan Solution should be executed
(based on your Kiuwan Account)
    • by clicking on the checkbox. 

  2. Click
on
  1. Analyze
    You can view the analysis log while it
's
  1. is running by
clicking on
  1. clicking Analyzer log
Image Removed
  1. Image Added

  2. Your analysis is finished. You can now view the results on the dashboard by clicking
on
  1. View Results or by accessing your account on kiuwan.com.
    Image Modified

Anchor
AdvancedConfig
AdvancedConfig

Advanced Configuration

Analysis set-up

  1. On the analysis set-up window
you can
  1. , click Advanced to access the advanced configuration settings:
 

Image Removed
  1. Image Added

A new window

will open: 
Image Removed
  • Here you can select which file extensions should be analyzed. 

    • opens:
    Image Added

    Select a Model: 

      • Automatic = KLA uses the Model associated to the application;
      • Any other = that model is associated to the application for future analyses.

    Source Code Filters 

      • Specify the exact fileset you want to analyze. Visit Source Code Filters for further information.

    Analysis Configuration

    1. Click the settings wheel on the analysis configuration window
      Image Added

    2. Select which file extensions to analyze.
      Image Added

      Info
      titleC/C++

      For Advanced Configuration for C/C++ see Configuring an Analysis with C/C++ 

      You can click the Files column to

    By clicking on the Files column you will

    1. see the full list of files

    included

    1. in your folder.

    Image Removed

    1. Image Added

    2. After configuration is done,
    clicking the OK button will take you back to the analysis set-up
    1. click Close to return to the analysis configuration window.

     

    Analysis Configuration

    Info

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

    Click on the Advanced button on the analysis configuration window
    Image Removed
    Expand

    Advanced Analysis Configuration

    To open the Advanced Analysis Configuration dialog, click Advanced.
    Image Added

    Analysis Configuration 

    In this tab, you can expand the Select block menu, where you

    will be able to

    can select which technology you would like to configure.

    Image Removed

     

    Image Added
    The most important 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.

    Image Removed


    Extensions editor

    On Extensions editor tab, you

    will be able to 

    can modifiy the configured extensions of source files.

    Also, you

    You can also modify (

    adding

    add or

    deleting

    delete)

    currert

    current extensions. Visit 

    Please visit 
     for

     for further

    info.Image Removed

    information.

    Image Added

    Customize Metadata

    This dialog also allows you to modify the engine parametrization, for advanced users only. For more information, check Engine Metadata Files Customization

    Porfolios tab

    The Portfolios tab

    will

    allows you

     to configure

     to classify the current application

    to be clasiffied

    under the available portfolios.

    Image Removed

     

    Info

    Changing

    Please notice that changing

    the portfolio of the analysis will change the portfolio of the application itself.

    Image Added

    Scope of the configuration

    changes

    Once you have changed the settings,

    notice that the configuration you establish could affect

    you can either  :

    just 
    • Save this configuration only for the application
     whose analysis you
    •  you are about to
    run, or 
    • analyze;
    • Save as default for
    for 
    • all of your applications.
     

    Image Added

    Image Removed

     

    Kiuwan

    also

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

    Please visit 
    - 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:

    Image Removed

     

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

     

    Image Removed

     

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

     

    Image Removed

     

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

     

    CLI Startup

     

    Anchor#advanced-configuration#advanced-configurationClick on the Advanced button: a new window will appear for Advanced Configuration of the Analysis

    .

     Select a Model:

    Image Removed

     

  • Automatic = KLA will use the Model associated to the application;
    • Any other = that model will be associated to the application for future analyses.

    Source Code Filters 

    specify the exact fileset you want to analyze. Please visit Source Code Filters for further info..