To access the Audit Management module, select Audits Management from the configuration drop-down menu.
Only users with Manage audits privilege will be allowed to access the Audit module.
You will go directly to the audit summary page for the default selected Audit.
Kiuwan comes with an off-the-shelf Default audit. This audit cannot be modified by end-users but can be used in any application. This is the Audit assigned to any new application in Kiuwan by default.
The default audit comes under the Shared Audits section in the left panel. Any user-defined audit will be under My Audits. Clicking on any audit name will allow you to view/manage it.
Create an Audit
- To create a new Audit, click New at the end of the Audits list in the left side panel.
- Provide a Name and (optionally) a Description.
- The Approval Threshold represents the minimum percentage of checkpoint contributions to consider the Audit as OK. After audit execution, this value is used to evaluate if the audit passes or not. Please see the Audit evaluation logic above to know how this value is used in audit evaluation.
- Click Create Audit to save the new audit and have it available under My audits.
- Every Audit needs to have at least 1 Checkpoint. Therefore, once you create an audit, the next step is to create checkpoints.
Checkpoint management
For any selected Audit, the Checkpoints tab will show all the defined checkpoints in a table. To facilitate working with checkpoints, filter them by Name, Type, or Mandatory status in the filter panel above the table.
Click the checkpoint Name to modify the checkpoint details and definition.
Further actions on this page:
| Action | Description |
| Weight text box | Enter integers in the text box and Kiuwan will automatically calculate the contribution percentage of every checkpoint in the audit. This way, you can easily fine-tune checkpoint contributions without editing every individual checkpoint. |
| Mandatory | Select the checkbox to make the checkpoint(s) mandatory. |
| Add Report Section |
Click this button to create sections to group checkpoints into sections. You can define the order of sections and checkpoints using the arrows in the first column of the checkpoints table. To move checkpoints across sections just use the arrows in the checkpoint until you place it in the section you want. The order defined here is used just to display results, it doesn't affect the Audit evaluation logic explained above. |
Create a Checkpoint
To create a new checkpoint, click Add checkpoint.
| Name | Description |
| Name | Enter a name for the checkpoint (mandatory) |
| Description | Enter a description of the checkpoint (optional) |
| Weight |
The relative weight of this checkpoint in the Audit. Every checkpoint has an associated Weight that represents the relative weight of the checkpoint in the Audit. The weights you specify (integer values) will translate (automatically) into a percentage contribution to the overall Audit. Please see Audit evaluation logic to fully understand how this value is used in the audit result calculation. |
| Mandatory | The checkbox indicates if the checkpoint is Mandatory (checked) or Optional (unchecked). |
| Maximum Threshold | It indicates the maximum number of defects that are allowed. When the audit is executed, if the number of defects is higher than this value, the checkpoint will FAIL. |
| Type | The drop-down menu allows selecting between the available checkpoint types. Please see Checkpoint Types for an explanation. Available checkpoint types:
Depending on the selected checkpoint type, you may be able to specify a filter:
The following checkpoint evaluation will only compare with the threshold those defects of Very High priority belonging to Maintainability or Security in Java or Cobol source files: |
| Threshold Mode | Determines whether the threshold should be an absolute, fixed limit, or if it should be a value relative to the number of files analyzed (as a percentage). |
| Search defect types | Click this link if you prefer that only defects of a certain type should be considered. Select then the desired rules by searching the Kiuwan rules repository. After selecting the rules, the checkpoint will check only defects of those types. |
Associate an Audit with an Application
Once you have created the audit and its checkpoints, open the Applications management module, select the Application, and open the dropdown menu to associate that audit with an application.
Select the Audit option to open a form where you can select available audits.
Selecting an audit will associate that audit with the application, i.e., every delivery analysis on that application will run the audit.
Hint: Do not forget to Publish the audit to make it available for use.
Setting a custom Audit as the default audit for new applications
The Kiuwan default audit is the default audit assigned to a new application. You can change the audit assigned to an application at any time as seen above.
To set a specific audit, a shared one, or one of your custom audits, as the default audit for new applications, do as follows.
Go to Audits Management and select the audit you want to be the default audit in the audits selector.
Once selected, open the hamburger menu next to the version number and click Set as default audit.
Afterward, the selected audit will be the default audit assigned to new applications.
How can I know which is the default audit?
The Audit menu on the left of Audit Management indicates with an asterisk the default audit.
Audit Results
Every time a delivery analysis is executed, the audit associated with that application will be evaluated, associating a value of OK or FAIL with that delivery analysis. You can access the audit results in several ways:
- Interactively, by browsing the Audit Results page
- Programmatically, by inspecting KLA return codes
Audit Results Page
The deliveries module displays a full list of deliveries.
The Status column shows the results of the audit as well as the overall compliance of the analysis with the defined audit (Score column).
Click the hand icon under the Status column to open the Audit Results page.
The below picture shows an example of an audit that resulted in OK.
The information is displayed about the Overall status, the reasons (Why?), the overall compliance (Audit score), information on Checkpoint results, the Effort needed to pass the audit (if it failed), and specific information about the results of every checkpoint.
A full list of audit checkpoints is displayed, along with information on each of them.
For those failed checkpoints, click the arrow on the left to list the defects that caused the checkpoint failure.
Click the PDF link to export the Audit results in PDF format.
Audit Result when using Local Analyzer
If you are using Kiuwan Local Analyzer in GUI mode, after analyzing the delivery, click View Results to go directly to the Audit Results page.
In CLI mode, stdout will display the URL of the Audit Results Page
Also, you can check programmatically the audit status (OK or FAIL) by inspecting the return code of KLA script (agent.cmd or agent.sh). Visit Local Analyzer Return Codes for detailed information on return codes.
Audit Result when using Kiuwan plugin for Jenkins
If you are using the Kiuwan Plugin for Jenkins, you can set the build status depending on the audit result, for example, by marking the build UNSTABLE in case the audit fails.
Further reading: Please visit Jenkins plugin - Delivery Mode for details on how to configure the Kiuwan plugin for Jenkins to set the build status depending on the audit result.