Feature: Report Page

[sawankshrma]

Description

A new "Report" page is created.
It "dumps" all activities at one page in order to provide it to an auditor, Preferably in a pdf format.

For now, a slightly modified version of the already existing ActivityDescriptionComponent is used in this page to display all/some activities on the page. => This is of-course not exportable/printable for now and will be fixed in later iterations.

The activities (types, individual) and their attributes are configurable as to what we'd like to show in the report and eventually provide to the auditor. The configurations are stored in the localStorage in the browser like all other informations.

Resolves Issue: #494

What's Changed?

• A new ReportComponent is created which dumps all the activities rendered in a modified ActivityDescriptionComponent called ReportConfigModalComponent --> this component is going to be replaced by something better which can be exportable.
• It contains a button to Adjust the Report's Configuration which opens a modal whose component is also a newly generated component called ReportConfigModalComponent. All the configurations of the report can be altered through this modal. The new configurations are then modified and saved in the localStorage and the Report page is then re-rendered with those modified configurations.
• A new model file called report-config.ts is created which exports some functions and interfaces useful to the "Report" page.
• The app-routing.module.ts and sidenav-buttons.component.ts files are modified to contain the new "Report" page.

[wurstbrot]

Than you @sawankshrma , comments in the review.

[sawankshrma]

Than you @sawankshrma , comments in the review.

HI @wurstbrot . Thank You for the review.

See, this component (ReportActivityComponent) was not built by me from Scratch. I just copy-pasted the already existing ActivityDescriptionComponent's code. I just changed some lines and/or commented some lines which were causing trouble in the "Report" Page. That's why it has some commented code and some extra lines which are not required here.

In further iterations I am going to replace this component completely to provide for an Exportable/Printable "Report" page. I hope you understand :)

[sawankshrma]

What's Changed in the above commit?

• The Page doesn't use any other component for displaying --> The ReportActivityComponent is completely removed now.
• An Overview section has been added, providing a summary of the completion status for each level. (The contents of this section may be changed after further discussion.)

New Tabular Layout

• The page is Sorted by Dimension > Sub-Dimension > Levels inside the Table

1. Tabular Layout ensures the contents are print-friendly/auditor friendly.
2. This Layout has columns namely :
   • Level
   • Activity Name
   • Description- (Configurable both as to - include this column or not. And also introduced is a new feature where Number of Words of the Description and be Capped from the Configuration Modal.) New functions are added to the component class for converting the Markdown Description into html which can be rendered inside a table cell (In this process, the width of the images of the Markdown is also altered to fit inside the table cell).
   • Other Columns can be either Teams or The Activity Status which can also be toggled in the Configuration Modal.

---

• Selecting Teams is added to the Configuration Modal (Either individual teams or groups can be selected -- as to include them in the Report or not.
• Max Level is directly interpreted from the SettingsService.
• The position of the Page's Link is moved as mentioned in the issue's comment.

• A print button has been added that triggers the simple window.print() command. It also displays an alert with recommended settings for optimal export. Additionally, the Report Page CSS has been updated to include print-specific styles. See exported-example.pdf

---

• <-- This type of point in this comment represents responses to the changes/ideas proposed in Report page for exporting all activities in auditor-friendly format #494 (comment)

• Awaiting review - happy to make further adjustments as needed.

[vbakke]

I think this looks awesome, @sawankshrma :)

I found a couple of issues:

• The progress help text is not reading the dynamic progress titles, when grouping columns by Team.
  

  • And a nut to crack: What symbols will you use if they add more than default stages : )
  • The stages could also be a time based progress. It could also be: Low maturity, Medium maturity, High maturity (or any type of categories that the user seem fit)

• Report config: Select group

  • Not sure if it is by design or if it is a bug: After selecting a group, the dropdown reverts back to 'Select a group'

• Would it be worth while having the teams and group selection outside of the report config?

  • I feel like the user will be more likely to flip team selection, than any of the other config parameters.

• Printer warning

  • I like the printer warning. :)
  • But we know if the menu panel is closed, or darkmode disabled. Maybe nicer if we only show the warning if one of these options are "incorrect"? Yes, we don't get to show the part about margin, if they by accident have it all "correct" on their first try.

@wurstbrot: What is your take on this?

[sawankshrma]

The progress help text is not reading the dynamic progress titles, when grouping columns by Team.

Totally missed the part that progress was configurable 😅. And yes symbols won't work now. We should show just the progress definitions name in the table cell itself.

• Report config: Select group

  • Not sure if it is by design or if it is a bug: After selecting a group, the dropdown reverts back to 'Select a group'

• Would it be worth while having the teams and group selection outside of the report config?

  • I feel like the user will be more likely to flip team selection, than any of the other config parameters.

Got It! Will move the teams' selection outside of the config modal. And will make sure the group name is visible in the dropdown label.

• But we know if the menu panel is closed, or darkmode disabled. Maybe nicer if we only show the warning if one of these options are "incorrect"? Yes, we don't get to show the part about margin, if they by accident have it all "correct" on their first try.

We could adjust the warning text based on the current app configuration (dark mode and menu state). However, the margin warning would still appear every time the user attempts to print.

• To improve this, the margin warning could be suppressed after a fixed number of print attempts (e.g., 5). This would require maintaining something like a warning counter within the ReportConfig key in localStorage though.

Anways, will be waiting for @wurstbrot 's opinion on it and proceed accordingly.

[vbakke]

:) Excellent!

Regarding the warning about margin. I feel that having a counter is more hassle then the value. Complicates code. And if people print with huge margin, they'll notice on first (failed) attempt.

I think it is nice to include the margin warning if we are displaying a warning. But people know how to print. Let's keep it simple. :)

[wurstbrot]

Hi @sawankshrma ,

thank you, it looks good so far. The report is there to be handed over to the auditor. Therefore, to list and configure the different mappings (specially OWASP SAMM and ISO 27001) is important. I do not see that to be configured as filter or in the overview.
In addition, all information related what the activity is about is needed, e.g. description (is there), implementation (not there), evidence of implementation (other issue) ...