Using Reports

You can generate reports and export data to csv with Squore so you can communicate your progress to others.

In order to create a report, for the currently selected artefact in the tree, click the Documents tab in the Explorer. The Documents page opens as shown in the picture below:

Figure 1. The Documents tab

The Documents tab offers a choice of report and export types in various output formats. This choice between document types is made on the left part of the tab, by clicking on one of the two following icons:

Figure 2. Document types list

Reports are primarily used to present information visually including charts and data about action items, findings and relaxed artefacts. The output formats currently supported are .pdf, .pptx, .docx.

Depending on your license options, reports can be created in full or synthetic view. The synthetic view omits details about the exact location of violations in the code in the report, but provide a link to read the full details in the Squore web interface. The screenshots below show the difference between a synthetic report and a full report.

Figure 3. Details about action items in a synthetic report

Figure 4. Details about action items in a full report

Exports can be used to extract information in various formats in order to import it into another tool. Clicking the Create button generates and downloads the file in your browser. Note that the availability of the export feature depends on your license.

The following is an example of CSV export file obtained by launching the Project Portfolio export at model-level to get details:

Figure 5. The Project Portfolio export lists all ratings for projects in a specific analysis model

Other exports ask you to choose a list of highlights. In this case, the exported data contains the artefacts and metrics defined by the selected highlights.

The following is an example of a file generated by the

Highlights to Excel export with the HIS: All Metrics and Code Coverage: All Modules highlights selected for the Mars project:

Figure 6. Excel Export from Highlights of the Mars project

Reports and Exports are highly customisable, consult your Squore administrator or refer to the Squore Configuration Guide to learn more about how to tweak the report contents or format.