Versions Compared

Key

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

...

You will be asked for your Kiuwan account username and password to enter Kiuwan Rule Developer. Once you have logged in, you will see the welcome page:Image Removed 

Kiuwan Rule Developer user interface is divided in three areas:

...

  1. Access https://www.kiuwan.com and log in to your Kiuwan account.
  2. Click Go to Model Management module (click on the configuration icon (menu at top right of the screen) and click on the Quality Models Manager option .
  3. Create en empty quality model (New model, Create from scratch).
  4. Go to the "Rules" section and click on the "Install rule definitions" linkmenu option.
    1. Click the "Upload" button and select the rule definition that Kiuwan Rule Developer has created in the definitions folder.
    2. Click "Next" and click on the quality model you have just created to add your rule to it.
    3. Click on the "Install" button to proceed.
  5. Your rule will be installed into your library and will be added to the new quality model.
  6. Publish the quality model so you can assign it to one of your applications for analysis.
  7. Click on the configuration icon (top right of the screen) and click on the Application management option.
    1. Select the application you will analyze with the new quality model that contains your custom rule.
    2. Open the drop down menu in the Quality parameters section and select the quality model you have created in step 3.
Image RemovedImage RemovedImage Removed
StepScreenshot
3.Image Added
4.Image RemovedImage Added
4.a.Image Added
4.b.Image Added
4.c.Image RemovedImage Added
5.Image Removed7.Image RemovedImage Added

 

After following the previous steps, everything should be prepared to run a new analysis with Kiuwan Local Analyzer.

...

  1. Run Kiuwan Local Analyzer by double clicking in the AGENT_HOME/kiuwan.cmd script in Windows or by running the AGENT_HOME/kiuwan.sh script in Unix OS.
  2. Log in with your Kiuwan account.
  3. Select the application you want to analyze with your custom rules. In our case, this will be "Test application".
  4. Select the source code you want to analyze and click "Next" button.
  5. Click on "Analyze" button. You will see in the status bar (bottom of the window) that Kiuwan Local Analyzer first downloads the quality model associated with the selected application, in our example, "My company quality model" and, then, analyzes the source code you have previously configured.
  6. Click on "View results" button to access Kiuwan site and see the results.

 

Step

Screenshot

3. and 4.

Image RemovedImage Added
5.Image Removed
6.Image RemovedImage Added

Viewing the analysis results

Once the analisis is done, you can check the results by clicking on "View results" button. A browser will be open and Kiuwan web page will appear with the results of the analysis.

In our example, one violation has been detected in one file, as we can see in the analysis overview:

Image Removed


Image Added

If you access the "Defects" section, you should see a defect emitted by your own custom rule you have just created using Kiuwan Rule Developer:

Image RemovedImage Added

Summary

In this quick start guide we have seen how to create, modify, pack, install and execute a custom rule for Kiuwan. We can summarize the needed steps in the following list:

...