| Table of Contents |
|---|
...
...
...
Here comes Kiuwan Report to help you.
| Info |
|---|
With Kiuwan Report, you can create your own custom reports, specially suited to you own needs. Kiuwan let you to create as many reports as you want. |
...
...
...
...
...
...
...
...
...
the Manage reports privilege can create a custom report.
Once created, any user can |
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
report date.
2.
...
...
...
...
can decide whether a section appears or not in the TOC.)
3.
...
Reports Edition
How to create a Report
The Reports Management option can be accessed from the drop-down menu at the top-right.
Click Add to create a new report.
Click Add Widget to open a selector of available widgets.
Select any of the available widgets from the tree selector at the left.
| Info | ||
|---|---|---|
| ||
Read more about the widget library at Kiuwan Report Widget Library |
After filling its properties, click Save Widget to add the widget to the report
...
...
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,
...
...
...
...
...
...
...
...
...
...
...
Click Save.
The following 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.
Reports Generation
...
Every created report will be available to Kiuwan users under the Reports section.
Any user of the Kiuwan account will be able
...
Report Format:
You can select between PDF or PowerPoint. The latter option lets you further edit your reports.
Data Range:
The report will be built based on available data during the selected time period. To define the data range, there are two options:
...
to generate the report selecting it and clicking on the Generate option.
When the user clicks Generate, the following dialog appears:
| Name | Description |
|---|---|
| Report type | Select the format of the report: PDF or PowerPoint |
| Date Range | 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 checked, only applications matching the selected filter will be included in the report. |
Read more about the Kiuwan Widget Library at Kiuwan Report Widget Library.
Report Widgets
Kiuwan provides a complete library of widgets that you can use to build your custom report.
When you are creating the report, the widgets are available from a tree-like palette. You select any of them, configure its specifics properties and add it to the report.
Almost every widget shares some common characteristics:
Title / Add to TOC
Every widget will be presented as a page of the report.
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.
These properties will be included in final reports as the next image shows.
Summary
Summary widgets allow to represent global (aggregated) information about application metrics.
Available widgets:
- Apps Section
- Risk Section
For a fully understanding on Kiuwan Indicators, please visit https://www.kiuwan.com/blog/kiuwan-indicators/ .
Apps Section
Apps Section Widget allows to include summary data about number and distribution of applications by several criteria:
- Number of Apps and Total size (in LOCs)
- Frequency of Apps, by Size
- Frequency of Apps, by selected portfolio (Business Value, by default)
<< R_W_01.png>>
Risk Section
Risk Section Widget allows to include summary data about number and distribution of applications based on Risk Index metric:
- Average of Risk Index
- Frequency of Apps, by Risk ranges
- Average Risk, by selected portfolio (Business Value, by default)
<< R_W_02.png>>
Please, visit https://www.kiuwan.com/blog/kiuwan-indicators/ for further information on Kiuwan Indicators.
Security Section
Security Section Widget allows to include summary data about number and distribution of applications based on Security Rating metric:
- Average of Security Rating
- Frequency of Apps, by Security Rating ranges
- Average Security Rating, by selected portfolio (Business Value, by default)
Please, visit https://www.kiuwan.com/docs/display/K5/Kiuwan+Code+Security for further information on Code Security.
Please, visit https://www.kiuwan.com/blog/kiuwan-indicators/ for further information on Kiuwan Indicators.
Quality Section
Quality Section Widget allows to include summary data about number and distribution of applications based on Global Indicator metric:
- Average of Global Indicator
- Frequency of Apps, by Global Indicator ranges
- Average Global Indicator, by selected portfolio (Business Value, by default)
Please, visit https://www.kiuwan.com/blog/kiuwan-indicators/ for further information on Kiuwan Indicators.
Technical Debt Section (XXXX)
Technical Debt Widget allows to include summary data about number and distribution of applications based on Global (quality) Indicator metric:
- Average of Global Indicator
- Frequency of Apps, by Global Indicator ranges
- Average Global Indicator, by selected portfolio (Business Value, by default)
Decision quadrants
Decision Quadrant widgets allow to represent XXXXX.
Summary widgets allow to include in the report global (aggregated) information about metrics from Governance – Decision Quadrants.
Available widgets:
- Business chart
- Production chart
- Development chart
- Security chart
- Metrics
- Decision quadrants database
For a fully understanding on Decision Quadrants, please visit https://www.kiuwan.com/docs/display/K5/Decision+quadrants.
Business chart
Business chart Widget allows to include 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 risks you are facing: Global Risk (Risk index), Failure Probability (Production Risk), Maintenance (Development Risk) and Security Risk.
Business chart Widget graphically displays a quadrant where apps (or groups of apps) are placed according to Business Value (Y-Axis).
X-Axis can be customized to display the available types of Risks:
- Risk Index (default value)
- Failure Risk
- Maintenance Risk
- Security Risk
Please, visit https://www.kiuwan.com/docs/display/K5/Decision+quadrants for an explanation of different Risk indexes.
Points in the displayed graphic can be customized (by Group by selector) to represent:
- Individual applications (setting Group By to “Not grouped”)
- Groups of applications (grouped by any of the available portfolios in Group by selector)
Additionally, every point has two main characteristics:
- Diameter (proportional to size in Locs)
- Color (the portfolio value the app belongs to, this option is only available when Color by selector has been set to any to the available portfolios)
<< R_W_03.png>>
Production chart
Production chart Widget allows to include 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 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 above mentioned axis.
Please, visit https://www.kiuwan.com/docs/display/K5/Decision+quadrants for an explanation.
Points in the displayed graphic can be customized (by Group by selector) to represent:
- Individual applications (setting Group By to “Not grouped”)
- Groups of applications (grouped by any of the available portfolios in Group by selector)
Additionally, every point has two main characteristics:
- Diameter (proportional to size in Locs)
- Color (the portfolio value the app belongs to, this option is only available when Color by selector has been set to any to the available portfolios)
<< R_W_04.png>>
Development chart
Development chart Widget allows to include 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 above mentioned axis.
Please, visit https://www.kiuwan.com/docs/display/K5/Decision+quadrants for an explanation.
Points in the displayed graphic can be customized (by Group by selector) to represent:
- Individual applications (setting Group By to “Not grouped”)
- Groups of applications (grouped by any of the available portfolios in Group by selector)
Additionally, every point has two main characteristics:
- Diameter (proportional to size in Locs)
- Color (the portfolio value the app belongs to, this option is only available when Color by selector has been set to any to the available portfolios)
<< R_W_05.png>>
Security chart
Security chart Widget allows to include 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 you 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 above mentioned axis.
Please, visit https://www.kiuwan.com/docs/display/K5/Decision+quadrants for an explanation.
Points in the displayed graphic can be customized (by Group by selector) to represent:
- Individual applications (setting Group By to “Not grouped”)
- Groups of applications (grouped by any of the available portfolios in Group by selector)
Additionally, every point has two main characteristics:
- Diameter (proportional to size in Locs)
- Color (the portfolio value the app belongs to, this option is only available when Color by selector has been set to any to the available portfolios)
<< R_W_06.png>>
Metrics
Metrics Widget allows to XXXXXX
Decision Quadrants DataTable (XXXXXX)
Decision Quadrants DataTable Widget allows to include a data table of records (one application or group of applications per row) with the following summarized information:
- Business Value
- Complexity
- Risk Index
- Failure Risk
- Maintenance Risk
- Security Risk
Every record can be customized to represent:
- One individual application (setting Group by selector to “Not grouped”)
- Groups of applications (grouped by the different values of selected portfolio in Group by selector)
Additionally, the data table records can be ordered by any of the above columns by using the Order by selector.
<< R_W_07.png>>
Evolution
Evolution widgets display timely evolution of an application or a portfolio on a selected metric or indicator.
Available widgets:
- Evolution DataTable
For a fully understanding on Governance - Evolution, please visit https://www.kiuwan.com/docs/display/K5/Evolution.
Evolution DataTable
Evolution DataTable Widget allows to include timely evolution data of an application or a portfolio on a selected metric or indicator.
Evolution can be tracked on the following metrics/indicators:
- Lines of Code (LOCs)
- Risk Index
- Global Indicator
- Effort to Target
- Effort to 100
- Number of Defects
For a fully understanding on Governance - Evolution, please visit https://www.kiuwan.com/docs/display/K5/Evolution.
Values for these metrics will be “signed” numbers that represent increments (+) or decrements (-) in the metric/indicator during the selected period of time.
Every record can be customized to represent:
- One individual application (setting Group by selector to “Not grouped”)
- Groups of applications (grouped by the different values of selected portfolio in Group by selector)
Additionally, the data table records can be ordered by any of the above columns by using the Order by selector.
<< R_W_07.png>>
Ranking
Ranking widgets are those that allow to display rankings of applications (or applications grouped by portfolios) on a selected metric or indicator.
Available widgets:
- Ranking DataTable
For a fully understanding on Governance - Rankin, please visit https://www.kiuwan.com/docs/display/K5/Ranking.
Ranking DataTable
Ranking DataTable Widget allows to include a ranking of applications (or applications grouped by portfolios) on a selected metric or indicator.
Ranking can be based on the following metrics/indicators:
- Business Value
- Lines of Code (LOCs)
- Risk Index
- Global Indicator
- Effort to Target
Every record can be customized to represent:
- One individual application (setting Group by selector to “Not grouped”)
- Groups of applications (grouped by the different values of selected portfolio in Group by selector)
Additionally, the data table records can be ordered by any of the above columns by using the Order by selector.
<< R_W_08.png>>
Crossings
Crossings widgets are those that allow to display a table where you can pick the metric whose values you want to see, crossing the data of two different portfolios you want to compare.
Available widgets:
- Crossings DataTable
For a fully understanding on Governance - Rankin, please visit https://www.kiuwan.com/docs/display/K5/Crossings.
Crossings DataTable
Crossings DataTable Widget allows to define table where you can pick the metric whose values you want to see, crossing the data of two different portfolios you want to compare.
Table is designed by selecting two sets of portfolios (by Rows and Columns selectors) and a metric (Metric selector).
Available metrics are:
- Lines of Code (LOCs)
- Risk Index
- Global Indicator
- Effort to Target
- Failure Risk
- Maintenance Risk
- Security Risk
- Complexity
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 belongs to both portfolio values.
<< R_W_09.png>>
...