1. Basic Instruction

1.1 Installation

• After checking whether your operating system is 32 or 64 bit, download a file and then unzip the file. (Dexter Wiki > Download > dexter-daemon_x.x.x_32.zip / dexter-daemon_x.x.x_64.zip )
• Caution : Do not include spaces in the file name when Dexter-daemon is exported or downloaded to directory.

• e.g.) "C:\dexter daemon_#.#.#_64\dexter.exe" is incorrect. ( DO NO USE 'blank' in directory Path)

• e.g.) "C:\dexter-daemon_#.#.#_64\dexter.exe" is correct (The example explained here with an assumption that the zip file is unzipped in this directory.) 

• Install MS Visual C++ 2013 Redistributeable (skip this step if it has been already installed): C:\dexter-daemon_#.#.#_64\install\

• • 32 bit : vcredist_x86.exe
  • 64 bit : vcredist_x86.exe, vcredist_x64.exe

1.2 Run

1. Run the file C:\dexter-daemon_#.#.#_64\dexter.exe or C:\dexter-daemon_#.#.#_32\dexter.exe.
2. At the first run time, the following [Login Dialog Box] is displayed to create an account.
   
   
   • Single ID: type in your User ID
   • Password: create a password as 4~20 digits of English characters and numbers.
   • Dexter Server: Server IP: Port has been listed in Dexter Administrator.
   • Dexter Home Path: It is the folder that are static analysis result and CLI configuration file. You can use default Dexter Home Path. 
   • Connection Test to Dexter Server: It just to check for Dexter Server has running that is input label.(It isn't check correct ID/Password information).
   • Run in standalone mode : If you don't have a Dexter Server, you need to check this option. Then you can check Defect with Standalone mode.
3. You can click the [OK] button, then login with existed account or NEW Account has been added. 
   • If you want to changed the Dexter Account Password, Please contact to Dexter-server Admin or change Dexter Web.

1.3 Source Insight Configuration

• Run for Source Insight.
• Then Open "Base " Project as below:  (menu) > Project > Open Project... 
  
  
  
• Click the right button of the mouse on a project window. And then Click "Add and Remove Project Files..."
  
• Put "dexter.em" file path on [File Name] label, and then click "Add" button.
  
  ※ If you have the dexter.em file that is already added in Base project, remove it.
  
• Dexter.em file has added in Base project.
  

  
  

• It must check Event Handling option in Preferences. (menu > Options > Preferences... > Tab of General  > Misc > check 'Enable event handlers' )
  

• • You have to restart to Source Insight. If you start Sourceinsight, the Dexter is will begin.

1.4 Run static analysis on Dexter Daemon

• Open Project that you develop package in Source Insight : (Project > Open Project)
• Open the file, and then edit and save a source code file.
• After a while, static analysis result and log added in Dexter daemon.
• 
  
  • The Fist execution may take more time due to the necessary libraries to load the result.
  • After installing the SSD shows the results more quickly, But It take the some minute that you use the network drive.
• When you are editing in the Source Insight, a static analysis results are displayed as a bookmark later.
  (By pressing the up and down keys, an event is generated to display bookmarks in Source Insight)
  
• You can remove of defect refer to bookmark or defect description on Dexter daemon.
  (Dexter Daemon > click on the checker name  > click on the right mouse button  > click 'Checker Description'
• 
  
  
  
  
• Caution
  • When running a static analysis based on "FILE" option, defect may be detected smaller than "PROJECT" option. Because it run without related header file.
  • If you want to analysis the source code with header file, you need to add the Project information on Dexter Daemon.(refer as below "2.1 Run static analysis by project")

1.5  Mark to False defect for dismiss 

• You can dismiss on false defect after internal team review, then it isn't display on Source Insight.
• Dismissed defect is not display in Source Insight as bookmark, but you can check as "dismissed" Defect in Dexter Daemon.
• you click on the right mouse button as below : click the checker Name() >  click on the right mouse button  > [Dismiss Defect] 
  
• You can check changed status a few minute later.
  
• To change from dismissed defect to defect by clicking on the [Undismiss Defect] menu.
• Caution [ Manages asynchronous session transfers. ]
  • When you want to defect dismissed, it may not be reflected immediately on Dexter daemon.
  • If you want to check immediately, you need to re-run static analysis in Source Insight.

2.Advanced Usage

2.1 Run static analysis by project

• The static analysis is only check defect in file on Source Insight, but you can check all of defects in project scope through Dexter Daemon.
• Purpose of use
  • You can check Source code and all of defects in Dexter WEB.
• If you run analysis by this mode, defects are detected by "admin" in Dexter WEB.
  
• Click "Run Dexter static analysis" Icon () to open configureation by project, module path, or files.
  
• Set up project information through under the static analysis the dialog box. And then click OK button.
  ※Caution : Files under 2MB only are target to analize.
  
  
  • Project Name: mandatory. Project name must be same to the Source Insight Project. (otherwise the results will not detected)
  • Project Home Directory: mandatory. You need to include the 'top-level' directory related "package". ※ DO NO USE 'blank' , 'Korean' and 'Special Character' in the path.
  • Scope: mandatory. Specify a range of static analysis
    • PROJECT: Run for Project scope. It can identify defects in Source Insight. But source code is not visible in Dexter WEB .
    • FOLDER: Run for FOLDER scope(Sub directory are automatically included)
    • SNAPSHOT: If you can check the "SNAPSHOT" option, this information can use weekly defect analysis. The source code can be show in Dexter WEB.
  • Source Directory: mandatory. You need to include the 'top-level' directory that related source files.Sub directorys are automatically included
    • +/- button: Manually Save / Update .
    • auto: It is automatically add all of the directory with the name 'src', 'source'.
    • reset: Remove all List
  • Header Directory: option: You need to include the 'top-level' directory that related header files.Sub directory are automatically included (C / C ++ Only)
    • auto: It is automatically add all of the directory with the name 'include', 'inc','i' .
    • You need to added another directory.
  • Target Directory: If you want to check for "Folder" Scope, you can use this option.
  • Configuration List: option: When you save the current configuration,"Project name - Project folder is the save "Key".
    • After registration, you can re-use several additional configuration information. But only one registration per project.
    • + : Save / Update.
    • - : Remove.

2.2 Run static analysis for Large package by CLI

• Purpose of use
  • If you include the build script, It will be automatically run at build time.

  • If you want to run the number of files, you can run through the CLI.(over 2000files).

• The same as the way you use your existing CLI, you refer to the following guides: How to install and use Dexter CLI

2.3 Use keyboard shortcut :  Run static analysis

• Purpose of use
  • You can run static analysis on current open file without "modify / save" event on Source Insight.
• Open Source Insight, then Click  (menu > Options > Key Assignments).
• Choose  'runDexterForCurrentFile' macro  in [Command:] 
  
  • Click [Assign New Key...] button, then set shortcut key on configuration
  • Click [OK]  button to save current configuration.
• Open NEW file , then assign shortcut key that run static analysis.
• To check log that static analysis for current file in Dexter Deamon. 
• If there are defects in file, you can check the line of defect  'bookmark' in Source Insight.

2.4 Use keyboard shortcut : Mark to False defect for dismiss 

• Purpose of use
  • You can mark False defect for dismiss in Source Insight without Dexter Deamon.
• Open Key Assignments at 2.3.(* menu > Options > Key Assignments)
• Choose 'markDexterDefectToFalseAlarm' macro, and then mark keyboard shortcut.
• Put cursor on the line of defect that Dexter are founded in Source Insight.
• Enter the specified shortcut key that set above.
• The bookmark has been deleted from the current source code on Source Insight.
• Caution [ Manages asynchronous session transfers. ]
  • When you want to defect dismissed, it may not be reflected immediately on Dexter daemon.
  • If you want to check immediately, you need to re-run static analysis in Source Insight.
  • If you dismissed on Dexter Daemon,it maybe apply after a few minutes in Dexter Web.

2.5 Use Dexter Web/Dashboard

• If you have not a Dexter-server, you need to set up Dexter-Server first.
• Purpose of use
  • Use to comprehensively analyze the defect: all of the defect tables, per checkers, Analysis per module, etc.
  • Use as an auxiliary tool for code review activities: Dexter defect to the first excerpt
• Click on the Dexter WEB Icon() to open a web page that shows all of the Defects.
• Click on the Dexter Chart Icon() to open a dashboard.
• Each usage, refer to the following guide: How to use Dexter WEB

3. Verify

To verify with completion of installation by Dexter in Source Insight, you can download and check using test workspace.  

• You can check the bookmark icon and as below, and also check Defect in Dexter daemon.

Test Code in Source Insight

We are share one example project which contain more issues.