Kiuwan Governance provides a predefined PDF report that you generate by selecting the PDF option in the Summary section.
Although was designed to be broadly used, you would want to create your report to suit your specific needs
Here comes the Kiuwan Report to help you.
With Kiuwan Report, you can create your custom reports, especially suited to your own needs. |
Only users granted with “report generation” privilege can create a custom report. Once created, any user can generate the report. |
A Report is composed of widgets. A widget is a graphical element that displays information. To create a Report, you select the widgets from Kiuwan Widgets Library. |
Every widget has configuration options that you will set to adapt the widget to your desired functionality.
The selection and configuration of the widgets will define the content of your report, i.e. what information will be included and how will be displayed in the generated report.
Once the report is created, you will make it generally available to the rest of the users. At any time, you will be able to modify any report.
A Kiuwan Report follows the next structure
1.- Report First-Page
This 1st page contains the Title of the report, the Account Name (i.e. the descriptive name of the Kiuwan account, usually it’s the Company name) and the generation report date.
2.- Table of Contents
A Table of Contents (TOC) that shows the different sections of the Report. As you will see later, you decide whether a section appears or not in the TOC.
3.- Pages with designed Widgets
Every selected widget will be presented as a page of the report. At the time of report creation, you decide exactly what information will be included in the widget.
Reports Management option can be accessed from the drop-down menu at the top-right.
Add button lets you create a new report.
You create a report selecting widgets from the Kiuwan library. |
Clicking on "Add Widget" will open a selector of available widgets.
You can select any of the available widgets from the tree selector at the left.
After filling its properties, clicking on "Save Widget" will add the widget to the report.
As you add widgets, you can see an overview of the report’s widgets.
You can re-order the list of report widgets, as well as to edit/delete any of the widgets by accessing the widget menu.
To save your work in the report, you can click on the Save Report button. This will save it and will ask you for a report name and title.
Next image shows an example of a report first page with the title “REPORT_TITLE”
And the next image shows an example of a page heading.
Every created report will be available to Kiuwan users under the Reports section |
Any user of the Kiuwan account will be able to generate the report selecting it and clicking on the Generate option. |
When the user selects to generate a report, the next dialog is presented.
Report Type:
You can select the format of the report (PDF or PowerPoint).
Date Range:
The report will be generated based on available data during the selected period. |
To define the date range, select one of the pre-defined date ranges :
Note: "Apply actual range" will apply dates as set in the Calendar.
Apply Global Filter:
By default, the report will be generated for all the applications within the selected period.
Nevertheless, you can restrict the data report to a subset of applications.
If "Apply Global filter" is checked, only applications matching the selected filter will be included in the report.
Kiuwan provides a library of widgets that you can use to build your custom report. |
Widgets are available from a tree-like palette.
You select any of them, configure its specifics properties and Add to the report.
Most of the available widget share some common characteristics:
Title / Add to Table of Contents
Every widget will be presented as a page of the report.
The title lets you provide a string (a title) that will identify the report page.
You will then decide either this title appears or not in the Table of Contents of the report.
Description
A text you provide to explain the data displayed by the widget.
Specific properties
Depending on the widget, you can select additional properties to decide the degree of detailed information that will be printed.
Below you can find available widgets grouped by category.
Summary widgets display global (aggregated) information about application metrics. |
Available widgets:
For a full understanding of Kiuwan Indicators, please visit https://www.kiuwan.com/blog/kiuwan-indicators/.
Apps Section widget includes summary data about the number and distribution of applications by several criteria:
Risk Section widget includes summary data about the number and distribution of applications based on the Risk Index metric:
Security Section widget includes summary data about the number and distribution of applications based on Security Rating metric:
Please, visit Kiuwan Code Security for further information.
Quality Section widget allows to include summary data about number and distribution of applications based on Global Indicator metric:
Technical Debt Widget allows to include summary data about number and distribution of applications based on Global (quality) Indicator metric:
Decision Quadrants widgets represent graphically where your applications are depending on their business value, failure probability, maintenance risk, and security risk.
Available widgets:
For a full understanding of Decision Quadrants, please visit Decision quadrants.
Business Chart widget includes a Business Value Decision Quadrant in your report.
The Business Value Decision Quadrant is aimed to identify those applications in your portfolio that require immediate action based on their criticality for the business and their exposure to any of the risks you are facing:
Business chart Widget graphically displays a quadrant where apps (or groups of apps) are placed according to Business Value (Y-Axis).
The X-Axis can be customized to display the available types of Risks:
Please, visit Decision quadrants for an explanation of different Risk indexes.
Points in the displayed graphic can be customized (by Group by selector) to represent:
Additionally, every point has two main characteristics:
Production Chart widget includes a Production Decision Quadrant in your report.
The Production Quadrant is aimed to identify those applications in your portfolio that could cause problems in production, and if they will be able to recover from these errors easily.
The applications with higher exposure to this kind of risk will be those in the upper-right area of the quadrant.
Vertical (Y) axis represents Failure Probability. This indicates if applications are likely to provoke frequent errors in production. Applications with high Failure Probability could be a problem in the short term.
Horizontal (X) axis represents the application’s Complexity, a normalized (between 0 and 100) metric based on applications’ cyclomatic complexity by function, duplication of code and maintainability index.
Production chart Widget graphically displays a quadrant where apps (or groups of apps) are placed according to the above-mentioned axis.
Please, visit Decision quadrants for an explanation.
Points in the displayed graphic can be customized (by Group by selector) to represent:
Additionally, every point has two main characteristics:
Development Chart widget includes a Development Decision Quadrant in your report.
The Development quadrant is aimed to identify those applications in your portfolio exposed in the midterm given the difficulty and associated cost to maintain them.
The applications with higher exposure to this kind of risk will be those in the upper-right area of the quadrant.
In the vertical axis, we represent the Maintenance Risk: this indicates if applications’ maintenance costs are going to be higher than expected, or if it is going to be complex and costly to add new functionality to them. It is based on the evidence gathered from the code for the maintainability index.
In the horizontal axis, we represent application Complexity, a normalized (between 0 and 100) metric based on applications’ cyclomatic complexity by function, duplication of code and maintainability index.
Development chart Widget graphically displays a quadrant where apps (or groups of apps) are placed according to the above-mentioned axis.
Please, visit Decision quadrants for an explanation.
Points in the displayed graphic can be customized (by Group by selector) to represent:
Additionally, every point has two main characteristics:
Security Chart widget includes a Security Decision Quadrant in your report.
The Security quadrant is aimed to identify those applications in your portfolio that are exposed to potential internal or external attacks, that can compromise the integrity of your organization, and if these potential vulnerabilities can be easily corrected.
The applications with higher exposure to this kind of risk will be those in the upper-right area of the quadrant.
In the vertical axis, we represent the Security risk: This indicated how vulnerable an application is to internal or external attacks based on the number of vulnerabilities found in the application’s code as listed by CWE and OWASP.
In the horizontal axis, we represent application Complexity, a normalized (between 0 and 100) metric based on applications’ cyclomatic complexity by function, duplication of code and maintainability index.
Security chart Widget graphically displays a quadrant where apps (or groups of apps) are placed according to the above-mentioned axis.
Please, visit Decision quadrants for an explanation.
Points in the displayed graphic can be customized (by Group by selector) to represent:
Additionally, every point has two main characteristics:
Decision Quadrants DataTable widget includes a data table of records (one application or group of applications per row) with the following summarized information:
Every record can be customized to represent:
Additionally, the data table records can be ordered by any of the above columns by using the Order by the selector.
Evolution widgets display the timely evolution of an application or a portfolio on a selected metric or indicator.
Available widgets:
For a full understanding of Governance - Evolution, please visit Evolution.
Evolution DataTable widget includes timely evolution data of an application or a portfolio on a selected metric or indicator.
Evolution can be tracked on the following metrics/indicators:
For a full understanding of Governance - Evolution, please visit Evolution.
Values for these metrics will be “signed” numbers that represent increments (+) or decrements (-) in the metric/indicator during the selected period.
Every record can be customized to represent:
Additionally, the data table records can be ordered by any of the above columns by using the Order by the selector.
Evolution Timeline widget displays timely evolution data of an application or a portfolio on a selected metric or indicator.
At the current moment, only the Risk Index metric is available.
Points in the displayed graphic can be customized (by Group by selector) to represent:
Evolution Top 10 chart widget displays differential data for the top 10 applications on a selected metric or indicator.
At the current moment, only the Risk Index metric is available.
Points in the displayed graphic can be customized (by Group by selector) to represent:
Activity widgets display applications activity on a selected metric or indicator during a certain period.
Changes in activity can be viewed for a specific application or for those applications that belong to a selected portfolio.
Available widgets:
For a full understanding of Governance - Activity, please visit Activity.
Applications Activity DataTable Widget includes changes data of an application or a portfolio on a selected metric or indicator.
The activity can be tracked on the following metrics/indicators:
For a full understanding of Governance - Activity, please visit Activity.
Values for these metrics will be “signed” numbers that represent increments (+) or decrements (-) in the metric/indicator since the beginning of the selected period.
Every record can be customized to represent:
Additionally, the data table records can be ordered by any of the above columns by using the Order by the selector.
Deliveries Activity DataTable Widget includes activity data of application's deliveries.
For every application, deliveries activity can be tracked on the following metrics/indicators:
For a full understanding of Governance - Activity, please visit Activity.
Every record can be customized to represent:
Additionally, the data table records can be ordered by any of the above columns by using the Order by the selector.
Ranking widgets display rankings of applications (or applications grouped by portfolios) on a selected metric or indicator.
Available widgets:
For a full understanding of Governance - Ranking, please visit Ranking.
Ranking DataTable widget includes a ranking of applications (or applications grouped by portfolios) on a selected metric or indicator.
Ranking can be based on the following metrics/indicators:
Every record can be customized to represent:
Additionally, the data table records can be ordered by any of the above columns by using the Order by the selector.
Crossings widgets display a table where you can pick the metrics whose values you want to see, crossing the data of two different portfolios you want to compare.
Available widgets:
For a full understanding of Governance - Crossings, please visit Crossings.
Crossings DataTable widget allows defining tables where you can pick the metric whose values you want to see, crossing the data of two different portfolios you want to compare.
The table is designed by selecting two sets of portfolios (by Rows and Columns selectors) and a metric (Metric selector).
Available metrics are:
As a result, you will get a table where column/rows labels represent the different values of the selected portfolios and the inner cells will represent the aggregated data (added or averaged) of the selected metric for all the applications that belong to both portfolio values.
you publish it (to make it generally available to the rest of the users)