You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

Introduction

Kiuwan for Developers (K4d) is a plug-in for the Eclipse IDE that facilitates and automates compliance with quality standards and best practices for several languages. It provides the following benefits:

  • Automatic Error Prevention – Coding standards are specific rules for a programming language. By implementing and monitoring compliance with these standards at the time the code is entered you can avoid errors and reduce the time and cost of debugging and testing activities.
  • Adoption of Coding Standards – Ensuring the compliance of these standards by a development department can be a long and tedious task without the support of some sort of tool that will facilitate and automate this work. This plugin connects with Kiuwan and harness the power of its quality models to prevent errors and automatically standardise the code.

Kiuwan for Developers monitors and reports on the quality and efficiency of your code at the point that it is written. This immediate feedback provides you with the opportunity to improve your code before it is delivered.

Supported IDEs and Requeriments

 

Supported IDEs

Kiuwan for Developers has been succesfully tested in following IDEs and minimum versions:

  • Eclipse : Kepler (4.2) 
  • RAD (Rational Application Developer for WebSphere) : 9.5

For others IDEs and versions, please contact Kiuwan Technical Support

Java 8 required

Kiuwan for Developers (K4D) requires Java 8 or above —either JDK or JRE— is required.

You may download it from http://www.oracle.com/technetwork/java/javase/downloads/index.html.

Please visit Java 8 and JAVA_HOME for further info

Note for Linux/Uxis users

If your are running Eclipse under Linux/Unix you can experience problems after install K4D. 

That's due to some well-known problems with GTK3 use by Eclipse distributions. Please visit next links for furhter info.

To solve this issue, please modifiy eclipse.ini :

Add to your eclipse.ini:

--launcher.GTK_version 
2 

before the line:  

--launcher.appendVmargs 

 

Installation

 

To install Kiuwan for Developers just follow the steps below:

  1. Open Eclipse and, in the main menu, click on Help >> Install New Software...
  2. Select the Add... option and type the following values:
    1. Name: Kiuwan
    2. Location: https://www.kiuwan.com/pub/updatesite
  3. Pressing Ok will save this new update site and Eclipse will query our server to retrieve available features and plugins
  4. The Kiuwan for Developers feature will appear in the list below, check it and click on Next >
  5. Read and accept our Terms of Use
  6. Accept the certificate used to sign our product
  7. When the installation finishes and Eclipse asks to restart the IDE, please do so

 

 

 

If installation successfully completes, Kiuwan for Developers will be up and running upon restart!

The Welcome view will be shown with a new addition on top, Kiuwan for developers, which links with the Quick Start Guide integrated in the IDE. If you closed this view accidentally, you might open it again through Help >> Welcome.

The Quick Start Guide will help you:

  1. Configure your Kiuwan account and check that there are no problems with your connection and permissions.
  2. Add the Kiuwan Nature to the projects you want to analyze.
  3. Learn how and when Kiuwan for Developers analyze your sources.
  4. Learn about the views that display your analyses results.

 

K4D execution modes

 

Execution modes

 

K4D can be configure to run in different execution modes.

By configuring K4D, you can decide when Kiuwan will be executed and what files will be analyzed.

Configurations options are available under Window -> Preferences -> Kiuwan - Analysis Options



 

If your Eclipse project is not configured to "Build Automatically", Kiuwan will only run on-demand.

 

 

That is, left-click on the selected item (file, folder, project) and select "Run Kiuwan Analysis".

Kiuwan will then execute the analysis on the selected item(s).

 

 

 

If your Eclipse project is configured to "Build Automatically", next options will apply


Automatic quality analysis

If your Eclipse project is configured to "Build Automatically and "Automatic quality analysis" is checked,  Kiuwan will analyze a file after you save the file. Only the selected file will be analyzed.

 

Do full builds

If your Eclipse project is configured to "Build Automatically and "Do full builds" is checked, Kiuwan will analyze the complete project when you Clean the project.

Please note that this option is only availble if "Automatic quality analysis" is checked.

 

Updates

Kiuwan for Developers checks automatically for updates on Eclipse startup and on a daily basis after that. If you need to check it manually, you can do so through the standard Eclipse mechanisms, or by simply going to Window >> Preferences >> Kiuwan and pressing the Check for updates button.

Support

If you experience problems with the Kiuwan plugin for Eclipse, you can read our documentation to try to fix it yourself, or if you prefer you can collect troubleshooting information and send it to us.

Context-sensitive help

A focused set of help topics that is related to the current context can be shown to users on demand using context-sensitive help. This form of user assistance is delivered to users when a platform-specific trigger is activated (e.g. F1 key on Windows, Ctrl+F1 on GTK, Help key on Carbon). Some contexts where help is available are preferences dialogs, project properties dialogs or views.

Troubleshooting

Important information for troubleshooting is scatered across several log and configuration files. To make this process easier to you, just go to Window >> Preferences >> Kiuwan >> Support and press the Extract support data button. Choose the folder where you want to save this information, and submit to our technical support team the compressed file generated there. 

See Troubleshooting#ContactKiuwanTechnicalSupport on how to contact us. We will address your problem as soon as possible.

 

 

 

  • No labels