Chapter 4. Export the Report in CSV Format
Windup provides the ability to export the report data, including the Classifications and Hints, to a flat file on your local file system. The export function currently supports the CSV file format, which presents the report data as fields delimited by a comma (,) separator.
The CSV file can be imported and manipulated by spreadsheet software such as Microsoft Excel or LibreOffice Calc. Spreadsheet software provides the ability to sort, analyze, evaluate, and manage the result data from a Windup report.
4.1. Export the Report
To export the report into a CSV file, run Windup with --exportCSV argument. The CSV file will be created in the directory specified by the --output argument.
4.2. Import the CSV File into a Spreadsheet Program
- Start the spreadsheet software (LibreOffice Calc, OpenOffice Calc, Microsoft Excel, etc.).
-
Choose
FileOpen. - Navigate to the CSV exported file and select it.
- The data is now ready to analyze in the spreadsheet software.
For more information or to resolve any issues, check the help for your spreadsheet software.
4.3. Overview of the CSV Data Structure
The CSV formatted output file contains the following data fields:
- Rule Id
- The ID of the rule that generated the given item.
- Problem type
- "Hint" or "Classification"
- Title
- The title of the Classification or Hint. This field summarizes the issue for the given item.
- Description
- The detailed description of the issue for the given item.
- Links
- URLs that provide additional information about the issue. A link consists of two attributes: the link and a description of the link.
- Application
- The name of the application for which this item was generated.
- File Name
- The name of the file for the given item.
- File Path
- The file path of the file for the given item.
- Line
- The line number of the file for the given item.
- Story points
- The number of story points, which represent the level of effort, assigned to the given item.
